ThreadList

Renders threads and lets you handle selection. Must be rendered inside Chat.

Best Practices

• Render inside Chat to ensure thread data and context are available.
• Use onThreadSelect for navigation and keep it lightweight.
• Provide empty and loading states for better UX.
• Keep list items simple to maintain scroll performance.
• Use additionalFlatListProps sparingly to avoid unexpected list behavior.

General Usage

import { OverlayProvider, Chat, ThreadList } from "stream-chat-react-native";

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

Props

additionalFlatListProps

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

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.

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} />;
};

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.

ThreadListEmptyPlaceholder

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

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.

ThreadList

A custom UI component used to render the entire ThreadList.