ThreadsContext

ThreadsContext is provided by ThreadList. If you are not familiar with the React Context API, see the React docs.

ThreadsContext must be used within Chat because it depends on ChatContext.

Best Practices

• Use useThreadsContext inside Chat to ensure context availability.
• Check isLoading/isLoadingMore before triggering pagination.
• Use onThreadSelect for navigation and keep it lightweight.
• Provide empty and loading UI for a clear UX.
• Avoid mutating threads directly; rely on context updates.

Basic Usage

Consume ThreadsContext in any child of Chat:

import { useContext } from "react";
import { ThreadsContext } from "stream-chat-react-native";

const value = useContext(ThreadsContext);

Alternatively, use the useThreadsContext hook to consume ThreadsContext.

import { useThreadsContext } from "stream-chat-react-native";

const value = useThreadsContext();

Value

isLoading *

Whether threads are currently loading.

isLoadingMore *

Whether the next page of threads is loading.

threads *

Array of Thread instances used to render ThreadList.

isFocused

A boolean indicating if the ThreadList is currently in focus or not. Essentially a flag that lets us know whether the component is present in the viewport. Whenever present, it controls when updates to the ThreadList are active and when they are not. Best used in conjunction with hooks from popular navigation libraries (such as useIsFocused() from React Navigation) for lazy loading purposes.

Example:

import React from "react";
import { useIsFocused } from "@react-navigation/native";
import { ThreadList } from "stream-chat-react-native";

export const ThreadListScreen = () => {
  const isFocused = useIsFocused();
  return <ThreadList isFocused={isFocused} />;
};

additionalFlatListProps

An object containing FlatListProps that can be used to override the default ones provided in the ThreadList.

loadMore

Loads more threads. Returns a promise.

onThreadSelect

A method that will be used as a callback whenever a thread in the list is clicked. As an example, it can be used to navigate to a thread screen displaying the thread.

The arguments passed are as follows:

thread

An object containing two properties, thread and threadInstance. This entire object can be passed as the thread prop to the Channel component.

The threadInstance property is an instance of the Thread class.

The thread property is a reference to the parent message of the thread.

channel

ThreadListEmptyPlaceholder

A custom UI component used to render the empty placeholder if there are no available threads.

ThreadListItem

A custom UI component used to render each item within the ThreadList. It will override the UI of the default ThreadListItem while still keeping all of the data.

Example usage:

import { Text, TouchableOpacity } from "react-native";
import {
  OverlayProvider,
  Chat,
  ThreadList,
  useThreadListItemContext,
  useThreadsContext,
} from "stream-chat-react-native";

const ThreadListItem = () => {
  const { parentMessage, thread, channel } = useThreadListItemContext();
  const { onThreadSelect } = useThreadsContext();

  return (
    <TouchableOpacity onPress={() => onThreadSelect(thread, channel)}>
      <Text>{parentMessage?.text || "Text not available !"}</Text>
    </TouchableOpacity>
  );
};

const App = () => {
  return (
    <OverlayProvider>
      <Chat client={client}>
        <ThreadList ThreadListItem={ThreadListItem} />
      </Chat>
    </OverlayProvider>
  );
};

ThreadListLoadingIndicator

A custom UI component used to render the loading indicator when isLoading is true.

ThreadListLoadingMoreIndicator

A custom UI component used to render the loading indicator when isLoadingNext is true.

ThreadListUnreadBanner

A custom UI component used to render the unread threads banner at the top of the list.