useMutedUsers

Returns the current list of muted users from the client state store.

Best Practices

• Use this hook to support direct-chat mute and moderation UI.
• Handle undefined values during initialization states.
• Avoid duplicating mute-user event subscriptions in list components.
• Keep lookups optimized when checking mute state repeatedly.
• Pair with useChannelMuteActive for per-channel mute display logic.

Usage

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

const mutedUsers = useMutedUsers(channel) ?? [];

Parameters

Returns