Info:
This is documentation for Stream Chat React Native SDK v8, which is no longer actively maintained. For up-to-date documentation, see the latest version (v9).

ChannelPreviewUnreadCount

Renders unread count inside ChannelList. This is the default component for the PreviewUnreadCount prop.

Best Practices

  • Clamp counts with maxUnreadCount to avoid overflow.
  • Hide the badge when unread is zero.
  • Keep badge size consistent across the list.
  • Use channel-level unread counts for accuracy.
  • Avoid expensive formatting in render.

Props

channel

Channel instance from the Stream Chat client.

Type
Channel

maxUnreadCount

Max number shown in the unread badge. The value cannot exceed the backend limit of 255.

Type Default
number 255

unread

Number of unread messages in the channel.

Type
number
Add Chat to my app: getstream.io/SKILL.md

The fastest way to build with Stream. Start a new project or improve an existing one. Full CLI and documentation integration out of the box.


Ask your agent:

/stream Build me a Social App with Feeds and Moderation.
/stream Any livestream calls running?
/stream Chat React Native v8: <Your Question>