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

SendbirdProvider

Copy link

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 the useSendbirdStateContext() component, you can implement Sendbird Chat SDK for React in any of the components under SendbirdProvider. The following table shows a list of properties of the SendbirdProvider component.

List of properties

Copy link
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)

ThreadReplySelectType

function

Specifies the prop to direct users to view either the parent message or the thread when they click on a reply button in the group channel module. Acceptable values are: PARENT and THREAD.

onUserProfileMessage

function

Specifies the prop to handle the action when a user starts a 1-to-1 channel by clicking the message on a user profile icon. (Default: null

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