Skip to content

Commit 2cc3b70

Browse files
docs: merge v11 release guides and adjust links (#2189)
1 parent 8fd13e3 commit 2cc3b70

File tree

12 files changed

+544
-566
lines changed

12 files changed

+544
-566
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The [`Channel`](../components/core-components/channel.mdx) component is a React
125125
It provides five separate contexts to its children:
126126

127127
:::caution
128-
`EmojiContext` has been removed in version `11.0.0`, see related release guides (["Reactions 11.0.0"](../release-guides/reactions-v11.mdx), ["EmojiPicker 11.0.0"](../release-guides/emoji-picker-v11.mdx) and ["emojiSearchIndex 11.0.0"](../release-guides/emoji-search-index-v11.mdx)) to adjust your integration to this new change.
128+
`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.
129129
:::
130130

131131
- [`ChannelStateContext`](../components/contexts/channel-state-context.mdx) - stateful data (ex: `messages` or `members`)
@@ -182,7 +182,7 @@ The SDK is equipped with features designed to facilitate seamless integration, e
182182

183183
Starting from version `11.0.0`, these features are entirely optional, requiring integrators to opt-in manually. The decision was made in conjunction with enhanced architecture, aiming to reduce the overall size of the final bundles of our integrators.
184184

185-
Make sure to read ["EmojiPicker 11.0.0"](../release-guides/emoji-picker-v11.mdx) and ["emojiSearchIndex 11.0.0"](../release-guides/emoji-search-index-v11.mdx) release guides for more information.
185+
Make sure to read ["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) release guides for more information.
186186

187187
## Summary
188188

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: EmojiContext
55
---
66

77
:::caution
8-
`EmojiContext` has been removed in version `11.0.0`, see related release guides (["Reactions 11.0.0"](../release-guides/reactions-v11.mdx), ["EmojiPicker 11.0.0"](../release-guides/emoji-picker-v11.mdx) and ["emojiSearchIndex 11.0.0"](../release-guides/emoji-search-index-v11.mdx)) to adjust your integration to this new change.
8+
`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.
99
:::
1010

1111
The `EmojiContext` is established by the `Channel` component and exposes the `useEmojiContext` hook. This context holds

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

+11-11
Original file line numberDiff line numberDiff line change
@@ -183,30 +183,30 @@ Optional configuration parameters used for the initial channel query. Applied on
183183
In the example below, we specify, that the first page of messages when a channel is queried should have 20 messages (the default is 100). Note that the `channel` prop has to be passed along `channelQueryOptions`.
184184

185185
```tsx
186-
import {ChannelQueryOptions} from "stream-chat";
187-
import {Channel, useChatContext} from "stream-chat-react";
186+
import { ChannelQueryOptions } from 'stream-chat';
187+
import { Channel, useChatContext } from 'stream-chat-react';
188188

189189
const channelQueryOptions: ChannelQueryOptions = {
190190
messages: { limit: 20 },
191191
};
192192

193193
type ChannelRendererProps = {
194-
id: string;
195-
type: string;
194+
id: string;
195+
type: string;
196196
};
197197

198-
const ChannelRenderer = ({id, type}: ChannelRendererProps) => {
198+
const ChannelRenderer = ({ id, type }: ChannelRendererProps) => {
199199
const { client } = useChatContext();
200200
return (
201201
<Channel channel={client.channel(type, id)} channelQueryOptions={channelQueryOptions}>
202202
{/* Channel children */}
203203
</Channel>
204204
);
205-
}
205+
};
206206
```
207207

208208
| Type |
209-
|-----------------------|
209+
| --------------------- |
210210
| `ChannelQueryOptions` |
211211

212212
### CooldownTimer
@@ -229,8 +229,8 @@ Custom UI component for date separators.
229229

230230
Custom action handler to override the default `client.deleteMessage(message.id)` function.
231231

232-
| Type |
233-
|---------------------------------------------------------------------------------------------------------------------------|
232+
| Type |
233+
| ---------------------------------------------------------------------------------------------- |
234234
| `(message: StreamMessage<StreamChatGenerics>) => Promise<MessageResponse<StreamChatGenerics>>` |
235235

236236
The function can execute different logic for message replies compared to messages in the main message list based on the `parent_id` property of `StreamMessage` object:
@@ -330,15 +330,15 @@ Custom search mechanism class to override default `NimbleEmojiIndex` class from
330330

331331
### emojiSearchIndex (available since `11.0.0`)
332332

333-
Custom search mechanism instance or object to enable emoji autocomplete. See ["emojiSearchIndex 11.0.0"](../../release-guides/emoji-search-index-v11.mdx) release guide for more information.
333+
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.
334334

335335
| Type | Default |
336336
| ------ | --------- |
337337
| object | undefined |
338338

339339
### EmojiPicker (changed in `11.0.0`)
340340

341-
Custom UI component to override default `NimblePicker` from `emoji-mart`. Markup structure changed in `11.0.0`, see ["EmojiPicker 11.0.0"](../../release-guides/emoji-picker-v11.mdx) release guide for more information.
341+
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.
342342

343343
| Version | Type | Default |
344344
| ------- | --------- | -------------------------------------------------------------------------------------------------------- |

docusaurus/docs/React/components/message-components/reactions.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Reactions
77
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';
88

99
:::caution
10-
If you're moving from older versions to `11.0.0` then make sure to read ["Reactions 11.0.0"](../../release-guides/reactions-v11.mdx) release guide to help you transition to the new implementation.
10+
If you're moving from older versions to `11.0.0` then make sure to read ["Introducing new reactions"](../../release-guides/upgrade-to-v11.mdx#introducing-new-reactions) release guide to help you transition to the new implementation.
1111
:::
1212

1313
The Stream Chat API provides built-in support for adding reactions to messages. The component library provides three default components to enable reaction selection and display:

docusaurus/docs/React/guides/customization/emoji-picker.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Emoji Picker
77
import CustomEmojiPicker from '../../assets/CustomEmojiPicker.png';
88

99
:::caution
10-
Note that this guide is for versions lower than `11.0.0`, the new API has slightly changed. See the ["EmojiPicker 11.0.0"](../../release-guides/emoji-picker-v11.mdx) release guide to help you transition smoothly to the new API.
10+
Note that this guide is for versions lower than `11.0.0`, the new API has slightly changed. See the ["Dropping support for built-in `EmojiPicker`"](../../release-guides/upgrade-to-v11.mdx#dropping-support-for-built-in-emojipicker) release guide to help you transition smoothly to the new API.
1111
:::
1212

1313
In this example, we will demonstrate how to create a custom Emoji Picker component that can be used in the `MessageInput`. This component will replace the default [`EmojiPicker`](https://github.com/GetStream/stream-chat-react/blob/master/src/components/MessageInput/EmojiPicker.tsx) with only breakfast food emojis.

docusaurus/docs/React/guides/theming/reactions.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import CustomReactionSelector from '../../assets/CustomReactionSelector.png';
88
import CustomReactionsList from '../../assets/CustomReactionsList.png';
99

1010
:::caution
11-
If you're moving from older versions to `11.0.0` then make sure to read ["Reactions 11.0.0"](../../release-guides/reactions-v11.mdx) release guide to help you transition to the new implementation.
11+
If you're moving from older versions to `11.0.0` then make sure to read ["Introducing new reactions"](../../release-guides/upgrade-to-v11.mdx#introducing-new-reactions) release guide to help you transition to the new implementation.
1212
:::
1313

1414
In this example, we will demonstrate how to override the library's default reaction set, which can be found stored as the

docusaurus/docs/React/release-guides/emoji-picker-v11.mdx

-84
This file was deleted.

docusaurus/docs/React/release-guides/emoji-search-index-v11.mdx

-138
This file was deleted.

0 commit comments

Comments
 (0)