Hiyve Components - v1.0.0
    Preparing search index...

    Interface ChatChannelListProps

    Props for the ChatChannelList component.

    interface ChatChannelListProps {
        activeChannelId?: string | null;
        channels: ChatChannel[];
        colors?: Partial<ChatChannelListColors>;
        groupBy?: (channel: ChatChannel) => string;
        labels?: Partial<ChatChannelListLabels>;
        onChannelSelect: (channelId: string) => void;
        onNewChat?: () => void;
        renderChannelItem?: (
            channel: ChatChannel,
            isActive: boolean,
            defaultContent: ReactNode,
        ) => ReactNode;
        showSearch?: boolean;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    activeChannelId? channels colors? groupBy? labels? onChannelSelect onNewChat? renderChannelItem? showSearch? sx?

    Properties

    activeChannelId?: string | null

    Currently active channel ID

    channels: ChatChannel[]

    Array of channels to display

    colors?: Partial<ChatChannelListColors>

    Custom colors

    groupBy?: (channel: ChatChannel) => string

    Group channels by a key derived from each channel

    labels?: Partial<ChatChannelListLabels>

    Custom labels

    onChannelSelect: (channelId: string) => void

    Callback when a channel is selected

    onNewChat?: () => void

    Callback to start a new conversation. When provided, a "new chat" action button appears in the list header; the consumer decides what it does (e.g. open a picker). Omit to hide the button.

    renderChannelItem?: (
        channel: ChatChannel,
        isActive: boolean,
        defaultContent: ReactNode,
    ) => ReactNode

    Custom render for a channel item

    showSearch?: boolean

    Show search filter (default: false)

    sx?: SxProps<Theme>

    MUI sx styling prop

    Settings

    Member Visibility

    On This Page

    Properties