Skip to content

Commit

Permalink
Merge component folders
Browse files Browse the repository at this point in the history
  • Loading branch information
arnautov-anton committed Feb 1, 2024
1 parent 76f7e20 commit 020a878
Show file tree
Hide file tree
Showing 35 changed files with 51 additions and 46 deletions.
4 changes: 0 additions & 4 deletions docusaurus/docs/React/core-components/_category_.json

This file was deleted.

4 changes: 2 additions & 2 deletions docusaurus/docs/React/ui-components/attachment.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: attachments
title: Attachments
id: attachment
title: Attachment
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Channel List"
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: ChannelList

import CodeBlock from '@theme/CodeBlock';

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

The `ChannelList` component queries an array of `channel` objects from the Stream Chat API and displays as a customizable list
in the UI. It accepts props for [`filters`](#filters), [`sort`](#sort) and [`options`](#options), which allows you to tailor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: channel-preview-ui
title: ChannelPreview UI
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

The ChannelPreview UI component receives props via the [`ChannelPreview`](./channel-preview.mdx) wrapper, and
these props are a combination of the `ChannelPreview` props with additional UI specific items. The wrapper also handles the required logic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: channel-preview
title: ChannelPreview
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

The `ChannelPreview` component is a wrapper component that handles the logic and functionality for a provided (or the default) channel preview and ultimately dictates the display via the component's `Preview` prop.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ title: ChannelSearch

import ImageShowcase from '@site/src/components/ImageShowcase';

import GHComponentLink from '../_docusaurus-components/GHComponentLink';

import ImageInactiveSearchBarNoAppMenu from '../assets/inactive-searchbar-no-app-menu.png';
import ImageInactiveSearchBarWithAppMenu from '../assets/inactive-searchbar-with-app-menu.png';
import ImageActiveSearchBarNoText from '../assets/active-searchbar-no-text.png';
import ImageActiveSearchBarWithText from '../assets/active-searchbar-with-text.png';
import ImageSearchResultsInlineThemeV2 from '../assets/search-results-inline-theme-v2.png';
import ImageSearchResultsPopupThemeV2 from '../assets/search-results-popup-theme-v2.png';
import ImageSearchResultsInlineThemeV1 from '../assets/search-results-inline-theme-v1.png';
import ImageSearchResultsPopupThemeV1 from '../assets/search-results-popup-theme-v1.png';
import ImageSearchResultsLoadingThemeV2 from '../assets/search-results-loading-theme-v2.png';
import ImageSearchResultsLoadingThemeV1 from '../assets/search-results-loading-theme-v1.png';
import ImageSearchResultsEmptyThemeV2 from '../assets/search-results-empty-theme-v2.png';
import ImageSearchResultsEmptyThemeV1 from '../assets/search-results-empty-theme-v1.png';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

import ImageInactiveSearchBarNoAppMenu from '../../assets/inactive-searchbar-no-app-menu.png';
import ImageInactiveSearchBarWithAppMenu from '../../assets/inactive-searchbar-with-app-menu.png';
import ImageActiveSearchBarNoText from '../../assets/active-searchbar-no-text.png';
import ImageActiveSearchBarWithText from '../../assets/active-searchbar-with-text.png';
import ImageSearchResultsInlineThemeV2 from '../../assets/search-results-inline-theme-v2.png';
import ImageSearchResultsPopupThemeV2 from '../../assets/search-results-popup-theme-v2.png';
import ImageSearchResultsInlineThemeV1 from '../../assets/search-results-inline-theme-v1.png';
import ImageSearchResultsPopupThemeV1 from '../../assets/search-results-popup-theme-v1.png';
import ImageSearchResultsLoadingThemeV2 from '../../assets/search-results-loading-theme-v2.png';
import ImageSearchResultsLoadingThemeV1 from '../../assets/search-results-loading-theme-v1.png';
import ImageSearchResultsEmptyThemeV2 from '../../assets/search-results-empty-theme-v2.png';
import ImageSearchResultsEmptyThemeV1 from '../../assets/search-results-empty-theme-v1.png';

`ChannelSearch` is a UI component that searches for chat users and displays the results in a list. It can be used standalone or in the `ChannelList` via the `showChannelSearch` prop (default is false).
The input searches for users by default, but you can utilize the `searchForChannels` prop to also search for `channels`. Completely override the querying via the `searchFunction` prop.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Message Input"
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: input-ui
title: Input UI
---

The Input UI component consumes the [`MessageInputContext`](../contexts/message-input-context.mdx) and handles the display and functionality
The Input UI component consumes the [`MessageInputContext`](../../contexts/message-input-context.mdx) and handles the display and functionality
for the message input in a channel. The Input UI component is typically a combination of subcomponents that each consume
context and are responsible for one aspect of the message input (ex: text input or emoji picker).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: MessageInput
---

The `MessageInput` component is a React Context provider that wraps all of the logic, functionality, and UI for the message input
displayed in a channel. It provides the [`MessageInputContext`](../contexts/message-input-context.mdx) to its children. All of
displayed in a channel. It provides the [`MessageInputContext`](../../contexts/message-input-context.mdx) to its children. All of
the input UI components consume the `MessageInputContext` and rely on the stored data for their display and interaction.

## Basic Usage
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Message List"
}
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
id: message_list
id: message-list
sidebar_position: 5
slug: '/ui-components/message-list/message-list/'
title: MessageList
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

