UIKit React v3
UIKit React
UIKit
React
Home
/
UIKit
/
React
This is the new Docs for UIKit v3 beta for React. To see the previous Docs, click here.

SendbirdProvider

SendbirdProvider is the most important component in UIKit for React because it's the context provider that passes the Chat SDK down to the child components. The React Context API is used to easily pass down data through components. By using withSendBird() HOC or useSendbirdStateContext() component, you can implement Sendbird Chat SDK for Javascript in any of the components under SendbirdProvider. The following table shows a list of properties of the SendbirdProvider component.

List of properties

Properties
RequiredTypeDescription

appId

string

Specifies the APP_ID of the Sendbird application.

userId

string

Specifies the unique ID of the user.

OptionalTypeDescription

accessToken

string

Specifies an opaque string that identifies the user. It's recommended that every user has their own access token and provides it upon login for security. (Default: null)

theme

string

Specifies a style that's applied to the entire client app. Available themes are light and dark. (Default: light)

nickname

string

Specifies the user's nickname. (Default: null)

profileUrl

string

Specifies the URL of the user's profile image. (Default: null)

userListQuery

interface

Specifies the query factory class to retrieve a list of filtered users and manually added users. (Default: Chat SDK's ApplicationUserListQuery)

dateLocale

locale

Specifies the prop to localize the date and time of the current user's client app using Localization object from date-fns. (Default: en-US)

stringSet

object

Specifies a set of strings used in UIKit components. You can override the default language using the stringSet. (Default: null)

colorSet

object

Specifies a set of colors used in the UIKit themes. You can override the theme using the colorSet. (Default: null)

Note : The App component internally manages SendbirdProvider as well as other components and can be used to configure the above properties.