This is documentation for Stream Chat React SDK v11, which is nolonger actively maintained. For up-to-date documentation, see the latest version (v12).

Overview

Building on top of the Stream Chat API, the Stream Chat React component library includes everything you need to build feature-rich and high-functioning chat user experiences out of the box. The library includes an extensive set of performant and customizable React components which allow you to get started quickly with little to no plumbing required. Use cases include team and social messaging, virtual events, livestream gaming, and customer support. The library supports:

Rich media messages
Reactions
Threads and quoted replies
Text input commands (ex: Giphy and @mentions)
Image and file uploads
Video playback
Read state and typing indicators
Channel and message lists

Where to get started

If you are new to our SDK it is best to go through a of our tutorial.

After that, our getting started page is a great next step.

If you are integrating our SDK, please pay attention to our Theming and Customizing Components sections in our guides. We see that most of our users can get very far by utilizing the flexibility of our SDKs.

Architecture

A common pattern in the library is the use of context provider hooks. These custom hooks allow for effective value sharing between parent components and their children. This makes customization straightforward, as you can use our exported hooks in your custom components to receive the exact values needed, while also subscribing to context changes.

The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions below for adding the library to your React project.

Installation