CometChatUsers renders a scrollable list of all available users with real-time presence updates, search, avatars, and online/offline status indicators.
Where It Fits
CometChatUsers is a list component. It renders all available users and emits the selected User via onItemTap. Wire it to CometChatMessageHeader, CometChatMessageList, and CometChatMessageComposer to build a direct messaging layout.
- Dart
Quick Start
Using Navigator:- Dart
- Dart
CometChatUIKit.init(), a user logged in, and the UI Kit dependency added.
Filtering Users
Pass aUsersRequestBuilder to control what loads:
- Dart
Filter Recipes
Actions and Events
Callback Methods
onItemTap
Fires when a user row is tapped. Primary navigation hook.
- Dart
onItemLongPress
Fires when a user row is long-pressed.
- Dart
onBack
Fires when the user presses the back button in the app bar.
- Dart
onSelection
Fires when users are selected/deselected in multi-select mode.
- Dart
onError
Fires on internal errors.
- Dart
onLoad
Fires when the list is successfully fetched and loaded.
- Dart
onEmpty
Fires when the list is empty after loading.
- Dart
SDK Events (Real-Time, Automatic)
The component listens to these SDK events internally. No manual setup needed.Functionality
Custom View Slots
Leading View
Replace the avatar / left section.- Dart
Title View
Replace the name / title text.- Dart
Subtitle View
Replace the subtitle text below the user’s name.- Dart
Trailing View
Replace the right section of each user item.- Dart
List Item View
Replace the entire list item row.- Dart
State Views
- Dart
Common Patterns
Minimal list — hide all chrome
- Dart
Friends-only list
- Dart
Online users only
- Dart
Advanced
BLoC Access
Provide a customUsersBloc to override behavior:
- Dart
Extending UsersBloc
UsersBloc uses the ListBase<User> mixin with override hooks:
- Dart
ListBase override hooks (onItemAdded, onItemRemoved, onItemUpdated, onListCleared, onListReplaced), see BLoC & Data — ListBase Hooks.
Public BLoC Events
Public BLoC Methods
Style
- Dart
Style Properties
See Component Styling for the full reference.
Next Steps
Conversations
Browse recent conversations
Groups
Browse and search available groups
Component Styling
Detailed styling reference
Message Template
Customize message bubble structure