You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(examples): build the poll recipe on the composer preview set - #3374
Build the UI Cookbook's "Poll with text and attachments" recipe on the API from #3365, so it matches its docs page (GetStream/getstream.io, branch v15-review-3).
🛠 Implementation details
Dialog:AddPollDialog is gone. AttachPollControls replaces only the dialog's footer through the PollCreationDialogControls key, so the default form (question, options, settings) stays. Add to message closes the dialog, focuses the composer and calls messageComposer.createPoll() without sending.
Preview: the poll card is a poll item in the MessageComposerPreviews set, right after quotedMessage, visible while pollId is set and no message is being edited. The wrapper around MessageComposerUI and its CSS are gone, and so is the card's outer margin.
Sending:installPollWithText removes the poll-only middleware by POLL_ONLY_COMPOSITION_MIDDLEWARE_ID and puts back one made with createPollOnlyCompositionMiddleware() on cleanup. It no longer sets retainCompositionOnSubmit: the default empties the composer once the poll-only middleware is gone.
Removing: still detach-only; comments shortened.
shots.json clips the composer screenshot to .str-chat__message-composer.
🎨 UI Changes
The poll card now sits in the composer's own preview area, above the attachments. Screenshots are retaken on the docs branch. The dialog footer couldn't be opened in the cookbook, since polls are off in the demo app; it's covered by the type check.
Checks: eslint, prettier, cookbook build and check:css pass.
Summary by CodeRabbit
New Features
The poll composer example provides controls to add a poll to a message and returns focus to the composer after the action.
Poll previews appear alongside other composer previews and can be removed from the composer. They are not shown while editing a message.
Bug Fixes
The poll-creation dialog closes after poll creation finishes, whether creation succeeds or fails.
Dialog controls are disabled while poll creation is in progress, preventing repeated actions.
The poll card is now a `poll` item in the MessageComposerPreviews set
instead of a wrapper around MessageComposerUI, and the Create poll dialog
keeps its form: only its footer is replaced, through the
PollCreationDialogControls slot. installPollWithText removes the poll-only
middleware by its exported id and leaves retainCompositionOnSubmit at its
default, which empties the composer once that middleware is gone.
No actionable comments were generated in the recent review.
Walkthrough
The cookbook poll composer now uses dedicated controls to create polls and registers poll previews in the composer preview set. It also uses the SDK poll-only middleware factory and updates related styling, migration documentation, and screenshot clipping.
Removes AddPollDialog and its stylesheet. Adds footer controls that disable actions during poll creation, then close the dialog and focus the composer after the attempt. The composer overrides use the new controls slot. The migration example also disables both dialog buttons while creation is pending and closes the dialog in finally.
Registers the poll preview after quoted messages. It appears when a poll ID exists and the message is not being edited. Related styling, comment text, and screenshot clipping are updated.
Dismissal during poll creation can attach the poll to a later message unless the user removes it from the preview.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title clearly identifies the main change: building the poll recipe with the composer preview set.
Description check
The description includes the required Goal, Implementation details, and UI Changes sections. It explains the component, preview, middleware, removal, screenshot, and validation changes. It notes that …
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Description check
Explanation
The description includes the required Goal, Implementation details, and UI Changes sections. It explains the component, preview, middleware, removal, screenshot, and validation changes. It notes that screenshots were retaken, although no images are embedded.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 5 files. (1 skipped: 1 unsupported.)
Finishing Touches
Generate docstrings
Commit to this branch
Create a new PR
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Tip
🎯 Customize your risk assessments
Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.
✅ Automatic approvals, with your rules
Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.
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.
Files skipped from review as they are similar to previous changes: 1
ai-docs/ai-migration-v14-v15.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.
✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.94%. Comparing base (1c02ba0) to head (cd6c2c6). ⚠️ Report is 1 commits behind head on master.
A message sent from the composer while the poll was still being created
went out without it. The dialog now closes after createPoll() settles,
and Add to message is disabled meanwhile. The migration guide's example
gets the same order.
…reated
Cancel is disabled while the poll is being created, since the poll would
still be attached after it. The migration guide's example gets the same
guard on both buttons.
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
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.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Ticket: https://linear.app/stream/issue/REACT-1441
🎯 Goal
Build the UI Cookbook's "Poll with text and attachments" recipe on the API from #3365, so it matches its docs page (GetStream/getstream.io, branch
v15-review-3).🛠 Implementation details
AddPollDialogis gone.AttachPollControlsreplaces only the dialog's footer through thePollCreationDialogControlskey, so the default form (question, options, settings) stays. Add to message closes the dialog, focuses the composer and callsmessageComposer.createPoll()without sending.pollitem in theMessageComposerPreviewsset, right afterquotedMessage, visible whilepollIdis set and no message is being edited. The wrapper aroundMessageComposerUIand its CSS are gone, and so is the card's outer margin.installPollWithTextremoves the poll-only middleware byPOLL_ONLY_COMPOSITION_MIDDLEWARE_IDand puts back one made withcreatePollOnlyCompositionMiddleware()on cleanup. It no longer setsretainCompositionOnSubmit: the default empties the composer once the poll-only middleware is gone.shots.jsonclips the composer screenshot to.str-chat__message-composer.🎨 UI Changes
The poll card now sits in the composer's own preview area, above the attachments. Screenshots are retaken on the docs branch. The dialog footer couldn't be opened in the cookbook, since polls are off in the demo app; it's covered by the type check.
Checks: eslint, prettier, cookbook
buildandcheck:csspass.Summary by CodeRabbit