Skip to main content
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.

Quick Start

Using Navigator:
Embedding as a widget:
Prerequisites: CometChat SDK initialized with CometChatUIKit.init(), a user logged in, and the UI Kit dependency added.

Filtering Users

Pass a UsersRequestBuilder to control what loads:

Filter Recipes


Actions and Events

Callback Methods

onItemTap

Fires when a user row is tapped. Primary navigation hook.

onItemLongPress

Fires when a user row is long-pressed.

onBack

Fires when the user presses the back button in the app bar.

onSelection

Fires when users are selected/deselected in multi-select mode.

onError

Fires on internal errors.

onLoad

Fires when the list is successfully fetched and loaded.

onEmpty

Fires when the list is empty after loading.

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.

Title View

Replace the name / title text.

Subtitle View

Replace the subtitle text below the user’s name.

Trailing View

Replace the right section of each user item.

List Item View

Replace the entire list item row.

State Views


Common Patterns

Minimal list — hide all chrome

Friends-only list

Online users only


Advanced

BLoC Access

Provide a custom UsersBloc to override behavior:

Extending UsersBloc

UsersBloc uses the ListBase<User> mixin with override hooks:
For ListBase override hooks (onItemAdded, onItemRemoved, onItemUpdated, onListCleared, onListReplaced), see BLoC & Data — ListBase Hooks.

Public BLoC Events

Public BLoC Methods


Style

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