Skip to content

chore(docs/chat-composer): Update the documentation for the new Chat Composer elements #3981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 31 commits into from
Jul 11, 2024

Conversation

krisantrobus
Copy link
Collaborator

Extended docs to include the new component elements along with examples.

@krisantrobus krisantrobus requested a review from a team as a code owner July 10, 2024 23:32
@krisantrobus krisantrobus requested a review from serifluous July 10, 2024 23:32
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jul 10, 2024
Copy link

changeset-bot bot commented Jul 10, 2024

🦋 Changeset detected

Latest commit: 8b24cdc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@twilio-paste/chat-composer Patch
@twilio-paste/core Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Jul 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
paste-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2024 6:36pm
paste-remix ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2024 6:36pm

@github-actions github-actions bot added the Status: Do Not Merge This PR is not yet ready to be merged back into the main branch label Jul 10, 2024
@github-actions github-actions bot added Type: Documentation Improvements or additions to documentation Area: Doc Site Related to the documentation website Area: Components Related to the component library (core) of this system labels Jul 10, 2024
@krisantrobus krisantrobus marked this pull request as draft July 10, 2024 23:33
Copy link

nx-cloud bot commented Jul 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8b24cdc. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Comment on lines -97 to -113
export const SendButtonPlugin = ({ onClick }: { onClick: () => void }): JSX.Element => {
const [editor] = useLexicalComposerContext();

const handleSend = (): void => {
onClick();
editor.dispatchCommand(CLEAR_EDITOR_COMMAND, undefined);
};

return (
<Box position="absolute" top="space30" right="space30">
<Button variant="primary_icon" size="reset" onClick={handleSend}>
<SendIcon decorative={false} title="Send message" />
</Button>
</Box>
);
};

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was used as an example of putting the button inside the text area which we want to avoid.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 11, 2024
@krisantrobus krisantrobus added the 🕵🏻‍♀️ Run website visual regression When applied, we will run a full suite of visual regression tests across the doc site label Jul 11, 2024
Copy link

cypress bot commented Jul 11, 2024

Passing run #8229 ↗︎

0 125 0 0 Flakiness 0

Details:

Merge 8b24cdc into 7779a24...
Project: Paste Commit: 86856b0dfd ℹ️
Status: Passed Duration: 06:46 💡
Started: Jul 11, 2024 6:47 PM Ended: Jul 11, 2024 6:54 PM

Review all test suite changes for PR #3981 ↗︎

"@twilio-paste/core": patch
---

[ChatComposer] updated JS Doc used for tpye gen in docs website
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion(non-blocking): no change required here, just a little tip for future changelogs, I like to be super specific to let our consumers know why we change certain files, like specifying that it was just a typo fix to a prop description

Copy link
Collaborator

@nkrantz nkrantz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super clean docs and Chat Composer ended up in a really great spot 🔥

@krisantrobus krisantrobus added 🚀 merge it! and removed Status: Do Not Merge This PR is not yet ready to be merged back into the main branch labels Jul 11, 2024
@kodiakhq kodiakhq bot merged commit 9e54abc into main Jul 11, 2024
48 of 49 checks passed
@kodiakhq kodiakhq bot deleted the docs/chat-composer branch July 11, 2024 19:15
@TwilioPasteBot TwilioPasteBot mentioned this pull request Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Components Related to the component library (core) of this system Area: Doc Site Related to the documentation website lgtm This PR has been approved by a maintainer 🚀 merge it! 🕵🏻‍♀️ Run website visual regression When applied, we will run a full suite of visual regression tests across the doc site size:XL This PR changes 500-999 lines, ignoring generated files. Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants