ChatContext

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

Best Practices

Consume ChatContext in any child of Chat:

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

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

Alternatively, use the useChatContext hook.

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

const { client, isOnline } = useChatContext();

Value	Description	Type
`client`	Stream Chat client instance.	`StreamChat`
`appSettings`	App settings for the connected client.	`AppSettingsAPIResponse`
`channel`	The currently active channel instance.	`Channel`
`connectionRecovering`	`true` when the WebSocket connection is disconnected and being recovered.	`boolean`
`enableOfflineSupport`	Enables offline support for the chat. When enabled, messages and channels are cached locally and the app can work without an internet connection. Requires `@op-engineering/op-sqlite` to be installed. See the offline support documentation for more details on setting this up. Defaults to `false`.	`boolean`
`isOnline`	`true` when the current user is connected. `null` during initial connection detection.	`boolean \| null`
`mutedUsers`	Users muted by the current user.	`array`
`setActiveChannel`	Callback to set the active channel.	`(newChannel?: Channel) => void`
`isMessageAIGenerated`	A callback that determines whether a `message` was AI generated. Defaults to `() => false`.	`(message: LocalMessage) => boolean`

ImageComponent is provided through WithComponents and can be read via useComponentsContext():

const { ImageComponent } = useComponentsContext();