Feature/pub 1765 annotations examples #2636
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Uses a double-pane view to show the example side by side for two different clients.
Shown in an expandable pane when the message is clicked.
Publish an annotation, specifying the annotation type. Summaries are received as a message in the subscribe listener.
Listens for annotation summaries received in realtime and renders their information for each summary type in a set of expandable summary components in the message details.
Separates the annotations summary from the raw annotations messages displayed in separate tabs.
Adds a delete button to raw annotations to publish a delete annotation which removes the annotation from the summary. Refactors the raw annotation view to display in a more compact format.
Various improvements to the components and styling to create a more compact visual style.
Adds the franken-ui dependency to the examples renderer. Updates the set of visible files configured for sandpack.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds an example app for the new message annotations feature. Showcases:
I recorded a quick Loom to walk through this example: https://www.loom.com/share/e8e37e37d7c04999b82493142b445336?sid=25392ef5-5d8e-4225-8bea-1e2f08fb31f4
I intend to update the docs before landing this PR, but opening now for draft review.
This examples requires us to configure a namespace (channel rule) with the
mutableMessagesflag enabled. We need to identify how we can do this when used from the examples.This also needs an image to include on the examples index.
Checklist