From 8853d0a785c0f6259036052dc8dbc7ca16d7e305 Mon Sep 17 00:00:00 2001 From: Deven Joshi Date: Tue, 13 Jul 2021 17:12:44 +0530 Subject: [PATCH] feat: Added new docs and images --- .../user_list_core.mdx | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/user_list_core.mdx b/docusaurus/docs/Flutter/stream_chat_flutter_core/user_list_core.mdx index bf1055db..cbc01e40 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/user_list_core.mdx +++ b/docusaurus/docs/Flutter/stream_chat_flutter_core/user_list_core.mdx @@ -18,3 +18,48 @@ exposes builders to build the UI in situations such as loading, empty data, erro ### Basic Example +[UserListCore] is a simplified class that allows fetching users while +exposing UI builders. +A [UserListController] is used to load and paginate data. + +```dart +class UsersListPage extends StatelessWidget { + @override + Widget build(BuildContext context) { + return Scaffold( + body: UsersListCore( + filter: Filter.autoComplete('name', 'search_here'), + sort: [SortOption('last_message_at')], + pagination: PaginationParams( + limit: 20, + ), + errorBuilder: (err) { + return Center( + child: Text('An error has occured'), + ); + }, + emptyBuilder: (context) { + return Center( + child: Text('Nothing here...'), + ); + }, + emptyBuilder: (context) { + return Center( + child: CircularProgressIndicator(), + ); + }, + listBuilder: (context, list) { + return UsersPage(list); + } + ), + ); + } +} +``` + +[UsersBloc] must be the ancestor of this widget. This is necessary since +[UserListCore] depends on functionality contained within [UsersBloc]. + +The parameters [listBuilder], [loadingBuilder], [emptyBuilder] and +[errorBuilder] must all be supplied and not null. +