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

    Interface WaitingRoomProps

    Props for the WaitingRoom component.

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

    • 'guest' -- Shows a waiting screen with a spinner while the user awaits admission, or a rejection message if the host denied entry.
    • 'host' -- Shows a scrollable list of users waiting to join, with Admit and Reject buttons for each.
    interface WaitingRoomProps {
        colors?: Partial<WaitingRoomColors>;
        isWaitingForAdmission?: boolean;
        labels?: Partial<WaitingRoomLabels>;
        mode: "host" | "guest";
        onAdmitUser?: (userId: string) => void;
        onGoBack?: () => void;
        onRejectUser?: (userId: string) => void;
        waitingUsers?: WaitingRoomUser[];
        wasRejected?: boolean;
    }
    Index

    Properties

    colors? isWaitingForAdmission? labels? mode onAdmitUser? onGoBack? onRejectUser? waitingUsers? wasRejected?

    Properties

    colors?: Partial<WaitingRoomColors>

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

    isWaitingForAdmission?: boolean

    Whether the local user is waiting for the host to admit them. Only used in 'guest' mode. When true, a spinner and waiting message are displayed.

    false

    labels?: Partial<WaitingRoomLabels>

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

    mode: "host" | "guest"

    Determines which view is rendered.

    • 'guest' -- Waiting/rejection screen for users who have not yet been admitted.
    • 'host' -- Management list for the room owner to admit or reject waiting users.
    onAdmitUser?: (userId: string) => void

    Called when the host presses the "Admit" button for a waiting user. Receives the user's ID. Only used in 'host' mode.

    onGoBack?: () => void

    Called when a rejected guest presses the "Go Back" button. Only used in 'guest' mode when wasRejected is true.

    onRejectUser?: (userId: string) => void

    Called when the host presses the "Reject" button for a waiting user. Receives the user's ID. Only used in 'host' mode.

    waitingUsers?: WaitingRoomUser[]

    Array of users currently in the waiting room. Only used in 'host' mode.

    []

    wasRejected?: boolean

    Whether the local user was rejected by the host. Only used in 'guest' mode. When true, a rejection message is displayed instead of the spinner.

    false

    Settings

    Member Visibility

    On This Page

    Properties