fix: Channel thread type (#2748)

* fix: Channel thread type * fix: docs for thread * fix: poll docs too
GetStream · Nov 1, 2024 · d7deaf4 · d7deaf4
1 parent a861a33
commit d7deaf4
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/docusaurus/docs/reactnative/common-content/ui-components/channel/props/thread.mdx b/docusaurus/docs/reactnative/common-content/ui-components/channel/props/thread.mdx
@@ -1,4 +1,6 @@
-A message object that when set indicates a thread is open.
+Can be either a `MessageType` object or a [`ThreadType`](https://github.com/GetStream/stream-chat-react-native/blob/develop/package/src/contexts/threadContext/ThreadContext.tsx) that when set indicates a thread is open.
+Both of the types may be used interchangeably.
+
 When used with the [`Thread`](../../../../ui-components/thread.mdx) component this will display the thread.
 When used with the standard [`MessageList`](../../../../ui-components/message-list.mdx) component this will prevent any singleton components in the [`OverlayProvider`](../../../../core-components/overlay-provider.mdx) form getting out of sync.
 

diff --git a/docusaurus/docs/reactnative/hooks/poll/use-poll-state.mdx b/docusaurus/docs/reactnative/hooks/poll/use-poll-state.mdx
@@ -39,7 +39,7 @@ A property containing the number of answers (comments) to the `poll`.
 | -------- |
 | `number` |
 
-### `created_by`
+### `createdBy`
 
 A property containing information about the user who created the `poll`. Its type can be found [here](https://github.com/GetStream/stream-chat-js/blob/b447512922b19bc7e3668bd9df81debcb673dd81/src/types.ts) under `UserResponse`.
 
@@ -57,7 +57,7 @@ A property depicting whether each user should have only one and unique vote or t
 | --------- |
 | `boolean` |
 
-### `is_closed`
+### `isClosed`
 
 A property depicting whether the `poll` is still open for voting or not.
 
@@ -75,7 +75,7 @@ This property is not available for anonymous polls.
 | -------------------------- |
 | `Record<string, PollVote>` |
 
-### `max_votes_allowed`
+### `maxVotesAllowed`
 
 A property containing the maximum number of votes allowed per user.
 

diff --git a/docusaurus/docs/reactnative/ui-components/thread.mdx b/docusaurus/docs/reactnative/ui-components/thread.mdx
@@ -23,7 +23,7 @@ const App = () => {
   return (
     <OverlayProvider>
       <Chat client={client}>
-        <Channel channel={channel} thread={messageId} threadList>
+        <Channel channel={channel} thread={message} threadList>
           // highlight-next-line
           <Thread />
         </Channel>

diff --git a/package/src/components/Channel/Channel.tsx b/package/src/components/Channel/Channel.tsx
@@ -2516,8 +2516,10 @@ const ChannelWithContext = <
 
 export type ChannelProps<
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
-> = Partial<Omit<ChannelPropsWithContext<StreamChatGenerics>, 'channel'>> &
-  Pick<ChannelPropsWithContext<StreamChatGenerics>, 'channel'>;
+> = Partial<Omit<ChannelPropsWithContext<StreamChatGenerics>, 'channel' | 'thread'>> &
+  Pick<ChannelPropsWithContext<StreamChatGenerics>, 'channel'> & {
+    thread?: MessageType<StreamChatGenerics> | ThreadType<StreamChatGenerics> | null;
+  };
 
 /**
  *