@sendbird/uikit-react
v3.15.11
Published
Sendbird UIKit for React: A feature-rich and customizable chat UI kit with messaging, channel management, and user authentication.
Downloads
117,703
Maintainers
Readme
@sendbird/uikit-react
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.
Installation
yarn add @sendbird/uikit-react
or if you're using npm
npm i @sendbird/uikit-react
Getting Started
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
Prerequisites
You need to install:
- nodejs 18>=
- npm 9>= or yarn 3>=
Development
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.example
and save it asapps/testing/.env
Set 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
Storybook
We provide a Storybook to easily view and understand the components. https://sendbird.github.io/sendbird-uikit-react/
yarn storybook
Build
We 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 build
in Windows machines
Tests
We have implemented tests for dumb ui components only. Technologies used: Jest and testing-library
yarn test
Lint
yarn lint
Creating/Exporting New Components
- 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:
Scaffolding New Components
- Use
yarn run generate-component
to 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.
Acknowledgments
LameJS
We use lamejs for converting audio formats It is a fast mp3 encoder written in JavaScript. The original repo is:
- https://lame.sourceforge.net or
- https://github.com/zhuker/lamejs