{"id":13646356,"url":"https://github.com/sendbird/sendbird-uikit-react","last_synced_at":"2026-01-02T04:53:07.757Z","repository":{"id":36966019,"uuid":"353576117","full_name":"sendbird/sendbird-uikit-react","owner":"sendbird","description":"Build chat in minutes with Sendbird UIKit open source code.","archived":false,"fork":false,"pushed_at":"2025-05-07T16:27:38.000Z","size":23132,"stargazers_count":211,"open_issues_count":1,"forks_count":139,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-05-11T01:37:09.659Z","etag":null,"topics":["api-for-chat","bard","chat-api","chat-api-platform","chat-platform","chat-sdk","chat-ui","chatbot-api","chatbot-sdk","chatbot-ui","chatgpt","communications-platform","genai-chatbot","genai-chatbot-api","gpt-powered-chatbot","llama2","messaging-api","messaging-platform","messaging-sdk","palm2"],"latest_commit_sha":null,"homepage":"https://sendbird.com/docs/chat/uikit/v3/react/overview","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sendbird.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-01T04:45:58.000Z","updated_at":"2025-05-07T16:27:42.000Z","dependencies_parsed_at":"2023-09-22T10:47:07.052Z","dependency_job_id":"965c05be-ba5d-4eae-9394-eb8a7f42975f","html_url":"https://github.com/sendbird/sendbird-uikit-react","commit_stats":{"total_commits":991,"total_committers":17,"mean_commits":"58.294117647058826","dds":0.574167507568113,"last_synced_commit":"5fbf631b291b5455646ee5cc27bee8420f5e4f2c"},"previous_names":["sendbird/sendbird-uikit-react-sources"],"tags_count":132,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-uikit-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-uikit-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-uikit-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-uikit-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sendbird","download_url":"https://codeload.github.com/sendbird/sendbird-uikit-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254493379,"owners_count":22080126,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-for-chat","bard","chat-api","chat-api-platform","chat-platform","chat-sdk","chat-ui","chatbot-api","chatbot-sdk","chatbot-ui","chatgpt","communications-platform","genai-chatbot","genai-chatbot-api","gpt-powered-chatbot","llama2","messaging-api","messaging-platform","messaging-sdk","palm2"],"created_at":"2024-08-02T01:02:53.640Z","updated_at":"2026-01-02T04:53:07.727Z","avatar_url":"https://github.com/sendbird.png","language":"TypeScript","readme":"# @sendbird/uikit-react\n\n[![Platform React](https://img.shields.io/badge/Platform-React-orange.svg)](https://reactjs.org)\n[![Language TypeScript](https://img.shields.io/badge/Language-TypeScript-orange.svg)](https://www.typescriptlang.org/)\n\n\u003e React based UI kit based on sendbird javascript SDK\n\nWe 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](MIGRATION_v2-to-v3.md).\n\n## Installation\n\n`yarn add @sendbird/uikit-react`\nor if you're using npm\n`npm i @sendbird/uikit-react`\n\n## Getting Started\n\nWith Sendbird UI Kit React, we export these components:\n(See `src/index.jsx`)\n\n* SendBirdProvider - The context provider for SDK component\n* useSendbirdStateContext - Hook to access SendBirdProvider context\n* sendBirdSelectors - A bunch of useful selectors that can be used along with *useSendbirdStateContext*\n\n* Channel - A UI Component where conversations happen\n* ChannelList - A ChannelList UI component\n* ChannelSettings - A component to handle the settings of a given channel\n* MessageSearch - To search for a message from a Channel\n* OpenChannel - A UI Component where open channel conversations happen\n* OpenChannelSettings - A component to handle the settings of a given channel\nAnd many more...\n\n* 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\n\n\u003e Note 1: Dont forget to import the stylesheet from the repo too\n\u003e Note 2: Name of some components are different from the directories they are in(example -\u003e Channel component is from Conversation component). Please keep that in mind\n\n### Prerequisites\n\nYou need to install:\n* [nodejs](https://nodejs.org/en/download/) 18\u003e=\n* npm 9\u003e= or yarn 3\u003e=\n\n\n## Development\n \nWe use vite app for development and rollup for building the npm distribution(bundled JS file)\nMake sure you have nodejs and yarn installed and run\n\n\u003e Make a copy of `apps/testing/.env.example` and save it as `apps/testing/.env` \n\u003e Set your appId to `VITE_APP_ID`\n\n```shell\nyarn install\nyarn dev\n```\n\n* By default, vite app opens in http://localhost:5173/\n* Please refer to the following link for more details: [Link](apps/testing/README.md)\n\n### Storybook\n\nWe provide a Storybook to easily view and understand the components.\n\u003cbr/\u003ehttps://sendbird.github.io/sendbird-uikit-react/\n\n```shell\nyarn storybook\n```\n\n### Build\n\nWe use RollupJS for building the production bundle script that you want to use inside your applications.\n\nWe have both `ESM` and `CJS` output\n\n```\nyarn build\n```\n\nThe bundled JS code can be found in `./dist`\nThe CSS is in `./dist/dist/index.css`\n\n**Caveats**\n - We tried development on Mac OS / Linux systems. You might encounter problems in running `yarn build`  in Windows machines\n\n### Tests\n\nWe have implemented tests for dumb ui components only. Technologies used: Jest and testing-library\n\n```\nyarn test\n```\n\n### Lint\n\n```\nyarn lint\n```\n\n### Creating/Exporting New Components\n\n1. Define your component inside `./src`.\n2. Add the following line to `./rollup.module-exports.js`:\n    ```\n    'NewComponent/SubComponent': 'location/of/NewComponent/SubComponent',\n    ```\n    - This component can be imported by the consumer as: `import SubComponent from '@sendbird/uikit-react/NewComponent/SubComponent';`\n\n### Scaffolding New Components\n\n1. Use `yarn run generate-component` to generate a UI component in `src/ui`. It uses [Plop.js](https://plopjs.com/) to generate the component.\n2. It can also be used to generate [reducers](/src/utils/typeHelpers/reducers/README.md).\n3. Plop templates are found in [here](/plop-templates).\n\n## Acknowledgments\n### LameJS\n\nWe use lamejs for converting audio formats\nIt is a fast mp3 encoder written in JavaScript. The original repo is:\n* https://lame.sourceforge.net or\n* https://github.com/zhuker/lamejs\n","funding_links":[],"categories":["Others","TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Fsendbird-uikit-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsendbird%2Fsendbird-uikit-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Fsendbird-uikit-react/lists"}