Skip to main content
Version: v5

ChannelPreviewUnreadCount

Component to render unread count on a channel, within the ChannelList component. This is the default component provided to the prop PreviewUnreadCount on the ChannelList component.

Props#

required
maxUnreadCount#

Max number to display within the unread notification badge. The value cannot exceed the backend limit of 255.

TypeDefault
number255

required
unread#

Number of unread messages on the channel

Type
number

channel#

Instance of Channel from stream-chat package.

Type
Channel

Did you find this page helpful?