useChannelMuteActive

Returns whether mute is currently active for a channel.

For direct chats, it checks both the channel mute and the other user's mute; for group channels, it checks the channel mute only.

Best Practices

  • Use this hook to drive mute badges and mute action labels.
  • Do not duplicate mute checks in row render code.
  • Combine with useIsDirectChat only when custom branching is required.
  • Keep mute indicators visually consistent across channel-list and channel-details surfaces.
  • Handle false as the default value when no mute state applies.

Usage

import { useChannelMuteActive } from "stream-chat-react-native";

const muteActive = useChannelMuteActive(channel);

Parameters

NameTypeRequiredDescription
channelChannelYesChannel to evaluate for active mute state.

Returns

TypeDescription
booleanWhether mute is active for this channel conversation.