@sendbird/uikit-react 3.0.0-beta.3 → 3.0.0-beta.4

package/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog - v3
+
+## [3.0.0-beta.4] (May 24 2022)
+Fixes:
+* Export useChannelList
+* Active disableAutoSelect props
+* Remove empty CSS file to fix source map warning
+
+DOC:
+* Add info about webpack 5 breaking changes
+## [3.0.0-beta.3] (May 19 2022)
+Fixes:
+* Rate limit markAsDelivered call
+* Do not render date separator when renderCustomSeparator is null
+Misc:
+* Update Chat SDK minimum version to `3.1.13`
+
+## [3.0.0-beta.2] (April 29 2022)
+
+Feature:
+* Mention
+  * Add isMentionEnabled props to the <App /> and <SendbirdProvider />
+  * Add userMention into the config props of the <App /> andd <SendbirdProvider />
+    * <SendbirdProvider config={{ userMention: { maxMentionCount: 10, maxSuggestionCount: 15 } }} />
+    * maxMentionCount: A maximum count that you can mention in the message input
+    * maxSuggestionCount: A maximum user count that the SuggestedMentionList suggests for user mention
+  * Create SuggestedMentionList component under the Channel smart component
+    * Create SuggestedUserMentionItem component
+  * Create MentionUserLabel ui component
+  * Add string set
+    * MENTION_NAME__NO_NAME: '(No name)'
+    * MENTION_COUNT__OVER_LIMIT: 'You can mention up to %d times per message.'
+Fix:
+* Type definition file fix for TS project
+For typescript projects, add `node_modules/@sendbird/uikit-react/index.d.ts`
+to your `include` section in tsconfig file to get type definitions
+
+* Move font import to top of CSS file
+Some bundlers such as parcel throw error:
+`@import rules must precede all rules aside from @charset and @layer statements`
+Resolve this issue by moving the line to the top
+
+## [3.0.0-beta] (Apr 12 2022)
+
+This is the official beta for Sendbird UIKit for React version 3!
+
+TLDR -> We split the old `smart-components` into modules which contian context and UI. Context contain logic and UI Components handle UI
+
+**[Check out the v2 to v3 migration guide for details](MIGRATION_v2-to-v3.md)**
+
+Changelog:
+* Package should be installed using `@sendbird/uikit-react`
+* Restructure smart-components into modules that contain a context and related UI components
+* Export these context and UI components to allow fine-grain customization
+* Recommend to use these context elements `useXXXXX()` and react function components to make custom components
+* All generic UI components are available as exports
+* Restrcuture export paths to allow better tree-shaking
+* Example:
+```
+import { useChannel } from '@sendbird/uikit-react/Channel/context';
+import ChannelUI from '@sendbird/uikit-react/Channel/components/ChannelUI';
+```
+* We keep older export patterns to make migration easier
+* Retained modules - ChannelList, Channel, ChannelSettings, OpenChannel, OpenChannelSettings, MessageSearch
+* New modules(not including context and ui of above) - CreateChannel, EditUserProfile, ui

package/README.md

@@ -0,0 +1,129 @@
+# sendbird-uikit
+
+[![Version 3 beta](https://img.shields.io/badge/Sendbird-BETA-blue.svg)](https://github.com/sendbird/sendbird-uikit-react/tree/develop-v3)
+[![Platform React](https://img.shields.io/badge/Platform-React-orange.svg)](https://reactjs.org)
+[![Language TypeScript](https://img.shields.io/badge/Language-TypeScript-orange.svg)](https://www.typescriptlang.org/)
+
+> 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](MIGRATION_v2-to-v3.md).
+
+## Installation
+
+`npm i @sendbird/uikit-react`
+
+For typescript projects, add `node_modules/@sendbird/uikit-react/index.d.ts` to your `include` section in tsconfig file to get type definitions
+
+## 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 14 LTS https://nodejs.org/en/download/
+* npm 7 or above
+
+```
+npm 14 deprecated warnings for fsevents& chokidar@2.1.8 will be fixed when storybook is updated to webpack 5
+https://github.com/storybookjs/storybook/issues/12425#issuecomment-723043137
+```
+
+We tried development on Mac OS / Linux systems. You might encounter problems in running `npm run build` in Windows machines
+
+### Development
+
+We use storybook for development and rollup for building the npm distribution(bundled JS file)
+Make sure you have nodejs and npm 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
+```
+> `npm run generate-component` generates a UI component skeleton in `src/ui`
+
+* By default, storybook opens in http://localhost:6006/
+* Smart Components such as ChannelList, Channel, ChannelSetting, App can be found under `OTHERS`
+* Dumb components such as inputs, buttons etc can be found under `OTHERS/UI Components` in storybook sidebar
+* Overridden storybook configs can be found in: `./storybook`
+
+### Build
+
+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
+```
+
+The bundled JS code can be found in `./release`
+The CSS is in `./release/dist/index.css`
+
+## Running the tests
+
+We have implemented tests for dumb ui components only. Technologies used: Jest, Enzyme and react-dom/test-utils
+
+```
+npm run test
+```
+
+### Lint
+
+```
+npm run lint
+```
+* .eslintrc.json lints ts files and .eslintrc.js lints js files
+
+
+### Typescript
+
+* We are trying to progressively move our source code to typescript - which means older JS code and newly written TS code will coxist while we migrate older JS code to TS
+* .eslintrc.json lints ts files and .eslintrc.js lints js files
+* Type definition file can be `src/index.d.ts` which will be copied to `/release` directory
+
+### Webpack 5
+
+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
+```javascript
+module.exports = {
+  //...
+  resolve: {
+    fallback: {
+      buffer: require.resolve('buffer'),
+      stream: require.resolve('stream-browserify'),
+    },
+  },
+};
+
+```
+To read more: https://webpack.js.org/configuration/resolve/#resolvefallback
+
+### Creating/exporting new components
+
+1. Define your component inside './src'
+2. Add the following line to './src/index.js'
+  `export NewComponent from './src/location/of/NewComponent';`
+3. Add the following line to './exports.js'
+  `NewComponent: 'src/location/of/NewComponent',`

package/dist/index.css

@@ -743,7 +743,6 @@
     left: 22px;
     top: 24px; }
 
-
 .sendbird-create-channel--content {
   width: 480px;
   max-height: 552px; }
@@ -3816,7 +3815,6 @@ p.sendbird-og-message-item-body__text-bubble {
     .sendbird-openchannel-conversation .sendbird-openchannel-conversation-scroll-container .sendbird-openchannel-conversation-scroll-padding {
       flex: 1 1 0; }
 
-
 .sendbird-frozen-channel-notification {
   position: relative;
   margin-top: 8px;