SendbirdUIKitContainer

SendbirdUIKitContainer is the most important component in UIKit for React Native because it's the context provider container that passes data from Chat SDK down to the child components. The React Context API is used to easily pass down the data through various components.

Note: SendbirdUIKitContainer must be placed at the top level of your app.

import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native';

const App = () => {
  // top-level of your app.
  return <SendbirdUIKitContainer>{/* ... */}</SendbirdUIKitContainer>;
};

List of properties

The following table shows a list of properties of the SendbirdUIKitContainer component. To learn more about the properties, go to the API reference page.

Properties

Required	Type	Description
appId	string	Specifies the `APP_ID` of the Sendbird application.
platformServices	object	Specifies the platform service interfaces that must be implemented in order to use the native module APIs.
chatOptions	object	Specifies Chat SDK-related properties such as `localCacheStorage`, `enableAutoPushTokenRegistration`, and `onInitialized`. (`localCacheStorage` is required.)

Optional	Type	Description
uikitOptions	object	Specifies properties such as `enableMention` and `enableMessageSearch` used to turn on or off certain UIKit features.
localization	object	Specifies an object that contains the StringSet.
styles	object	Specifies style-related properties such as `theme` and `HeaderComponent`.
toast	object	Specifies properties related to toast messages.
userProfile	object	Specifies properties related to a user profile.
errorBoundary	object	Specifies properties related to error boundary such as `onError` and `ErrorInfoComponent`.

Sample app