@connectycube/chat-widget 0.15.0 → 0.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +2 -123
  2. package/dist/index.es.js +1933 -1931
  3. package/dist/index.umd.js +27 -27
  4. package/package.json +6 -3
package/README.md CHANGED
@@ -142,132 +142,11 @@ See chat widget code samples <https://github.com/ConnectyCube/connectycube-chat-
142
142
 
143
143
  ## Props
144
144
 
145
- | Prop Name | Type | Description | Default Value |
146
- | --------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------- |
147
- | `appId` | `number \| string` | The ConnectyCube Application ID | |
148
- | `authKey` | `string` | The ConnectyCube Authentication Key | |
149
- | `config` | `object` | _(Optional)_ Configuration options for ConnectyCube SDK | |
150
- | `userId` | `string` | A User Id from your system | |
151
- | `userName` | `string` | User name. This is how other users will see your user name | |
152
- | `userAvatar` | `string` | _(Optional)_ User Avatar URL | |
153
- | `userProfileLink` | `string` | _(Optional)_ User profile link URL | |
154
- | `muted` | `boolean` | _(Optional)_ Do not play sound on incoming message | false |
155
- | `splitView` | `boolean` | _(Optional)_ Displays the chats in split view or single view | false |
156
- | `showOnlineUsersTab` | `boolean` | _(Optional)_ Displays users tab with the list of online users | false |
157
- | `buttonTitle` | `string` | _(Optional)_ The text displayed on the chat button | "Chat" |
158
- | `buttonStyle` | `React.CSSProperties` | _(Optional)_ Inline styles for the button | |
159
- | `portalStyle` | `React.CSSProperties` | _(Optional)_ Inline styles for the portal | |
160
- | `badgeStyle` | `React.CSSProperties` | _(Optional)_ Inline styles for the badge | |
161
- | `buttonClassName` | `string` | _(Optional)_ CSS class or Tailwind CSS classes for the button | |
162
- | `portalClassName` | `string` | _(Optional)_ CSS class or Tailwind CSS classes for the chat | |
163
- | `badgeClassName` | `string` | _(Optional)_ CSS class or Tailwind CSS classes for the badge | |
164
- | `quickActions` | `object` | _(Optional)_ Configuration for quick actions dialog. See [QuickActions](#quickactions) | |
165
- | `translation` | `string` | _(Optional)_ Specifies the language for the chat widget. See [Supported Translations](#supported-translations) | "en" |
166
- | `hideNewChatButton` | `boolean` | _(Optional)_ Allows to hide the chat creation button | false |
167
- | `hideWidgetButton` | `boolean` | _(Optional)_ Allows to hide the button that opens/hides the chat widget. Needed for own implementation of the button | false |
168
- | `open` | `boolean` | _(Optional)_ To control the visibility state of the chat widget | false |
169
- | `onOpenChange` | `(open: boolean) => void` | _(Optional)_ Callback function to get update about chat widget visibility | |
170
- | `onUnreadCountChange` | `(count: boolean) => void` | _(Optional)_ Callback function to get update about unread messages count | |
171
-
172
- ## Quick Actions
173
-
174
- | Prop Name | Type | Description | Default Value |
175
- | ------------- | ---------- | ------------------------------------------------ | ------------- |
176
- | `title` | `string` | _(Optional)_ Title for the quick actions section | |
177
- | `description` | `string` | _(Optional)_ Description for the quick actions | |
178
- | `actions` | `string[]` | List of action strings | |
179
-
180
- ## Supported Translations
181
-
182
- | Language Code | Language |
183
- | ------------- | --------- |
184
- | `en` | English |
185
- | `el` | Greek |
186
- | `ua` | Ukrainian |
145
+ See all available props https://developers.connectycube.com/js/chat-widget/#props
187
146
 
188
147
  ## Recipes
189
148
 
190
- ### Split view
191
-
192
- React:
193
-
194
- ```js
195
- <ConnectyCubeChatWidget
196
- ...
197
- splitView={true}
198
- />
199
- ```
200
-
201
- Vanilla JS:
202
-
203
- ```js
204
- const props = {
205
- ...
206
- splitView: true,
207
- };
208
- ```
209
-
210
- ### Single view
211
-
212
- React:
213
-
214
- ```js
215
- <ConnectyCubeChatWidget
216
- ...
217
- splitView={false}
218
- />
219
- ```
220
-
221
- Vanilla JS:
222
-
223
- ```js
224
- const props = {
225
- ...
226
- splitView: false,
227
- };
228
- ```
229
-
230
- ### Show online users tab
231
-
232
- React:
233
-
234
- ```js
235
- <ConnectyCubeChatWidget
236
- ...
237
- showOnlineUsersTab={true}
238
- />
239
- ```
240
-
241
- Vanilla JS:
242
-
243
- ```js
244
- const props = {
245
- ...
246
- showOnlineUsersTab: true,
247
- };
248
- ```
249
-
250
- ### Display Chat button bottom left
251
-
252
- React:
253
-
254
- ```js
255
- <ConnectyCubeChatWidget
256
- ...
257
- buttonClassName={"left-2 right-auto"}
258
- portalClassName={"left-2 right-auto"}
259
- />
260
- ```
261
-
262
- Vanilla JS:
263
-
264
- ```js
265
- const props = {
266
- ...
267
- buttonClassName: "left-2 right-auto",
268
- portalClassName: "left-2 right-auto"
269
- };
270
- ```
149
+ See all available recipes https://developers.connectycube.com/js/chat-widget/#recipes
271
150
 
272
151
  ## Changelog
273
152