feat: add Poll support (#2530)

GetStream · Nov 1, 2024 · b4ea052 · b4ea052
1 parent 1a75c2a
commit b4ea052
Show file tree

Hide file tree

Showing 122 changed files with 6,510 additions and 494 deletions.
diff --git a/docusaurus/docs/React/assets/add-poll-comment-form.png b/docusaurus/docs/React/assets/add-poll-comment-form.png
diff --git a/docusaurus/docs/React/assets/dashboard-channel-type-feature-configuration-ui.png b/docusaurus/docs/React/assets/dashboard-channel-type-feature-configuration-ui.png
diff --git a/docusaurus/docs/React/assets/dashboard-roles-permissions-ui.png b/docusaurus/docs/React/assets/dashboard-roles-permissions-ui.png
diff --git a/docusaurus/docs/React/assets/end-poll-dialog.png b/docusaurus/docs/React/assets/end-poll-dialog.png
diff --git a/docusaurus/docs/React/assets/message-with-poll.png b/docusaurus/docs/React/assets/message-with-poll.png
diff --git a/docusaurus/docs/React/assets/poll-comment-list.png b/docusaurus/docs/React/assets/poll-comment-list.png
diff --git a/docusaurus/docs/React/assets/poll-creation-dialog.png b/docusaurus/docs/React/assets/poll-creation-dialog.png
diff --git a/docusaurus/docs/React/assets/poll-option-full-list.png b/docusaurus/docs/React/assets/poll-option-full-list.png
diff --git a/docusaurus/docs/React/assets/poll-results.png b/docusaurus/docs/React/assets/poll-results.png
diff --git a/docusaurus/docs/React/assets/suggest-poll-option-form.png b/docusaurus/docs/React/assets/suggest-poll-option-form.png
diff --git a/docusaurus/docs/React/components/contexts/component-context.mdx b/docusaurus/docs/React/components/contexts/component-context.mdx
@@ -65,6 +65,30 @@ Custom UI component to display a attachment previews in `MessageInput`.
 | --------- | ---------------------------------------------------------------------------------------------- |
 | component | <GHComponentLink text='AttachmentPreviewList' path='/MessageInput/AttachmentPreviewList.tsx'/> |
 
+### AttachmentSelector
+
+Custom UI component to control adding attachments to MessageInput, defaults to and accepts same props as:
+
+| Type      | Default                                                                                  |
+| --------- | ---------------------------------------------------------------------------------------- |
+| component | <GHComponentLink text='AttachmentSelector' path='/MessageInput/AttachmentSelector.tsx'/> |
+
+### AttachmentSelectorInitiationButtonContents
+
+Custom UI component for contents of attachment selector initiation button.
+
+| Type      |
+| --------- |
+| component |
+
+### AudioRecorder
+
+Custom UI component to display AudioRecorder in `MessageInput`.
+
+| Type      | Default                                                                        |
+| --------- | ------------------------------------------------------------------------------ |
+| component | <GHComponentLink text='AudioRecorder' path='/MessageInput/AudioRecorder.tsx'/> |
+
 ### AutocompleteSuggestionItem
 
 Custom UI component to override the default suggestion Item component.
@@ -155,9 +179,9 @@ Custom UI component to be displayed when the `MessageList` is empty.
 | --------- | ------------------------------------------------------------------------------------------------- |
 | component | <GHComponentLink text='EmptyStateIndicator' path='/EmptyStateIndicator/EmptyStateIndicator.tsx'/> |
 
-### FileUploadIcon
+### FileUploadIcon (deprecated)
 
-Custom UI component for file upload icon.
+Custom UI component for file upload icon. The component is now deprecated. Use [`AttachmentSelectorInitiationButtonContents`](#attachmentselectorinitiationbuttoncontents) instead.
 
 | Type      | Default                                                                 |
 | --------- | ----------------------------------------------------------------------- |
@@ -309,6 +333,46 @@ Custom UI component to override default pinned message indicator.
 | --------- | ---------------------------------------------------------------- |
 | component | <GHComponentLink text='PinIndicator' path='/Message/icons.tsx'/> |
 
+### PollActions
+
+Custom UI component to override default poll actions rendering in a message.
+
+| Type      | Default                                                                        |
+| --------- | ------------------------------------------------------------------------------ |
+| component | <GHComponentLink text='PollActions' path='/Poll/PollActions/PollActions.tsx'/> |
+
+### PollContent
+
+Custom UI component to override default poll rendering in a message.
+
+| Type      | Default                                                            |
+| --------- | ------------------------------------------------------------------ |
+| component | <GHComponentLink text='PollContent' path='/Poll/PollContent.tsx'/> |
+
+### PollCreationDialog
+
+Custom UI component to override default poll creation dialog contents.
+
+| Type      | Default                                                                                             |
+| --------- | --------------------------------------------------------------------------------------------------- |
+| component | <GHComponentLink text='PollCreationDialog' path='/Poll/PollCreationDialog/PollCreationDialog.tsx'/> |
+
+### PollHeader
+
+Custom UI component to override default poll header in a message.
+
+| Type      | Default                                                          |
+| --------- | ---------------------------------------------------------------- |
+| component | <GHComponentLink text='PollHeader' path='/Poll/PollHeader.tsx'/> |
+
+### PollOptionSelector
+
+Custom UI component to override default poll option selector.
+
+| Type      | Default                                                                          |
+| --------- | -------------------------------------------------------------------------------- |
+| component | <GHComponentLink text='PollOptionSelector' path='/Poll/PollOptionSelector.tsx'/> |
+
 ### QuotedMessage
 
 Custom UI component to override quoted message UI on a sent message.
@@ -325,6 +389,14 @@ Custom UI component to override the message input's quoted message preview.
 | --------- | -------------------------------------------------------------------------------------------- |
 | component | <GHComponentLink text='QuotedMessagePreview' path='/MessageInput/QuotedMessagePreview.tsx'/> |
 
+### QuotedPoll
+
+Custom UI component to override the rendering of quoted poll.
+
+| Type      | Default                                                          |
+| --------- | ---------------------------------------------------------------- |
+| component | <GHComponentLink text='QuotedPoll' path='/Poll/QuotedPoll.tsx'/> |
+
 ### ReactionSelector
 
 Custom UI component to display the reaction selector.

diff --git a/docusaurus/docs/React/components/contexts/message-input-context.mdx b/docusaurus/docs/React/components/contexts/message-input-context.mdx
@@ -229,6 +229,14 @@ Function to insert text into the value of the underlying `textarea` component.
 | ------------------------------ |
 | (textToInsert: string) => void |
 
+### isThreadInput
+
+Signals that the MessageInput is rendered in a message thread (Thread component).
+
+| Type    |
+| ------- |
+| boolean |
+
 ### isUploadEnabled
 
 If true, file uploads are enabled in the currently active channel.

diff --git a/docusaurus/docs/React/components/core-components/channel.mdx b/docusaurus/docs/React/components/core-components/channel.mdx
@@ -142,6 +142,30 @@ Custom UI component to display an attachment previews in `MessageInput`.
 | --------- | ---------------------------------------------------------------------------------------------- |
 | component | <GHComponentLink text='AttachmentPreviewList' path='/MessageInput/AttachmentPreviewList.tsx'/> |
 
+### AttachmentSelector
+
+Custom UI component to control adding attachments to MessageInput, defaults to and accepts same props as:
+
+| Type      | Default                                                                                  |
+| --------- | ---------------------------------------------------------------------------------------- |
+| component | <GHComponentLink text='AttachmentSelector' path='/MessageInput/AttachmentSelector.tsx'/> |
+
+### AttachmentSelectorInitiationButtonContents
+
+Custom UI component for contents of attachment selector initiation button.
+
+| Type      |
+| --------- |
+| component |
+
+### AudioRecorder
+
+Custom UI component to display AudioRecorder in `MessageInput`.
+
+| Type      | Default                                                                        |
+| --------- | ------------------------------------------------------------------------------ |
+| component | <GHComponentLink text='AudioRecorder' path='/MessageInput/AudioRecorder.tsx'/> |
+
 ### AutocompleteSuggestionItem
 
 Custom UI component to override the default suggestion Item component.
@@ -609,6 +633,46 @@ Custom UI component to override default pinned message indicator.
 | --------- | ---------------------------------------------------------------- |
 | component | <GHComponentLink text='PinIndicator' path='/Message/icons.tsx'/> |
 
+### PollActions
+
+Custom UI component to override default poll actions rendering in a message.
+
+| Type      | Default                                                                        |
+| --------- | ------------------------------------------------------------------------------ |
+| component | <GHComponentLink text='PollActions' path='/Poll/PollActions/PollActions.tsx'/> |
+
+### PollContent
+
+Custom UI component to override default poll rendering in a message.
+
+| Type      | Default                                                            |
+| --------- | ------------------------------------------------------------------ |
+| component | <GHComponentLink text='PollContent' path='/Poll/PollContent.tsx'/> |
+
+### PollCreationDialog
+
+Custom UI component to override default poll creation dialog contents.
+
+| Type      | Default                                                                                             |
+| --------- | --------------------------------------------------------------------------------------------------- |
+| component | <GHComponentLink text='PollCreationDialog' path='/Poll/PollCreationDialog/PollCreationDialog.tsx'/> |
+
+### PollHeader
+
+Custom UI component to override default poll header in a message.
+
+| Type      | Default                                                          |
+| --------- | ---------------------------------------------------------------- |
+| component | <GHComponentLink text='PollHeader' path='/Poll/PollHeader.tsx'/> |
+
+### PollOptionSelector
+
+Custom UI component to override default poll option selector.
+
+| Type      | Default                                                                          |
+| --------- | -------------------------------------------------------------------------------- |
+| component | <GHComponentLink text='PollOptionSelector' path='/Poll/PollOptionSelector.tsx'/> |
+
 ### QuotedMessage
 
 Custom UI component to override quoted message UI on a sent message.
@@ -625,6 +689,14 @@ Custom UI component to override the message input's quoted message preview.
 | --------- | -------------------------------------------------------------------------------------------- |
 | component | <GHComponentLink text='QuotedMessagePreview' path='/MessageInput/QuotedMessagePreview.tsx'/> |
 
+### QuotedPoll
+
+Custom UI component to override the rendering of quoted poll.
+
+| Type      | Default                                                          |
+| --------- | ---------------------------------------------------------------- |
+| component | <GHComponentLink text='QuotedPoll' path='/Poll/QuotedPoll.tsx'/> |
+
 ### ReactionSelector
 
 Custom UI component to display the reaction selector.