React
iOS
Android
Flutter
Angular
JavaScript
Unity
Unreal
Node
Python
Ruby
PHP
Java
.NET
Go
RESTChannelPreviewUnreadCount
Renders unread count inside ChannelList. This is the default component for the ChannelPreviewUnreadCount override.
Best Practices
- Clamp counts with
maxUnreadCountto avoid overflow. - Hide the badge when
unreadis zero. - Keep badge size consistent across the list.
- Use channel-level unread counts for accuracy.
- Avoid expensive formatting in render.
Props
| Prop | Description | Type |
|---|---|---|
channel | Channel instance from the Stream Chat client. | Channel |
maxUnreadCount | Max number shown in the unread badge. The value cannot exceed the backend limit of 255. Defaults to 255. | number |
unread | Number of unread messages in the channel. | number |