This is documentation for Stream Chat React-native SDK v3, which is no longer actively maintained. For up-to-date documentation, see the latest version (v5).

Thread

Component to render thread replies for a message, along with and input box for adding new thread replies. This component internally uses MessageList and MessageInput components.

Basic Usage

<OverlayProvider>
  <Chat client={client}>
    <Channel channel={channel} thread={messageId}>
      <partial id="chat-sdk/react-native/v3/_partials/common-content/core-components/channel/props/thread"></partial>
    </Channel>
  </Chat>
</OverlayProvider>

Props

additionalMessageInputProps

Additional props for underlying MessageInput component.

Type
object

additionalMessageListProps

Additional props for underlying MessageList component.

Type
object

autoFocus

When true, input box will be auto focused upon mounting.

TypeDefault
booleantrue

client

Instance of StreamChat client.

closeThread

Unsets the thread and thread messages in the Channel state.

Type
function

disabled

When true, the underlying input box will be disabled.

TypeDefault
booleanfalse

loadMoreThread

Loads more messages for the thread. Returns a promise.

Type
() => Promise<void>

onThreadDismount

Function which gets called when Thread component un-mounts.

Type
function

reloadThread

Reloads the thread and thread messages.

Type
function

thread

A message object that when set indicates a thread is open. When used with the Thread component this will display the thread. When used with the standard MessageList component this will prevent any singleton components in the OverlayProvider form getting out of sync.

thread should be set on all Channel components when a thread is open.

Type
object

© Getstream.io, Inc. All Rights Reserved.