Chat UIKit React Native v3
Chat UIKit React Native
Chat UIKit
React Native
Version 3

SendbirdUIKitContainer

Copy link

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.

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

const App = () => {
    return <SendbirdUIKitContainer>{/* ... */}</SendbirdUIKitContainer>;
};

List of properties

Copy link

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
RequiredTypeDescription

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.)

OptionalTypeDescription

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.