diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/message_search_list_view.mdx b/docusaurus/docs/Flutter/stream_chat_flutter/message_search_list_view.mdx deleted file mode 100644 index 39bf2d9e..00000000 --- a/docusaurus/docs/Flutter/stream_chat_flutter/message_search_list_view.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: message_search_list_view -sidebar_position: 8 -title: MessageSearchListView ---- - -A Widget To Search For Messages Across Channels - -Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/MessageSearchListView-class.html) - -![](../assets/message_search_list_view.png) - -### Background - -Users in Stream Chat can have several channels and it can get hard to remember which channel has the -message they are searching for. As such, there needs to be a way to search for a message across multiple -channels. This is where `MessageSearchListView` comes in. - -### Basic Example - -While the MessageListView is tied to a certain `StreamChannel`, a `MessageSearchListView` is not. - -```dart -class MessageSearchPage extends StatelessWidget { - @override - Widget build(BuildContext context) { - return Scaffold( - body: MessageSearchBloc( - child: MessageSearchListView( - filters: Filter.in_('members', [StreamChat.of(context).user!.id],), - messageQuery: 'your query here', - limit: 20, - ), - ), - ); - } -} -``` - -### Customize The Result Tiles - -You can use your own widget for the result items using the `itemBuilder` parameter. - -```dart -MessageSearchListView( - // ... - itemBuilder: (context, response) { - return Text(response.message.text); - }, -), -``` - -### Show Result Count - -You show the number of results via the `showResultCount` parameter. - -```dart -MessageSearchListView( - // ... - showResultCount: true, -), -``` diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx b/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx new file mode 100644 index 00000000..e08bed07 --- /dev/null +++ b/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx @@ -0,0 +1,74 @@ +--- +id: stream_message_search_list_view +sidebar_position: 8 +title: StreamMessageSearchListView +--- + +A Widget To Search For Messages Across Channels + +Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamMessageSearchListView-class.html) + +![](../assets/message_search_list_view.png) + +### Background + +Users in Stream Chat can have several channels and it can get hard to remember which channel has the +message they are searching for. As such, there needs to be a way to search for a message across multiple +channels. This is where `StreamMessageSearchListView` comes in. + +:::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`. +::: + +### Basic Example + +While the `StreamMessageListView` is tied to a certain `StreamChannel`, a `StreamMessageSearchListView` is not. + +```dart +class StreamMessageSearchPage extends StatefulWidget { + const StreamMessageSearchPage({ + Key? key, + required this.client, + }) : super(key: key);` + + final StreamChatClient client; + + @override + State createState() => _StreamMessageSearchState(); +} + +class _StreamMessageSearchState extends State { + late final _controller = StreamMessageSearchListController( + client: widget.client, + limit: 20, + filters: Filter.in_('members', [StreamChat.of(context).user!.id],), + searchQuery: 'your query here', + ); + + @override + void dispose() { + _controller.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) => Scaffold( + body: StreamChannelListView( + controller: _controller, + ), + ); +} +``` + +### Customize The Result Tiles + +You can use your own widget for the result items using the `itemBuilder` parameter. + +```dart +StreamMessageSearchListView( + // ... + itemBuilder: (context, responses, index, defaultWidget) { + return Text(responses[index].message.text); + }, +), +``` diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx b/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx index a37670d3..14cf92f9 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx +++ b/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx @@ -6,7 +6,7 @@ title: StreamUserListView A Widget For Displaying And Selecting Users -Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/UserListView-class.html) +Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamUserListView-class.html) ![](../assets/user_list_view.png)