-
Notifications
You must be signed in to change notification settings - Fork 280
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### 🎯 Goal Restructure documentation following new structures of iOS and RN. TODO: - [ ] move certain content to proper places (both files and certain paragraphs/articles) - [x] We'll need to start using [`sidebars-react.json`](https://github.com/GetStream/stream-chat-swift/blob/develop/docusaurus/sidebars-ios.json) (iOS one for reference) as folder structure which looks like this: ![image](https://github.com/GetStream/stream-chat-react/assets/43254280/0a4fd24d-cc23-4dd9-9ee4-c6564ff9634d) generates a sidebar which looks like this: ![image](https://github.com/GetStream/stream-chat-react/assets/43254280/259f8ca2-40f1-4e09-926f-5ace7df93016) making <Message List> dropdown also a clickable link which navigates to the content - which is not what we want - and content id's are not respected. (notice size of carets in this one and font of "Attachment" is also different from others) ![image](https://github.com/GetStream/stream-chat-react/assets/43254280/082ea6ab-bca0-434b-8c44-26b7e75eac1b)
- Loading branch information
1 parent
e086565
commit 4620b24
Showing
294 changed files
with
18,999 additions
and
1,012 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+59.1 KB
docusaurus/docs/React/assets/reactions-list-and-reaction-selector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
id: overview | ||
slug: / | ||
title: Overview | ||
--- | ||
|
||
Building on top of the Stream Chat API, the Stream Chat React component library includes everything you need to build feature-rich and high-functioning chat user experiences out of the box. | ||
The library includes an extensive set of performant and customizable React components which allow you to get started quickly with little to no plumbing required. | ||
Use cases include team and social messaging, virtual events, livestream gaming, and customer support. The library supports: | ||
|
||
- Rich media messages | ||
- Reactions | ||
- Threads and quoted replies | ||
- Text input commands (ex: Giphy and @mentions) | ||
- Image and file uploads | ||
- Video playback | ||
- Read state and typing indicators | ||
- Channel and message lists | ||
|
||
## Where to get started | ||
|
||
If you are new to our SDK it is best to go through a of our [tutorial](https://getstream.io/chat/react-chat/tutorial/). | ||
|
||
After that, our [getting started page](./getting-started.mdx) is a great next step. | ||
|
||
:::tip | ||
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. | ||
::: | ||
|
||
## Architecture | ||
|
||
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. | ||
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. | ||
|
||
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. |
1 change: 0 additions & 1 deletion
1
docusaurus/docs/React/components/contexts/channel-action-context.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
--- | ||
id: channel_action_context | ||
sidebar_position: 3 | ||
title: ChannelActionContext | ||
--- | ||
|
||
|
Oops, something went wrong.