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

    Interface ChatProps

    Props for the Chat component.

    interface ChatProps {
        colors?: Partial<ChatColors>;
        labels?: Partial<ChatLabels>;
        localUserId: string;
        messages: ChatMessage[];
        onClearUnread?: () => void;
        onSend: (content: string) => void;
        showAvatars?: boolean;
        showHeader?: boolean;
        showTimestamps?: boolean;
        unreadCount?: number;
    }
    Index

    Properties

    colors? labels? localUserId messages onClearUnread? onSend showAvatars? showHeader? showTimestamps? unreadCount?

    Properties

    colors?: Partial<ChatColors>

    Partial color overrides merged with built-in defaults. See ChatColors.

    labels?: Partial<ChatLabels>

    Partial label overrides merged with built-in defaults. See ChatLabels.

    localUserId: string

    The local user's ID. Used to distinguish local from remote messages.

    messages: ChatMessage[]

    Array of chat messages to display. Typically from useChat in @hiyve/rn-react.

    onClearUnread?: () => void

    Called when the chat becomes visible, to clear unread badge counts.

    onSend: (content: string) => void

    Called when the user presses the send button. Receives the message text.

    showAvatars?: boolean

    Whether to display avatar circles next to remote messages.

    true

    showHeader?: boolean

    Whether to display the header row with the title and unread badge.

    true

    showTimestamps?: boolean

    Whether to display timestamps next to messages.

    true

    unreadCount?: number

    Number of unread messages shown as a badge in the header.

    0

    Settings

    Member Visibility

    On This Page

    Properties