Skip to content

Commit 0274653

Browse files
Channel and Theming adjustments
1 parent ff83826 commit 0274653

File tree

11 files changed

+20
-1085
lines changed

11 files changed

+20
-1085
lines changed

docusaurus/docs/React/basics/getting-started.mdx

+1-6
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,9 @@ const { client } = useChatContext();
123123
The [`Channel`](../components/core-components/channel.mdx) component is a React Context provider that wraps all of the logic, functionality, and UI for an individual chat channel.
124124
It provides five separate contexts to its children:
125125

126-
:::caution
127-
`EmojiContext` has been removed in version `11.0.0`, see related release guides ([Introducing new reactions](../release-guides/upgrade-to-v11.mdx#introducing-new-reactions), [Dropping support for built-in `EmojiPicker`](../release-guides/upgrade-to-v11.mdx#dropping-support-for-built-in-emojipicker) and [Dropping support for built-in `EmojiIndex`](../release-guides/upgrade-to-v11.mdx#dropping-support-for-built-in-emojiindex)) to adjust your integration to this new change.
128-
:::
129-
130126
- [`ChannelStateContext`](../components/contexts/channel-state-context.mdx) - stateful data (ex: `messages` or `members`)
131127
- [`ChannelActionContext`](../components/contexts/channel-action-context.mdx) - action handlers (ex: `sendMessage` or `openThread`)
132128
- [`ComponentContext`](../components/contexts/component-context.mdx) - custom component UI overrides (ex: `Avatar` or `Message`)
133-
- [`EmojiContext`](../components/contexts/emoji-context.mdx) - emoji UI components and data (ex: `EmojiPicker` or `emojiConfig`) - removed in `11.0.0`
134129
- [`TypingContext`](../components/contexts/typing-context.mdx) - object of currently typing users (i.e., `typing`)
135130

136131
### ChannelList
@@ -188,7 +183,7 @@ Make sure to read ["Dropping support for built-in `EmojiPicker`"](../release-gui
188183
In addition to the above referenced UI components, client instantiation, and user connection, you need little other code to get a fully functioning chat application up and running. See below for an example of the complete code.
189184

190185
:::note
191-
Remember our [Theming](../guides/theming/overview.mdx) and [Customizing Components](../guides/customization/overview.mdx) sections in our guides. They offer you a lot of flexibility when adopting our SDK.
186+
Remember our [Theming](../theming/introduction.mdx) and [Customizing Components](../guides/customization/overview.mdx) sections in our guides. They offer you a lot of flexibility when adopting our SDK.
192187
:::
193188

194189
```tsx

docusaurus/docs/React/basics/overview.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ If you are new to our SDK it is best to go through a of our [tutorial](https://g
2424
After that, our [getting started page](./getting-started.mdx) is a great next step.
2525

2626
:::tip
27-
If you are integrating our SDK, please pay attention to our [Theming](../guides/theming/overview.mdx) and [Customizing Components](../guides/customization/overview.mdx) sections in our guides. We see that most of our users can get very far by utilizing the flexibility of our SDKs.
27+
If you are integrating our SDK, please pay attention to our [Theming](../theming/introduction.mdx) and [Customizing Components](../guides/customization/overview.mdx) sections in our guides. We see that most of our users can get very far by utilizing the flexibility of our SDKs.
2828
:::
2929

3030
## Architecture
3131

32-
A common pattern in the library is the use of context provider hooks (see [Contexts](./contexts/chat_context)). These custom hooks allow for effective value sharing between parent components and their children.
32+
A common pattern in the library is the use of context provider hooks. These custom hooks allow for effective value sharing between parent components and their children.
3333
This makes customization straightforward, as you can use our exported hooks in your custom components to receive the exact values needed, while also subscribing to context changes.
3434

35-
The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions below for adding the library to your React project.
35+
The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions below for adding the library to your React project.

docusaurus/docs/React/components/contexts/emoji-context.mdx

-53
This file was deleted.

docusaurus/docs/React/components/core-components/channel.mdx

+8-43
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ It provides five separate contexts to its children:
1111
- [`ChannelStateContext`](../contexts/channel-state-context.mdx) - stateful data (ex: `messages` or `members`)
1212
- [`ChannelActionContext`](../contexts/channel-action-context.mdx) - action handlers (ex: `sendMessage` or `openThread`)
1313
- [`ComponentContext`](../contexts/component-context.mdx) - custom component UI overrides (ex: `Avatar` or `Message`)
14-
- [`EmojiContext`](../contexts/emoji-context.mdx) - emoji UI components and data (ex: `EmojiPicker` or `emojiConfig`)
1514
- [`TypingContext`](../contexts/typing-context.mdx) - object of currently typing users (i.e., `typing`)
1615

1716
:::note
@@ -259,9 +258,8 @@ const App = () => (
259258

260259
Custom action handler to override the default `channel.markRead` request function (advanced usage only). The function takes two arguments:
261260

262-
263261
| Argument | Type | Description |
264-
|---------------------------|-----------------------------------------|---------------------------------------------------------------------------------------------------------|
262+
| ------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------- |
265263
| `channel` | `Channel` | The current channel object instance |
266264
| `setChannelUnreadUiState` | `(state: ChannelUnreadUiState) => void` | Function that allows us to set the unread state for the components reflecting the unread message state. |
267265

@@ -301,54 +299,21 @@ Custom UI component to override default edit message input.
301299
| --------- | ---------------------------------------------------------------------------------- |
302300
| component | <GHComponentLink text='EditMessageForm' path='/MessageInput/EditMessageForm.tsx'/> |
303301

304-
### Emoji (removed in `11.0.0`)
305-
306-
Custom UI component to override default `NimbleEmoji` from `emoji-mart`.
307-
308-
| Type |
309-
| --------- |
310-
| component |
311-
312-
### emojiData (removed in `11.0.0`)
313-
314-
Custom prop to override default `facebook.json` emoji data set from `emoji-mart`.
315-
316-
| Type |
317-
| ------ |
318-
| object |
319-
320-
### EmojiIcon (removed in `11.0.0`)
321-
322-
Custom UI component for emoji button in input.
323-
324-
| Type | Default |
325-
| --------- | ----------------------------------------------------------------------- |
326-
| component | <GHComponentLink text='EmojiIconSmall' path='/MessageInput/icons.tsx'/> |
327-
328-
### EmojiIndex (removed in `11.0.0`)
329-
330-
Custom search mechanism class to override default `NimbleEmojiIndex` class from `emoji-mart`.
331-
332-
| Type | Default |
333-
| ----- | ----------------------------------------------------------------------------------------------------------------- |
334-
| class | [NimbleEmojiIndex](https://github.com/missive/emoji-mart/blob/v3.0.1/src/utils/emoji-index/nimble-emoji-index.js) |
335-
336-
### emojiSearchIndex (available since `11.0.0`)
302+
### emojiSearchIndex
337303

338-
Custom search mechanism instance or object to enable emoji autocomplete. See ["Dropping support for built-in `EmojiIndex`"](../../release-guides/upgrade-to-v11.mdx#dropping-support-for-built-in-emojiindex) release guide for more information.
304+
Custom search mechanism instance or object to enable emoji autocomplete.
339305

340306
| Type | Default |
341307
| ------ | --------- |
342308
| object | undefined |
343309

344-
### EmojiPicker (changed in `11.0.0`)
310+
### EmojiPicker
345311

346-
Custom UI component to override default `NimblePicker` from `emoji-mart`. Markup structure changed in `11.0.0`, see ["Dropping support for built-in `EmojiPicker`"](../../release-guides/upgrade-to-v11.mdx#dropping-support-for-built-in-emojipicker) release guide for more information.
312+
Custom UI component to be rendered in the `MessageInput` component, see [Emoji Picker guide](../../guides/customization/emoji-picker.mdx) for more information.
347313

348-
| Version | Type | Default |
349-
| ------- | --------- | -------------------------------------------------------------------------------------------------------- |
350-
| >=4.0.0 | component | [NimblePicker](https://github.com/missive/emoji-mart/blob/v3.0.1/src/components/picker/nimble-picker.js) |
351-
| ^11.0.0 | component | undefined |
314+
| Type | Default |
315+
| --------- | --------- |
316+
| component | undefined |
352317

353318
### EmptyPlaceholder
354319

docusaurus/docs/React/components/core-components/overview.mdx

-6
This file was deleted.

0 commit comments

Comments
 (0)