Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@wearesweet/sendbird-uikit-react
Advanced tools
Readme
yarn install
npm run build
cd dist
npm version patch
npm publish --access public
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.
npm i @sendbird/uikit-react
or if you're using yarn
yarn add @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:
Caveats
npm run build
or yarn run build
in Windows machinesWe use storybook for development and rollup for building the npm distribution(bundled JS file) Make sure you have nodejs and npm (or yarn) installed and run
Make a copy of .env.example and save it as .env Set your appId STORYBOOK_APP_ID
npm install
npm run storybook
or
yarn install
yarn storybook
OTHERS
OTHERS/UI Components
in storybook sidebar./storybook
If you face the error during running storybook
Error: error: 0308010C:digital envelope rountines::unsupported
try to run below in termial, and run storybook again
export NODE_OPTIONS=--openssl-legacy-provider
We use Husky for githooks
To enable Husky in local, run:
yarn husky install
or npx husky install
We use rollupJS for building the production bundle script that you want to use inside your applications.
We have both esm and commonjs output
npm run build
or
yarn run build
The bundled JS code can be found in ./release
The CSS is in ./release/dist/index.css
We have implemented tests for dumb ui components only. Technologies used: Jest and testing-library
npm run test
or
yarn run test
npm run lint
or
yarn run lint
Webpack 5 removes stream and buffer componets from default polyfill To enable these, install buffer and stream and then add the following to webpack.cofig.js
module.exports = {
//...
resolve: {
fallback: {
buffer: require.resolve('buffer'),
stream: require.resolve('stream-browserify'),
},
},
};
To read more: https://webpack.js.org/configuration/resolve/#resolvefallback
./src
../src/index.ts
:export { default as NewComponent } from './src/location/of/NewComponent';
import { NewComponent } from '@sendbird/uikit-react';
./rollup.module-exports.js
:
'NewComponent/SubComponent': 'location/of/NewComponent/SubComponent',
import SubComponent from '@sendbird/uikit-react/NewComponent/SubComponent';
yarn run generate-component
to generate a UI component in src/ui
. It uses Plop.js to generate the component.ERR_OSSL_EVP_UNSUPPORTED
error on any run cmd, try to run yarn storybook:stable
instead.We use lamejs for converting audio formats It is a fast mp3 encoder written in JavaScript. The original repo is:
FAQs
Fork of Sendbird UIKit for React to implement additional functionality for We Are Sweet projects
The npm package @wearesweet/sendbird-uikit-react receives a total of 55 weekly downloads. As such, @wearesweet/sendbird-uikit-react popularity was classified as not popular.
We found that @wearesweet/sendbird-uikit-react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.