import MessageActionsBoxWithCustomAction from '../assets/message-actions-box-custom-actions.png';
import MessageActionsBoxWithCustomAction from '../../assets/message-actions-box-custom-actions.png';

The `MessageList` component renders a scrollable list of messages. The UI for each individual message is rendered
conditionally based on its `message.type` value. The list renders date separators, message reactions, new message notifications, system
Expand All @@ -21,8 +22,8 @@ const { messages } = useChannelStateContext();
```

The `MessageList` has no required props and by default pulls overridable data from the various contexts established
in the [`Channel`](./channel.mdx) component. Customization of the messages rendered within the list is handled by
the [Message UI](../ui/message-components/message-ui.mdx) component.
in the [`Channel`](../channel.mdx) component. Customization of the messages rendered within the list is handled by
the [Message UI](../message/message-ui.mdx) component.

## Basic Usage

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: virtualized_list
id: virtualized-message-list
sidebar_position: 6
title: VirtualizedMessageList
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

The `VirtualizedMessageList` component renders a scrollable list of messages. It differs from the standard `MessageList`
in that it handles UI virtualization by default. Virtualization is a technique used to emulate large lists of elements by
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/React/ui-components/message/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Message"
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: message-ui-components
title: Message UI Components
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

As described in the [Message UI](./message-ui.mdx) section, our default <GHComponentLink text='MessageSimple' path='/Message/MessageSimple.tsx'/> component is a combination of various UI subcomponents. We export all the building blocks of `MessageSimple`, so a custom Message UI
component can be built in a similar way. Check out the [Message UI Customization](../../theming/v1/message-ui.mdx) section for an example.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ id: message-ui
title: Message UI
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

import MessageActionsBoxWithCustomAction from '../assets/message-actions-box-custom-actions.png';
import MessageActionsBoxWithCustomAction from '../../assets/message-actions-box-custom-actions.png';

The Message UI component consumes the [`MessageContext`](../../contexts/message-context.mdx) and handles the display and functionality
for an individual message in a message list. The Message UI component is typically a combination of subcomponents that each consume
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ id: message
title: Message
---

import GHComponentLink from '../_docusaurus-components/GHComponentLink';
import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

import MessageActionsBoxWithCustomAction from '../assets/message-actions-box-custom-actions.png';
import MessageActionsBoxWithCustomAction from '../../assets/message-actions-box-custom-actions.png';

The `Message` component is a React Context provider that wraps all the logic, functionality, and UI for the individual messages
displayed in a message list. It provides the [`MessageContext`](../contexts/message-context.mdx) to its children. All the message UI components consume the `MessageContext` and rely on the stored data for their display and interaction.
displayed in a message list. It provides the [`MessageContext`](../../contexts/message-context.mdx) to its children. All the message UI components consume the `MessageContext` and rely on the stored data for their display and interaction.

:::note
The majority of Stream Chat use cases will not need to use the `Message` component directly. We've documented it here for reference,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: overview-core
sidebar_position: 1
slug: /core-components/
slug: /ui-components/
title: Important Notice
---

Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/React/ui-cookbook/attachment/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Attachment"
}
3 changes: 0 additions & 3 deletions docusaurus/docs/React/ui-cookbook/attachments/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docusaurus/docs/React/utility-components/_category_.json

This file was deleted.

0 comments on commit 020a878

Please sign in to comment.