# Chat

> **Info:** This is documentation for **Stream Chat React Native SDK v5**, which is no longer actively maintained. For up-to-date documentation, see the [latest version (v10)](https://getstream.io/chat/docs/sdk/react-native/).

`Chat` provides the [ChatContext](https://getstream.io/chat/docs/sdk/react-native/v5/contexts/channel-context/), [TranslationContext](https://getstream.io/chat/docs/sdk/react-native/v5/contexts/translation-context/), and [ThemeContext](https://getstream.io/chat/docs/sdk/react-native/v5/contexts/theme-context/) to its child components.
`Chat` is the second highest level component in the Stream Chat for React Native library with only the [`OverlayProvider`](https://getstream.io/chat/docs/sdk/react-native/v5/core-components/overlay-provider/) at a higher level.

`Chat` is also responsible for tracking the health of the WebSocket connection with Stream Chat server.
The value `isOnline` provided by the [ChatContext](https://getstream.io/chat/docs/sdk/react-native/v5/contexts/chat-context/#isonline) indicates the status of the connection.

## General Usage

`Chat` should be rendered inside of the `OverlayProvider` at a high level of your application, similar to the `OverlayProvider`.

>
> **Info:** We recommend using only one instance of `Chat` provider per application unless absolutely needed.
>

```tsx {4,5,6,7,15,16,17,18,19,23,25}
import { StreamChat } from "stream-chat";
import {
  ChannelList,
  Chat,
  OverlayProvider,
  useCreateChatClient,
} from "stream-chat-react-native";

const chatApiKey = "REPLACE_WITH_API_KEY";
const chatUserId = "REPLACE_WITH_USER_ID";
const chatUserName = "REPLACE_WITH_USER_NAME";
const chatUserToken = "REPLACE_WITH_USER_TOKEN";

const user = {
  id: chatUserId,
  name: chatUserName,
};

export const App = () => {
  const chatClient = useCreateChatClient({
    apiKey: chatApiKey,
    userData: user,
    tokenOrProvider: chatUserToken,
  });

  return (
    <OverlayProvider>
      <Chat client={chatClient}>
        <ChannelList />
      </Chat>
    </OverlayProvider>
  );
};
```

>
> **Tip:** You can use the `useCreateChatClient` hook from `stream-chat-react-native`/`stream-chat-expo` to create a client instance and automatically connect/disconnect a user as per the example above, for simplicity.
>

## Context Providers

`Chat` contains providers for the `ChatContext`, `ThemeContext`, and `TranslationContext`.
These can be accessed using the corresponding hooks.

| Context                                                                                                                                                   | Hook                    |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| [`ChatContext`](https://github.com/GetStream/stream-chat-react-native/blob/develop/package/src/contexts/chatContext/ChatContext.tsx)                      | `useChatContext`        |
| [`ThemeContext`](https://github.com/GetStream/stream-chat-react-native/blob/develop/package/src/contexts/themeContext/ThemeContext.tsx)                   | `useTheme`              |
| [`TranslationContext`](https://github.com/GetStream/stream-chat-react-native/blob/develop/package/src/contexts/translationContext/TranslationContext.tsx) | `useTranslationContext` |

## Props

### `client`

Instance of StreamChat client.

| Type                                                        |
| ----------------------------------------------------------- |
| [`StreamChat`](https://github.com/GetStream/stream-chat-js) |

### `closeConnectionOnBackground`

When set to false the WebSocket connection won't disconnect when sending the app to the background.
To receive push notifications it's necessary that user doesn't have an active WebSocket connection.
By default the WebSocket connection is disconnected when the app goes to the background, and reconnects when app comes to the foreground.

| Type    | Default |
| ------- | ------- |
| Boolean | `true`  |

### `i18nInstance`

Instance of `Streami18n` class used for internationalization.
Please read more in the [translations docs](https://getstream.io/chat/docs/sdk/react-native/v5/basics/translations/) for details on creation and customization.

| Type                                                                |
| ------------------------------------------------------------------- |
| [`Streami18n`](https://getstream.io/chat/docs/sdk/react-native/v5/basics/translations/) |

### `style`

A `theme` object to customize the styles of SDK components.
Detailed information on theming can be found in the [customization documentation](https://getstream.io/chat/docs/sdk/react-native/v5/customization/theming/).

>
> **Note:** Themes are inherited from parent providers.
> A [theme provided to the `OverlayProvider`](https://getstream.io/chat/docs/sdk/react-native/v5/core-components/overlay-provider/#value) will be the base theme `style` is merged into.
> Themes are not hoisted though, therefore a theme provided to `Chat` will not change overlay components such as the attachment picker.
>

| Type   |
| ------ |
| Object |

### `resizableCDNHosts`

This option allows you to specify a list of CDNs that offer image resizing.

| Type       | Default                  |
| ---------- | ------------------------ |
| `string[]` | `['.stream-io-cdn.com']` |

## UI Component Props

### `ImageComponent`

Drop in replacement of all the underlying [`Image`](https://reactnative.dev/docs/next/image) components within SDK.
This is useful for the purpose of offline caching of images. Please check the [Offline Support Guide](https://getstream.io/chat/docs/sdk/react-native/v5/basics/offline-support/) for usage.

| Type          | Default                                            |
| ------------- | -------------------------------------------------- |
| ComponentType | [`Image`](https://reactnative.dev/docs/next/image) |

### `LoadingIndicator`

Custom loading indicator component to be used to represent the loading state of the chat.

This can be used during the phase when db is not initialised.

| Type                                     | Default |
| ---------------------------------------- | ------- |
| `ComponentType` \| `null` \| `undefined` | `null`  |

### isMessageAIGenerated

A callback function responsible for determining whether a `message` was AI generated. Default function implementation just returns boolean value `false`.

| Type                              | Default     |
| --------------------------------- | ----------- |
| (message: MessageType) => boolean | () => false |

---

For the most recent version of this documentation, visit [https://getstream.io/chat/docs/sdk/react-native/v5/core-components/chat/](https://getstream.io/chat/docs/sdk/react-native/v5/core-components/chat/).