Skip to content

Commit 5cda596

Browse files
authored
Merge pull request #1491 from GetStream/steve/docs-deprecation
docs: links all docs links to new documentation
2 parents e47b05d + 8dffb8e commit 5cda596

File tree

8 files changed

+32
-32
lines changed

8 files changed

+32
-32
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Besides, our team maintains a dedicated repository for fully-fledged sample appl
6161

6262
2. Minor releases may come with some breaking changes, so always check the release notes before upgrading the minor version.
6363

64-
You can see detailed documentation about the components at <https://getstream.github.io/stream-chat-react-native>
64+
You can see detailed documentation about the components at <https://getstream.io/chat/docs/sdk/reactnative/>
6565

6666
## 👏 Contributing
6767

package/src/components/ChannelList/ChannelList.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export type ChannelListProps<
7171
/**
7272
* Custom UI component to display the list of channels
7373
*
74-
* Default: [ChannelListMessenger](https://getstream.github.io/stream-chat-react-native/v3/#channellistmessenger)
74+
* Default: [ChannelListMessenger](https://getstream.io/chat/docs/sdk/reactnative/ui-components/channel-list-messenger/)
7575
*/
7676
List?: React.ComponentType<ChannelListMessengerProps<StreamChatGenerics>>;
7777
/**

package/src/components/MessageInput/MessageInput.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -708,11 +708,11 @@ export type MessageInputProps<
708708
/**
709709
* UI Component for message input
710710
* It's a consumer of
711-
* [Channel Context](https://getstream.github.io/stream-chat-react-native/v3/#channelcontext),
712-
* [Chat Context](https://getstream.github.io/stream-chat-react-native/v3/#chatcontext),
713-
* [MessageInput Context](https://getstream.github.io/stream-chat-react-native/v3/#messageinputcontext),
714-
* [Suggestions Context](https://getstream.github.io/stream-chat-react-native/v3/#suggestionscontext), and
715-
* [Translation Context](https://getstream.github.io/stream-chat-react-native/v3/#translationcontext)
711+
* [Channel Context](https://getstream.io/chat/docs/sdk/reactnative/contexts/channel-context/),
712+
* [Chat Context](https://getstream.io/chat/docs/sdk/reactnative/contexts/chat-context/),
713+
* [MessageInput Context](https://getstream.io/chat/docs/sdk/reactnative/contexts/message-input-context/),
714+
* [Suggestions Context](https://getstream.io/chat/docs/sdk/reactnative/contexts/suggestions-context/), and
715+
* [Translation Context](https://getstream.io/chat/docs/sdk/reactnative/contexts/translation-context/)
716716
*/
717717
export const MessageInput = <
718718
StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,

package/src/components/MessageList/MessageList.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -212,11 +212,11 @@ type MessageListPropsWithContext<
212212
/**
213213
* The message list component renders a list of messages. It consumes the following contexts:
214214
*
215-
* [ChannelContext](https://getstream.github.io/stream-chat-react-native/v3/#channelcontext)
216-
* [ChatContext](https://getstream.github.io/stream-chat-react-native/v3/#chatcontext)
217-
* [MessagesContext](https://getstream.github.io/stream-chat-react-native/v3/#messagescontext)
218-
* [ThreadContext](https://getstream.github.io/stream-chat-react-native/v3/#threadcontext)
219-
* [TranslationContext](https://getstream.github.io/stream-chat-react-native/v3/#translationcontext)
215+
* [ChannelContext](https://getstream.io/chat/docs/sdk/reactnative/contexts/channel-context/)
216+
* [ChatContext](https://getstream.io/chat/docs/sdk/reactnative/contexts/chat-context/)
217+
* [MessagesContext](https://getstream.io/chat/docs/sdk/reactnative/contexts/messages-context/)
218+
* [ThreadContext](https://getstream.io/chat/docs/sdk/reactnative/contexts/thread-context/)
219+
* [TranslationContext](https://getstream.io/chat/docs/sdk/reactnative/contexts/translation-context/)
220220
*/
221221
const MessageListWithContext = <
222222
StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,

