React based UI kit based on sendbird javascript SDK
We are introducing a new version of the Sendbird Chat UIKit. Version 3 features a new modular architecture with more granular components that give you enhanced flexibility to customize your web and mobile apps. Check out our migration guides.
Two Sendbird plugins for Claude Code and Codex help you add this SDK to your React app:
- The Sendbird Client Plugin writes setup and feature code from verified Sendbird documentation and the Sendbird SDK you have installed.
- The Sendbird CLI plugin signs you in to Sendbird and manages your apps, users, and channels with the Sendbird CLI. The client plugin can take the App ID from the app you choose there.
The CLI plugin needs Node.js 22.23.4 or a later 22.x release, or 24.22.1 or a later 24.x release. Its setup installs the Sendbird CLI with npm if it is missing.
In Claude Code:
claude plugin marketplace add sendbird/sendbird-plugins
claude plugin install sendbird-client@sendbird
claude plugin install sendbird-cli@sendbirdStart a new session, run /sendbird-cli:sendbird-setup to sign in and choose your app, and then run /sendbird-client:setup --product uikit in your project.
In Codex:
codex plugin marketplace add sendbird/sendbird-plugins
codex plugin add sendbird-client@sendbird
codex plugin add sendbird-cli@sendbirdStart a new session. When Codex shows "Hooks need review", choose Review hooks and press t to trust the client plugin's hooks. Then call $sendbird-cli:sendbird-setup to sign in and choose your app, and then call $sendbird-client:setup --product uikit in your project.
See the Client plugin guide and the CLI plugin guide for setup details and example requests.
The client plugin runs local shell scripts as hooks. Review What runs on your machine before installing.
yarn add @sendbird/uikit-react
or if you're using npm
npm i @sendbird/uikit-react
With Sendbird UI Kit React, we export these components:
(See src/index.jsx)
-
SendBirdProvider - The context provider for SDK component
-
useSendbirdStateContext - Hook to access SendBirdProvider context
-
sendBirdSelectors - A bunch of useful selectors that can be used along with useSendbirdStateContext
-
Channel - A UI Component where conversations happen
-
ChannelList - A ChannelList UI component
-
ChannelSettings - A component to handle the settings of a given channel
-
MessageSearch - To search for a message from a Channel
-
OpenChannel - A UI Component where open channel conversations happen
-
OpenChannelSettings - A component to handle the settings of a given channel And many more...
-
App - is a full fledged app(group channel) component made by combining the above components so that you dont have to combine all the above components by hand. Also it can be used as an example for composing components to build a chat UI
Note 1: Dont forget to import the stylesheet from the repo too Note 2: Name of some components are different from the directories they are in(example -> Channel component is from Conversation component). Please keep that in mind
You need to install:
- nodejs 18>= (20>= to run
yarn test:visual, which uses Playwright) - npm 9>= or yarn 3>=
We use vite app for development and rollup for building the npm distribution(bundled JS file) Make sure you have nodejs and yarn installed and run
Make a copy of
apps/testing/.env.exampleand save it asapps/testing/.envSet your appId toVITE_APP_ID
yarn install
yarn dev- By default, vite app opens in http://localhost:5173/
- Please refer to the following link for more details: Link
We provide a Storybook to easily view and understand the components.
https://sendbird.github.io/sendbird-uikit-react/
yarn storybookWe use RollupJS for building the production bundle script that you want to use inside your applications.
We have both ESM and CJS output
yarn build
The bundled JS code can be found in ./dist
The CSS is in ./dist/dist/index.css
Caveats
- We tried development on Mac OS / Linux systems. You might encounter problems in running
yarn buildin Windows machines
We have implemented tests for dumb ui components only. Technologies used: Vitest and testing-library
yarn test
yarn lint
- Define your component inside
./src. - Add the following line to
./rollup.module-exports.js:'NewComponent/SubComponent': 'location/of/NewComponent/SubComponent',- This component can be imported by the consumer as:
import SubComponent from '@sendbird/uikit-react/NewComponent/SubComponent';
- This component can be imported by the consumer as:
- Use
yarn run generate-componentto generate a UI component insrc/ui. It uses Plop.js to generate the component. - It can also be used to generate reducers.
- Plop templates are found in here.
We use lamejs for converting audio formats It is a fast mp3 encoder written in JavaScript. The original repo is: