Docs: reorganize sidebar docs + fix broken links (#1369)

* reorganize sidebar docs

* fix broken links

* tweaks
This commit is contained in:
Sacha Arbonel
2022-10-31 15:05:30 +01:00
committed by GitHub
parent 5669841a32
commit 5267c0193e
66 changed files with 110 additions and 110 deletions
@@ -0,0 +1,3 @@
{
"label": "Basics"
}
@@ -1,9 +1,11 @@
--- ---
id: choose_package id: choose_package
sidebar_position: 2 sidebar_position: 2
title: Choosing The Right Flutter Package title: Choosing The Right SDK
--- ---
Choosing The Right Flutter Package
### Why the SDK is split into different packages ### Why the SDK is split into different packages
Different applications need different levels of customization and integration with the Stream Chat SDK. Different applications need different levels of customization and integration with the Stream Chat SDK.
@@ -2,9 +2,9 @@
slug: / slug: /
id: introduction id: introduction
sidebar_position: 1 sidebar_position: 1
title: About The Flutter SDK title: Overview
--- ---
Exploring The Basics Of Stream Chat About The Flutter SDK
![](../assets/sdk_title.png) ![](../assets/sdk_title.png)
@@ -1,10 +1,9 @@
--- ---
id: customize_message_widget id: customize_message_widget
sidebar_position: 11 title: Message
title: Customizing The StreamMessageWidget
--- ---
Customizing Text Messages Customizing Text Messages with the StreamMessageWidget
### Introduction ### Introduction
@@ -63,7 +62,7 @@ StreamChatThemeData(
) )
``` ```
![](../assets/message_theming.png) ![](../../assets/message_theming.png)
#### Change message text style #### Change message text style
@@ -79,7 +78,7 @@ StreamMessageThemeData(
) )
``` ```
![](../assets/message_styles.png) ![](../../assets/message_styles.png)
#### Change avatar theme #### Change avatar theme
@@ -93,7 +92,7 @@ StreamMessageThemeData(
) )
``` ```
![](../assets/message_rounded_avatar.png) ![](../../assets/message_rounded_avatar.png)
#### Changing Reaction theme #### Changing Reaction theme
@@ -107,7 +106,7 @@ StreamMessageThemeData(
), ),
``` ```
![](../assets/message_reaction_theming.png) ![](../../assets/message_reaction_theming.png)
### Changing Message Actions ### Changing Message Actions
@@ -133,7 +132,7 @@ StreamMessageWidget(
), ),
``` ```
![](../assets/message_widget_actions.png) ![](../../assets/message_widget_actions.png)
### Building attachments ### Building attachments
@@ -1,7 +1,6 @@
--- ---
id: customize_text_messages id: customize_text_messages
sidebar_position: 6 title: Message List View
title: Customize Text Messages
--- ---
Customizing Text Messages Customizing Text Messages
@@ -155,4 +154,4 @@ We can replace the hashtags using RegEx and add links for the MarkdownBody which
`_replaceHashtags()` function. `_replaceHashtags()` function.
Inside the textBuilder, we use the `flutter_markdown` package to build our hashtags as links. Inside the textBuilder, we use the `flutter_markdown` package to build our hashtags as links.
![](../assets/hashtag_example.jpg) ![](../../assets/hashtag_example.jpg)
@@ -1,7 +1,6 @@
--- ---
id: customize_message_actions id: customize_message_actions
sidebar_position: 8 title: Message Actions
title: Customize Message Actions
--- ---
Customizing Message Actions Customizing Message Actions
@@ -10,7 +9,7 @@ Customizing Message Actions
Message actions pop up in message overlay, when you long-press a message. Message actions pop up in message overlay, when you long-press a message.
![](../assets/message_actions.jpg) ![](../../assets/message_actions.jpg)
We have provided granular control over these actions. We have provided granular control over these actions.
@@ -1,7 +1,6 @@
--- ---
id: adding_custom_attachments id: adding_custom_attachments
sidebar_position: 3 title: Attachments
title: Adding Custom Attachments
--- ---
Adding Your Own Types Of Attachments To A Message Adding Your Own Types Of Attachments To A Message
@@ -25,7 +24,7 @@ To do this, let's check out an example to add location sharing to Stream Chat.
Let's build an example of location sharing option in the app: Let's build an example of location sharing option in the app:
![](../assets/location_sharing_example.jpg) ![](../../assets/location_sharing_example.jpg)
* Show a "Share Location" button next to StreamMessageInput Textfield. * Show a "Share Location" button next to StreamMessageInput Textfield.
@@ -174,7 +173,7 @@ StreamMessageListView(
This gives us the final location attachment: This gives us the final location attachment:
![](../assets/location_sharing_example_message.jpg) ![](../../assets/location_sharing_example_message.jpg)
Additionally, you can also add a thumbnail if a message has a location attachment (unlike in this case, where we sent the message directly). Additionally, you can also add a thumbnail if a message has a location attachment (unlike in this case, where we sent the message directly).
@@ -264,4 +263,4 @@ StreamMessageInput(
And we can see the thumbnails in the StreamMessageInput: And we can see the thumbnails in the StreamMessageInput:
![](../assets/location_sharing_example_message_thumbnail.jpg) ![](../../assets/location_sharing_example_message_thumbnail.jpg)
@@ -1,6 +1,6 @@
--- ---
id: customize_attachment_picker_modal id: customize_attachment_picker_modal
title: Customizing the Attachment Picker Modal title: Attachment Picker Modal
--- ---
Customizing the Attachment Picker Modal Customizing the Attachment Picker Modal
@@ -8,7 +8,7 @@ Customizing the Attachment Picker Modal
### Introduction ### Introduction
The Attachment Picker is a modal that allows users to select attachments from their device. The Attachment Picker is a modal that allows users to select attachments from their device.
It is generally used when a user taps the attachment button in the [StreamMessageInput](../stream_chat_flutter/message_input.mdx). It is generally used when a user taps the attachment button in the [StreamMessageInput](../../03-stream_chat_flutter/stream_message_input.mdx).
By default, the Attachment Picker provides multiple picker options as per the platform. By default, the Attachment Picker provides multiple picker options as per the platform.
- For example, on Mobile, the default options are Camera, Gallery, File, and Video. - For example, on Mobile, the default options are Camera, Gallery, File, and Video.
@@ -1,13 +1,13 @@
--- ---
id: autocomplete_triggers id: autocomplete_triggers
title: Adding Custom Autocomplete Triggers title: Autocomplete Triggers
--- ---
Adding Custom Autocomplete Triggers Adding Custom Autocomplete Triggers
### Introduction ### Introduction
The [StreamMessageInput](../stream_chat_flutter/message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property. The [StreamMessageInput](../../03-stream_chat_flutter/stream_message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property.
By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones. By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones.
@@ -1,7 +1,6 @@
--- ---
id: slidable_channel_list_preview id: slidable_channel_list_preview
sidebar_position: 14 title: Channel List Preview
title: Slidable Channel List Preview
--- ---
Slidable Channel List Preview Slidable Channel List Preview
@@ -11,9 +10,9 @@ Slidable Channel List Preview
The default slidable behavior within the channel list has been removed in v4 of the Stream Chat Flutter SDK. The default slidable behavior within the channel list has been removed in v4 of the Stream Chat Flutter SDK.
This guide will show you how you can easily add this functionality yourself. This guide will show you how you can easily add this functionality yourself.
Please see our [full v4 migration guide](migration_guide_4_0.mdx) if you're migrating from an earlier version of the Stream Chat Flutter SDK. Please see our [full v4 migration guide](../../05-guides/08-migrations/migration_guide_4_0.mdx) if you're migrating from an earlier version of the Stream Chat Flutter SDK.
![Slidable demo](../assets/slidable_demo.jpg) ![Slidable demo](../../assets/slidable_demo.jpg)
### Prerequisites ### Prerequisites
@@ -0,0 +1,3 @@
{
"label": "Custom Widgets"
}
@@ -0,0 +1,3 @@
{
"label": "Customization"
}
@@ -1,7 +1,7 @@
--- ---
id: stream_chat_and_theming id: stream_chat_and_theming
sidebar_position: 3 sidebar_position: 1
title: StreamChat And Theming title: Theming
--- ---
Understanding How To Customize Widgets Using `StreamChatTheme` Understanding How To Customize Widgets Using `StreamChatTheme`
@@ -0,0 +1,3 @@
{
"label": "UI Widgets"
}
@@ -23,7 +23,7 @@ ONLY the channels that the user is a part of. This section goes into setting up
widget. widget.
:::note :::note
Make sure to check the [StreamChannelListController](./stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`. Make sure to check the [StreamChannelListController](../04-stream_chat_flutter_core/stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`.
::: :::
### Basic Example ### Basic Example
@@ -13,7 +13,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
A list of members is required for many different purposes, for example, showing a list of users in a Channel. The `StreamMemberListView` displays a list of members. A list of members is required for many different purposes, for example, showing a list of users in a Channel. The `StreamMemberListView` displays a list of members.
:::note :::note
Make sure to check the [StreamMemberListController](./stream_member_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMemberListView`. Make sure to check the [StreamMemberListController](../04-stream_chat_flutter_core/stream_member_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMemberListView`.
::: :::
### Basic Example ### Basic Example
@@ -57,7 +57,7 @@ class ChannelPage extends StatelessWidget {
It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget. It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget.
:::note :::note
Make sure to check the [StreamMessageInputController](./stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`. Make sure to check the [StreamMessageInputController](../04-stream_chat_flutter_core/stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`.
::: :::
### Adding Custom Actions ### Adding Custom Actions
@@ -17,7 +17,7 @@ message they are searching for. As such, there needs to be a way to search for a
channels. This is where `StreamMessageSearchListView` comes in. channels. This is where `StreamMessageSearchListView` comes in.
:::note :::note
Make sure to check the [StreamMessageSearchListController](./stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`. Make sure to check the [StreamMessageSearchListController](../04-stream_chat_flutter_core/stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`.
::: :::
### Basic Example ### Basic Example
@@ -17,7 +17,7 @@ selecting users to add in a channel, etc. The `StreamUserListView` displays a li
of users. of users.
:::note :::note
Make sure to check the [StreamUserListController](./stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`. Make sure to check the [StreamUserListController](../04-stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`.
::: :::
### Basic Example ### Basic Example
@@ -0,0 +1,3 @@
{
"label": "Core Widgets"
}
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
The `StreamChannelListController` is a controller class that allows you to control a list of channels. The `StreamChannelListController` is a controller class that allows you to control a list of channels.
`StreamChannelListController` is a required parameter of the `StreamChannelListView` widget. `StreamChannelListController` is a required parameter of the `StreamChannelListView` widget.
Check the [`StreamChannelListView` documentation](../stream_chat_flutter/stream_channel_list_view.mdx) to read more about that. Check the [`StreamChannelListView` documentation](../03-stream_chat_flutter/stream_channel_list_view.mdx) to read more about that.
The `StreamChannelListController` also listens for various events and manipulates the current list of channels accordingly. The `StreamChannelListController` also listens for various events and manipulates the current list of channels accordingly.
Passing a `StreamChannelListEventHandler` to the `StreamChannelListController` will allow you to customize this behaviour. Passing a `StreamChannelListEventHandler` to the `StreamChannelListController` will allow you to customize this behaviour.
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
The `StreamMemberListController` is a controller class that allows you to control a list of users. The `StreamMemberListController` is a controller class that allows you to control a list of users.
`StreamMemberListController` is a required parameter of the `StreamMemberListView` widget. `StreamMemberListController` is a required parameter of the `StreamMemberListView` widget.
Check the [`StreamMemberListView` documentation](../stream_chat_flutter/stream_member_list_view.mdx) to read more about that. Check the [`StreamMemberListView` documentation](../03-stream_chat_flutter/stream_member_list_view.mdx) to read more about that.
### Basic Example ### Basic Example
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
The `StreamMessageInputController` is a controller class that embed the business logic to compose a message. The `StreamMessageInputController` is a controller class that embed the business logic to compose a message.
`StreamMessageInputController` is a parameter of the `StreamMessageInput` widget. `StreamMessageInputController` is a parameter of the `StreamMessageInput` widget.
Check the [`StreamMessageInput` documentation](../stream_chat_flutter/stream_message_input.mdx) to read more about that. Check the [`StreamMessageInput` documentation](../03-stream_chat_flutter/stream_message_input.mdx) to read more about that.
### Basic Example ### Basic Example
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
The `StreamMessageSearchListController` is a controller class that allows you to control a list of searched messages. The `StreamMessageSearchListController` is a controller class that allows you to control a list of searched messages.
`StreamMessageSearchListController` is a required parameter of the `StreamMessageSearchListView` widget. `StreamMessageSearchListController` is a required parameter of the `StreamMessageSearchListView` widget.
Check the [`StreamMessageSearchListView` documentation](../stream_chat_flutter/stream_message_search_list_view.mdx) to read more about that. Check the [`StreamMessageSearchListView` documentation](../03-stream_chat_flutter/stream_message_search_list_view.mdx) to read more about that.
### Basic Example ### Basic Example
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
The `StreamUserListController` is a controller class that allows you to control a list of users. The `StreamUserListController` is a controller class that allows you to control a list of users.
`StreamUserListController` is a required parameter of the `StreamUserListView` widget. `StreamUserListController` is a required parameter of the `StreamUserListView` widget.
Check the [`StreamUserListView` documentation](../stream_chat_flutter/stream_user_list_view.mdx) to read more about that. Check the [`StreamUserListView` documentation](../03-stream_chat_flutter/stream_user_list_view.mdx) to read more about that.
### Basic Example ### Basic Example
@@ -1,7 +1,6 @@
--- ---
id: understanding_filters id: understanding_filters
sidebar_position: 10 title: Filters
title: Understanding Filters
--- ---
Understanding Filters Understanding Filters
@@ -1,10 +1,9 @@
--- ---
id: adding_local_data_persistence id: adding_local_data_persistence
sidebar_position: 9 title: Offline Support
title: Adding Local Data Persistence
--- ---
Adding Local Data Persistence Adding Local Data Persistence for Offline Support
### Introduction ### Introduction
@@ -1,7 +1,6 @@
--- ---
id: token_generation_with_firebase id: token_generation_with_firebase
sidebar_position: 5 title: Authentication
title: User Token Generation With Firebase Auth and Cloud Functions
--- ---
Securely generate Stream Chat user tokens using Firebase Authentication and Cloud Functions. Securely generate Stream Chat user tokens using Firebase Authentication and Cloud Functions.
@@ -1,10 +1,9 @@
--- ---
id: adding_localization id: adding_localization
sidebar_position: 2 title: Localization
title: Adding Localization (l10n) / Internationalization (i18n)
--- ---
Adding Localization To UI Widgets Adding Localization (l10n) / Internationalization (i18n) To UI Widgets
### Introduction ### Introduction
@@ -0,0 +1,3 @@
{
"label": "Push Notifications"
}
@@ -1,7 +1,7 @@
--- ---
id: adding_push_notifications id: adding_push_notifications
sidebar_position: 1 sidebar_position: 2
title: Adding Push Notifications (V1 legacy) title: Legacy
--- ---
Adding Push Notifications To Your Application Adding Push Notifications To Your Application
@@ -39,7 +39,7 @@ From the [Firebase Console](https://console.firebase.google.com/), select the pr
Click on the gear icon next to `Project Overview` and navigate to **Project settings** Click on the gear icon next to `Project Overview` and navigate to **Project settings**
![](../assets/firebase_project_settings.jpeg) ![](../../assets/firebase_project_settings.jpeg)
#### Step 3 #### Step 3
@@ -49,15 +49,15 @@ Navigate to the `Cloud Messaging` tab
Under `Project Credentials`, locate the `Server key` and copy it Under `Project Credentials`, locate the `Server key` and copy it
![](../assets/server_key.png) ![](../../assets/server_key.png)
#### Step 5 #### Step 5
Upload the `Server Key` in your chat dashboard Upload the `Server Key` in your chat dashboard
![](../assets/dashboard_firebase_enable.jpeg) ![](../../assets/dashboard_firebase_enable.jpeg)
![](../assets/dashboard_firebase_key.jpeg) ![](../../assets/dashboard_firebase_key.jpeg)
:::note :::note
@@ -68,7 +68,7 @@ We are setting up the Android section, but this will work for both Android and i
Save your push notification settings changes Save your push notification settings changes
![](../assets/dashboard_save_changes.jpeg) ![](../../assets/dashboard_save_changes.jpeg)
**OR** **OR**
@@ -1,10 +1,10 @@
--- ---
id: adding_push_notifications_v2 id: adding_push_notifications_v2
sidebar_position: 1 sidebar_position: 1
title: Adding Push Notifications (V2) title: Push Notifications
--- ---
Adding Push Notifications To Your Application Adding Push Notifications (V2) To Your Application
### Introduction ### Introduction
@@ -49,11 +49,11 @@ You can upload your Firebase credentials using either the dashboard or the app s
1. Go to the **Chat Overview** page on Stream Dashboard 1. Go to the **Chat Overview** page on Stream Dashboard
![](../assets/chat_overview_page-2fbd5bbfb70c5623bd37ff7d6c41bf4d.png) ![](../../assets/chat_overview_page-2fbd5bbfb70c5623bd37ff7d6c41bf4d.png)
2. Enable **Firebase Notification** toggle on **Chat Overview** 2. Enable **Firebase Notification** toggle on **Chat Overview**
![](../assets/firebase_notifications_toggle-5aeabfcbdc24cb8f1fea7d41d0e845fc.png) ![](../../assets/firebase_notifications_toggle-5aeabfcbdc24cb8f1fea7d41d0e845fc.png)
3. Enter your Firebase Credentials and press "Save". 3. Enter your Firebase Credentials and press "Save".
@@ -1,9 +1,10 @@
--- ---
id: end_to_end_chat_encryption id: end_to_end_chat_encryption
sidebar_position: 12 title: Encryption
title: End To End Chat Encryption
--- ---
Adding End To End Encryption to your Chat App
## Introduction ## Introduction
When you communicate over a chat application with another person or group, When you communicate over a chat application with another person or group,
@@ -1,7 +1,6 @@
--- ---
id: error_reporting_with_sentry id: error_reporting_with_sentry
sidebar_position: 15 title: Error Reporting
title: Error Reporting With Sentry
--- ---
Error Reporting With Sentry Error Reporting With Sentry
@@ -1,7 +1,6 @@
--- ---
id: adding_chat_to_video_livestreams id: adding_chat_to_video_livestreams
sidebar_position: 7 title: Livestreams Integration
title: Adding Chat To Video Livestreams
--- ---
Adding Chat To Video Livestreams Adding Chat To Video Livestreams
@@ -0,0 +1,3 @@
{
"label": "Migrations"
}
@@ -1,12 +1,12 @@
--- ---
id: migration_guide_4_0 id: migration_guide_4_0
sidebar_position: 14 sidebar_position: 1
title: Migration Guide v4.0 title: v4.0
--- ---
**Version 4.0.0** of the Stream Chat Flutter SDK carries significant architectural changes to improve the developer experience by giving you more control and flexibility in how you use our core components and UI widgets. **Version 4.0.0** of the Stream Chat Flutter SDK carries significant architectural changes to improve the developer experience by giving you more control and flexibility in how you use our core components and UI widgets.
This guide is intended to enumerate and better explain the changes in the SDK. This v4.0 Migration Guide is intended to enumerate and better explain the changes in the SDK.
If you find any bugs or have any questions, please file an [issue on our GitHub repository](https://github.com/GetStream/stream-chat-flutter/issues). We want to support you as much as we can with this migration. If you find any bugs or have any questions, please file an [issue on our GitHub repository](https://github.com/GetStream/stream-chat-flutter/issues). We want to support you as much as we can with this migration.
@@ -76,9 +76,9 @@ The automatic video compression when uploading a video has been removed. You can
### Slidable Channel List Item ### Slidable Channel List Item
The default slidable channel preview behavior has been removed. We have created a [guide](slidable_channel_list_preview.mdx) showing you how you can easily add this functionality yourself. The default slidable channel preview behavior has been removed. We have created a [guide](../../02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx) showing you how you can easily add this functionality yourself.
![Slidable demo](../assets/slidable_demo.jpg) ![Slidable demo](../../assets/slidable_demo.jpg)
### Pin Permission ### Pin Permission
@@ -194,13 +194,13 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called
- Return/Create a new channel and start watching it. - Return/Create a new channel and start watching it.
- Pause and Resume all subscriptions added to this composite. - Pause and Resume all subscriptions added to this composite.
For more information see the [`StreamChannelListView` documentation](../stream_chat_flutter/stream_channel_list_view.mdx). For more information see the [`StreamChannelListView` documentation](../../03-stream_chat_flutter/stream_channel_list_view.mdx).
### ChannelsBloc to StreamChannelListController ### ChannelsBloc to StreamChannelListController
The `ChannelsBloc` widget should be replaced with `StreamChannelListController`. This controller provides all the functionality needed to query and manipulate channel data previously accessible through `ChannelsBloc`. The `ChannelsBloc` widget should be replaced with `StreamChannelListController`. This controller provides all the functionality needed to query and manipulate channel data previously accessible through `ChannelsBloc`.
For more information see the [`StreamChannelListController` documentation](../stream_chat_flutter_core/stream_channel_list_controller.mdx). For more information see the [`StreamChannelListController` documentation](../../04-stream_chat_flutter_core/stream_channel_list_controller.mdx).
### StreamChannelListView Examples ### StreamChannelListView Examples
@@ -310,13 +310,13 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called
- Load more data using `loadMore`. - Load more data using `loadMore`.
- Refresh data. - Refresh data.
For more information see the [`StreamMessageSearchListView` documentation](../stream_chat_flutter/stream_message_search_list_view.mdx). For more information see the [`StreamMessageSearchListView` documentation](../../03-stream_chat_flutter/stream_message_search_list_view.mdx).
### MessageSearchBloc to StreamMessageSearchListController ### MessageSearchBloc to StreamMessageSearchListController
The `MessageSearchBloc` widget should be replaced with a `StreamMessageSearchListController`. This controller provides all the functionality needed to query and manipulate message search data previously accessible through `MessageSearchBloc`. The `MessageSearchBloc` widget should be replaced with a `StreamMessageSearchListController`. This controller provides all the functionality needed to query and manipulate message search data previously accessible through `MessageSearchBloc`.
For more information see the [`StreamMessageSearchListController` documentation](../stream_chat_flutter_core/stream_message_search_list_controller.mdx). For more information see the [`StreamMessageSearchListController` documentation](../../04-stream_chat_flutter_core/stream_message_search_list_controller.mdx).
### StreamMessageSearchListView Example ### StreamMessageSearchListView Example
@@ -421,13 +421,13 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called
- Set filters. - Set filters.
- Refresh data. - Refresh data.
For more information see the [`StreamUserListView` documentation](../stream_chat_flutter/stream_user_list_view.mdx). For more information see the [`StreamUserListView` documentation](../../03-stream_chat_flutter/stream_user_list_view.mdx).
### UsersBloc to StreamUserListController ### UsersBloc to StreamUserListController
The `UsersBloc` widget should be replaced with a `StreamUserListController`. This controller provides all the functionality needed to query and manipulate user data previously accessible through `UsersBloc`. The `UsersBloc` widget should be replaced with a `StreamUserListController`. This controller provides all the functionality needed to query and manipulate user data previously accessible through `UsersBloc`.
For more information see the [`StreamUserListController` documentation](../stream_chat_flutter_core/stream_user_list_controller.mdx). For more information see the [`StreamUserListController` documentation](../../04-stream_chat_flutter_core/stream_user_list_controller.mdx).
### StreamUserListView Example ### StreamUserListView Example
@@ -558,7 +558,7 @@ The following arguments are newly introduced to the `StreamMessageInput`, and ar
- `elevation`: elevation of the **StreamMessageInput** widget - `elevation`: elevation of the **StreamMessageInput** widget
- `shadow`: **Shadow** for the **StreamMessageInput** widget - `shadow`: **Shadow** for the **StreamMessageInput** widget
For more information see the [`StreamMessageInput` documentation](../stream_chat_flutter_core/stream_message_input_controller.mdx). For more information see the [`StreamMessageInput` documentation](../../04-stream_chat_flutter_core/stream_message_input_controller.mdx).
### StreamMessageInput Examples ### StreamMessageInput Examples
@@ -1,7 +1,7 @@
--- ---
id: migration_guide_5_0 id: migration_guide_5_0
sidebar_position: 15 sidebar_position: 2
title: Migration Guide v5.0 title: v5.0
--- ---
**Version 5.0.0** of the Stream Chat Flutter SDK UI package has been overhauled to support larger screen sizes better and provide native feeling web and desktop platform interactions that feel intuitive and expected. **Version 5.0.0** of the Stream Chat Flutter SDK UI package has been overhauled to support larger screen sizes better and provide native feeling web and desktop platform interactions that feel intuitive and expected.
@@ -38,7 +38,7 @@ This section highlights our efforts on Desktop (macOS, Windows, and Linux) and W
### Setup ### Setup
See the [setup guide](../stream_chat_flutter/setup.mdx) for platform specific instructions. See the [setup guide](../../03-stream_chat_flutter/setup.mdx) for platform specific instructions.
### Supporting Larger Screens ### Supporting Larger Screens
@@ -49,7 +49,7 @@ We've added support for larger screens and have made changes to the UI to suppor
Below is an example running on macOS, with a split-screen view showing channels on the left and messages on the right. Below is an example running on macOS, with a split-screen view showing channels on the left and messages on the right.
![MacOS split](../assets/mac_os_split.png) ![MacOS split](../../assets/mac_os_split.png)
### Native Platform Interactions ### Native Platform Interactions
@@ -105,13 +105,13 @@ For additional information, see [#1125](https://github.com/GetStream/stream-chat
The `StreamMemberListView` and `StreamMemberGridView` widgets are new widgets that allow you to display a list of members in a channel. The `StreamMemberListView` and `StreamMemberGridView` widgets are new widgets that allow you to display a list of members in a channel.
Check out the dedicated [documentation](../stream_chat_flutter/stream_member_list_view.mdx) for more information. Check out the dedicated [documentation](../../03-stream_chat_flutter/stream_member_list_view.mdx) for more information.
### Attachment Picker ### Attachment Picker
As part of the v5 release, we've refactored the `AttachmentPicker` to be more flexible and customizable. This allows you to use the `AttachmentPicker` in various ways and customize the UI to your liking. As part of the v5 release, we've refactored the `AttachmentPicker` to be more flexible and customizable. This allows you to use the `AttachmentPicker` in various ways and customize the UI to your liking.
Check out the dedicated [guide](./customize_attachment_picker_modal.mdx) for more information. Check out the dedicated [guide](../../02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx) for more information.
### Other Changes ### Other Changes
@@ -169,6 +169,6 @@ StreamImageAttachment(
) )
``` ```
- Removed `StreamMessageInput.customOverlays` in favor of `StreamMessageInput.customAutocompleteTriggers`. Read the guide on [Adding Custom Autocomplete Triggers](./autocomplete_triggers.mdx) to learn how to migrate your code. - Removed `StreamMessageInput.customOverlays` in favor of `StreamMessageInput.customAutocompleteTriggers`. Read the guide on [Adding Custom Autocomplete Triggers](../../02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code.
- Removed the default emoji overlay picker. Read the guide on [Adding Custom Autocomplete Triggers](./autocomplete_triggers.mdx) to learn how to migrate your code. - Removed the default emoji overlay picker. Read the guide on [Adding Custom Autocomplete Triggers](../../02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code.
@@ -0,0 +1,3 @@
{
"label": "Guides"
}
@@ -1,4 +0,0 @@
{
"label": "Introduction",
"position": 1
}
@@ -1,4 +0,0 @@
{
"label": "Guides",
"position": 2
}
@@ -1,4 +0,0 @@
{
"label": "Stream Chat Flutter",
"position": 3
}
@@ -1,4 +0,0 @@
{
"label": "Stream Chat Flutter Core",
"position": 4
}
@@ -7,7 +7,7 @@ Adding Custom Autocomplete Triggers
### Introduction ### Introduction
The [StreamMessageInput](../stream_chat_flutter/message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property. The [StreamMessageInput](../stream_chat_flutter/stream_message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property.
By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones. By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones.
@@ -23,7 +23,7 @@ ONLY the channels that the user is a part of. This section goes into setting up
widget. widget.
:::note :::note
Make sure to check the [StreamChannelListController](./stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`. Make sure to check the [StreamChannelListController](../stream_chat_flutter_core/stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`.
::: :::
### Basic Example ### Basic Example
@@ -57,7 +57,7 @@ class ChannelPage extends StatelessWidget {
It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget. It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget.
:::note :::note
Make sure to check the [StreamMessageInputController](./stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`. Make sure to check the [StreamMessageInputController](../stream_chat_flutter_core/stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`.
::: :::
### Adding Custom Actions ### Adding Custom Actions
@@ -17,7 +17,7 @@ message they are searching for. As such, there needs to be a way to search for a
channels. This is where `StreamMessageSearchListView` comes in. channels. This is where `StreamMessageSearchListView` comes in.
:::note :::note
Make sure to check the [StreamMessageSearchListController](./stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`. Make sure to check the [StreamMessageSearchListController](../stream_chat_flutter_core/stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`.
::: :::
### Basic Example ### Basic Example
@@ -17,7 +17,7 @@ selecting users to add in a channel, etc. The `StreamUserListView` displays a li
of users. of users.
:::note :::note
Make sure to check the [StreamUserListController](./stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`. Make sure to check the [StreamUserListController](../stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`.
::: :::
### Basic Example ### Basic Example