package/src/components/Thread/Thread.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ type ThreadPropsWithContext<
2727
> & {
2828
/**
2929
* Additional props for underlying MessageInput component.
30-
* Available props - https://getstream.github.io/stream-chat-react-native/v3/#messageinput
30+
* Available props - https://getstream.io/chat/docs/sdk/reactnative/ui-components/message-input/#props
3131
* */
3232
additionalMessageInputProps?: Partial<MessageInputProps<StreamChatGenerics>>;
3333
/**
3434
* Additional props for underlying MessageList component.
35-
* Available props - https://getstream.github.io/stream-chat-react-native/v3/#messagelist
35+
* Available props - https://getstream.io/chat/docs/sdk/reactnative/ui-components/message-list/#props
3636
* */
3737
additionalMessageListProps?: Partial<MessageListProps<StreamChatGenerics>>;
3838
/** Make input focus on mounting thread */
@@ -43,7 +43,7 @@ type ThreadPropsWithContext<
4343
disabled?: boolean;
4444
/**
4545
* **Customized MessageInput component to used within Thread instead of default MessageInput
46-
* **Available from [MessageInput](https://getstream.github.io/stream-chat-react-native/v3/#messageinput)**
46+
* **Available from [MessageInput](https://getstream.io/chat/docs/sdk/reactnative/ui-components/message-input)**
4747
*/
4848
MessageInput?: React.ComponentType<MessageInputProps<StreamChatGenerics>>;
4949
/**
@@ -119,7 +119,7 @@ export type ThreadProps<
119119
* Thread - The Thread renders a parent message with a list of replies. Use the standard message list of the main channel's messages.
120120
* The thread is only used for the list of replies to a message.
121121
*
122-
* Thread is a consumer of [channel context](https://getstream.github.io/stream-chat-react-native/v3/#channelcontext)
122+
* Thread is a consumer of [channel context](https://getstream.io/chat/docs/sdk/reactnative/contexts/channel-context/)
123123
* Underlying MessageList, MessageInput and Message components can be customized using props:
124124
* - additionalMessageListProps
125125
* - additionalMessageInputProps

package/src/contexts/channelsContext/ChannelsContext.tsx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ export type ChannelsContextValue<
5252
/**
5353
* Custom indicator to use when channel list is empty
5454
*
55-
* Default: [EmptyStateIndicator](https://getstream.github.io/stream-chat-react-native/v3/#emptystateindicator)
55+
* Default: [EmptyStateIndicator](https://getstream.io/chat/docs/sdk/reactnative/core-components/channel/#emptystateindicator)
5656
* */
5757
EmptyStateIndicator: React.ComponentType<EmptyStateProps>;
5858
/**
5959
* Custom loading indicator to display at bottom of the list, while loading further pages
6060
*
61-
* Default: [ChannelListFooterLoadingIndicator](https://getstream.github.io/stream-chat-react-native/v3/#ChannelListFooterLoadingIndicator)
61+
* Default: [ChannelListFooterLoadingIndicator](https://getstream.io/chat/docs/sdk/reactnative/contexts/channels-context/#footerloadingindicator)
6262
*/
6363
FooterLoadingIndicator: React.ComponentType;
6464
/**
@@ -72,13 +72,13 @@ export type ChannelsContextValue<
7272
/**
7373
* Custom indicator to display error at top of list, if loading/pagination error occurs
7474
*
75-
* Default: [ChannelListHeaderErrorIndicator](https://getstream.github.io/stream-chat-react-native/v3/#ChannelListHeaderErrorIndicator)
75+
* Default: [ChannelListHeaderErrorIndicator](https://getstream.io/chat/docs/sdk/reactnative/contexts/channels-context/#headererrorindicator)
7676
*/
7777
HeaderErrorIndicator: React.ComponentType<HeaderErrorProps>;
7878
/**
7979
* Custom indicator to display network-down error at top of list, if there is connectivity issue
8080
*
81-
* Default: [ChannelListHeaderNetworkDownIndicator](https://getstream.github.io/stream-chat-react-native/v3/#ChannelListHeaderNetworkDownIndicator)
81+
* Default: [ChannelListHeaderNetworkDownIndicator](https://getstream.io/chat/docs/sdk/reactnative/contexts/channels-context/#headernetworkdownindicator)
8282
*/
8383
HeaderNetworkDownIndicator: React.ComponentType;
8484
/**
@@ -88,7 +88,7 @@ export type ChannelsContextValue<
8888
/**
8989
* Custom indicator to use when there is error in fetching channels
9090
*
91-
* Default: [LoadingErrorIndicator](https://getstream.github.io/stream-chat-react-native/v3/#loadingerrorindicator)
91+
* Default: [LoadingErrorIndicator](https://getstream.io/chat/docs/sdk/reactnative/contexts/channels-context/#loadingerrorindicator)
9292
* */
9393
LoadingErrorIndicator: React.ComponentType<LoadingErrorProps>;
9494
/**
@@ -120,7 +120,7 @@ export type ChannelsContextValue<
120120
/**
121121
* Custom UI component to display individual channel list items
122122
*
123-
* Default: [ChannelPreviewMessenger](https://getstream.github.io/stream-chat-react-native/v3/#channelpreviewmessenger)
123+
* Default: [ChannelPreviewMessenger](https://getstream.io/chat/docs/sdk/reactnative/ui-components/channel-preview-messenger/)
124124
*/
125125
Preview: React.ComponentType<ChannelPreviewMessengerProps<StreamChatGenerics>>;
126126
/**
@@ -158,7 +158,7 @@ export type ChannelsContextValue<
158158
/**
159159
* Custom UI component to display loading channel skeletons
160160
*
161-
* Default: [Skeleton](https://getstream.github.io/stream-chat-react-native/v3/#skeleton)
161+
* Default: [Skeleton](https://getstream.io/chat/docs/sdk/reactnative/contexts/channels-context/#skeleton)
162162
*/
163163
Skeleton: React.ComponentType;
164164
/**

package/src/contexts/messageInputContext/MessageInputContext.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,15 @@ export type InputMessageInputContextValue<
216216
/**
217217
* Custom UI component for attach button.
218218
*
219-
* Defaults to and accepts same props as: [AttachButton](https://getstream.github.io/stream-chat-react-native/v3/#attachbutton)
219+
* Defaults to and accepts same props as: [AttachButton](https://getstream.io/chat/docs/sdk/reactnative/ui-components/attach-button/)
220220
*/
221221
AttachButton: React.ComponentType<AttachButtonProps<StreamChatGenerics>>;
222222
clearEditingState: () => void;
223223
clearQuotedMessageState: () => void;
224224
/**
225225
* Custom UI component for commands button.
226226
*
227-
* Defaults to and accepts same props as: [CommandsButton](https://getstream.github.io/stream-chat-react-native/v3/#commandsbutton)
227+
* Defaults to and accepts same props as: [CommandsButton](https://getstream.io/chat/docs/sdk/reactnative/ui-components/commands-button/)
228228
*/
229229
CommandsButton: React.ComponentType<CommandsButtonProps<StreamChatGenerics>>;
230230
/**
@@ -263,7 +263,7 @@ export type InputMessageInputContextValue<
263263
/**
264264
* Custom UI component for more options button.
265265
*
266-
* Defaults to and accepts same props as: [MoreOptionsButton](https://getstream.github.io/stream-chat-react-native/v3/#moreoptionsbutton)
266+
* Defaults to and accepts same props as: [MoreOptionsButton](https://getstream.io/chat/docs/sdk/reactnative/ui-components/more-options-button/)
267267
*/
268268
MoreOptionsButton: React.ComponentType<MoreOptionsButtonProps<StreamChatGenerics>>;
269269
/** Limit on the number of lines in the text input before scrolling */
@@ -272,7 +272,7 @@ export type InputMessageInputContextValue<
272272
/**
273273
* Custom UI component for send button.
274274
*
275-
* Defaults to and accepts same props as: [SendButton](https://getstream.github.io/stream-chat-react-native/v3/#sendbutton)
275+
* Defaults to and accepts same props as: [SendButton](https://getstream.io/chat/docs/sdk/reactnative/ui-components/send-button/)
276276
*/
277277
SendButton: React.ComponentType<SendButtonProps<StreamChatGenerics>>;
278278
sendImageAsync: boolean;

package/src/contexts/messagesContext/MessagesContext.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ export type MessagesContextValue<
179179
MessageStatus: React.ComponentType<MessageStatusProps<StreamChatGenerics>>;
180180
/**
181181
* UI component for MessageSystem
182-
* Defaults to: [MessageSystem](https://getstream.github.io/stream-chat-react-native/v3/#messagesystem)
182+
* Defaults to: [MessageSystem](https://getstream.io/chat/docs/sdk/reactnative/ui-components/message-system/)
183183
*/
184184
MessageSystem: React.ComponentType<MessageSystemProps<StreamChatGenerics>>;
185185
/**
@@ -194,7 +194,7 @@ export type MessagesContextValue<
194194
removeMessage: (message: { id: string; parent_id?: string }) => void;
195195
/**
196196
* UI component for Reply
197-
* Defaults to: [Reply](https://getstream.github.io/stream-chat-react-native/v3/#reply)
197+
* Defaults to: [Reply](https://getstream.io/chat/docs/sdk/reactnative/ui-components/reply/)
198198
*/
199199
Reply: React.ComponentType<ReplyProps<StreamChatGenerics>>;
200200
/**
@@ -203,20 +203,20 @@ export type MessagesContextValue<
203203
retrySendMessage: (message: MessageResponse<StreamChatGenerics>) => Promise<void>;
204204
/**
205205
* UI component for ScrollToBottomButton
206-
* Defaults to: [ScrollToBottomButton](https://getstream.github.io/stream-chat-react-native/v3/#ScrollToBottomButton)
206+
* Defaults to: [ScrollToBottomButton](https://getstream.io/chat/docs/sdk/reactnative/ui-components/scroll-to-bottom-button/)
207207
*/
208208
ScrollToBottomButton: React.ComponentType<ScrollToBottomButtonProps>;
209209
setEditingState: (message: MessageType<StreamChatGenerics>) => void;
210210
setQuotedMessageState: (message: MessageType<StreamChatGenerics>) => void;
211211
supportedReactions: ReactionData[];
212212
/**
213213
* UI component for TypingIndicator
214-
* Defaults to: [TypingIndicator](https://getstream.github.io/stream-chat-react-native/v3/#typingindicator)
214+
* Defaults to: [TypingIndicator](https://getstream.io/chat/docs/sdk/reactnative/ui-components/typing-indicator/)
215215
*/
216216
TypingIndicator: React.ComponentType;
217217
/**
218218
* UI component for TypingIndicatorContainer
219-
* Defaults to: [TypingIndicatorContainer](https://getstream.github.io/stream-chat-react-native/v3/#typingindicatorcontainer)
219+
* Defaults to: [TypingIndicatorContainer](https://getstream.io/chat/docs/sdk/reactnative/contexts/messages-context/#typingindicatorcontainer)
220220
*/
221221
TypingIndicatorContainer: React.ComponentType;
222222
updateMessage: (

0 commit comments

Comments
 (0)