import { useChannelMuteActive } from "stream-chat-react-native";
const muteActive = useChannelMuteActive(channel);This is beta documentation for Stream Chat React Native SDK v9. For the latest stable version, see the latest version (v8)
.
useChannelMuteActive
Returns whether mute is currently active for a channel.
For direct chats, it checks muted users; for group channels, it checks muted channels.
Best Practices
- Use this hook to drive mute badges and mute action labels.
- Do not duplicate mute checks in row render code.
- Combine with
useIsDirectChatonly when custom branching is required. - Keep mute indicators visually consistent across channel-list surfaces.
- Handle false as the default value when no mute state applies.
Usage
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| channel | Channel | Yes | Channel to evaluate for active mute state. |
Returns
| Type | Description |
|---|---|
boolean | Whether mute is active for this channel conversation. |