Skip to main content
Version: v4

ChatContext

ChatContext is provided by Chat component. If you are not familiar with React Context API, please read about it on React docs.

Basic Usage#

ChatContext can be consumed by any of the child component of Chat component as following:

import { useContext } from 'react';
import { ChatContext } from 'stream-chat-react-native';

const { client, isOnline } = useContext(ChatContext);

Alternatively, you can also use useChatContext hook provided by library to consume ChatContext.

import { useChatContext } from 'stream-chat-react-native';

const { client, isOnline } = useChatContext();

Value#

client#

Instance of StreamChat client.

Type
StreamChat

connectionRecovering#

The value is true, when connection to websocket server is disconnected and is currently being recovered.

Type
boolean

isOnline#

The value is true, when current user is connected to chat.

Type
boolean

mutedUsers#

Array of users muted by current user.

Type
array

Did you find this page helpful?