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

    Interface JoinTokenProps

    Props for the JoinToken component.

    The component operates in two modes controlled by the mode prop:

    • 'display' -- Shows a token in a monospace box with copy and share buttons.
    • 'input' -- Provides a form to enter a token, optionally look up room info, enter a password, and join.
    interface JoinTokenProps {
        colors?: Partial<JoinTokenColors>;
        isLoading?: boolean;
        labels?: Partial<JoinTokenLabels>;
        mode: "display" | "input";
        onCopyToken?: () => void;
        onJoin?: (token: string, password?: string) => void;
        onLookup?: (token: string) => void;
        onShare?: () => void;
        requirePassword?: boolean;
        roomInfo?: { isActive: boolean; roomName: string };
        roomName?: string;
        token?: string;
    }
    Index

    Properties

    colors? isLoading? labels? mode onCopyToken? onJoin? onLookup? onShare? requirePassword? roomInfo? roomName? token?

    Properties

    colors?: Partial<JoinTokenColors>

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

    isLoading?: boolean

    When true, shows a loading indicator on action buttons.

    labels?: Partial<JoinTokenLabels>

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

    mode: "display" | "input"

    Determines which view is rendered.

    • 'display' -- Token display with copy/share actions.
    • 'input' -- Token entry form with lookup and join actions.
    onCopyToken?: () => void

    Called when the user copies the token. Used in 'display' mode.

    onJoin?: (token: string, password?: string) => void

    Called when the user presses the join button. Receives the entered token and optional password. Used in 'input' mode.

    onLookup?: (token: string) => void

    Called when the user presses the lookup/preview button. Receives the entered token. Used in 'input' mode.

    onShare?: () => void

    Called when the user shares the token via the system share sheet. Used in 'display' mode.

    requirePassword?: boolean

    Whether to show the password input field.

    false

    roomInfo?: { isActive: boolean; roomName: string }

    Room information returned from a lookup, displayed as a preview.

    roomName?: string

    Room name shown as context in display mode.

    token?: string

    The token string to display. Used in 'display' mode.

    Settings

    Member Visibility

    On This Page

    Properties