Skip to main content
Version: v5

StreamMessageSearchGridView

A Widget To Search For Messages Across Channels

Find the pub.dev documentation here

Background

The StreamMessageSearchGridView widget allows displaying a list of searched messages in a GridView.

note

Make sure to check the StreamMessageSearchListView documentation to know how to show results in a ListView.

Basic Example

class StreamMessageSearchPage extends StatefulWidget {
const StreamMessageSearchPage({
super.key,
required this.client,
});

final StreamChatClient client;

@override
State<StreamMessageSearchPage> createState() => _StreamMessageSearchState();
}

class _StreamMessageSearchState extends State<StreamMessageSearchPage> {
late final _controller = StreamMessageSearchListController(
client: widget.client,
limit: 20,
filter: 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: StreamMessageSearchGridView(
controller: _controller,
itemBuilder: (context, values, index) {
// return your custom widget here
},
),
);
}

Did you find this page helpful?