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

    Interface WaitingRoomGuestProps

    Props for the WaitingRoomGuest component.

    This component displays a waiting screen for guests who are waiting to be admitted by the host. It shows different UI based on the current status.

    <WaitingRoomGuest
      status={waitStatus}
      roomName="Team Meeting"
      elapsedTime={elapsedMs}
      totalTimeout={300000}
      onCancel={() => client.disconnect()}
      onLeave={() => navigate('/')}
    />
    interface WaitingRoomGuestProps {
        colors?: Partial<WaitingRoomGuestColors>;
        elapsedTime?: number;
        error?: string;
        icons?: Partial<WaitingRoomGuestIcons>;
        labels?: Partial<WaitingRoomGuestLabels>;
        onCancel?: () => void;
        onExtendTimeout?: () => void;
        onLeave?: () => void;
        onRetry?: () => void;
        renderProps?: WaitingRoomGuestRenderProps;
        roomName?: string;
        status: WaitingStatus;
        styles?: Partial<WaitingRoomGuestStyles>;
        sx?: SxProps<Theme>;
        totalTimeout?: number;
    }
    Index

    Properties

    colors? elapsedTime? error? icons? labels? onCancel? onExtendTimeout? onLeave? onRetry? renderProps? roomName? status styles? sx? totalTimeout?

    Properties

    colors?: Partial<WaitingRoomGuestColors>

    Custom colors

    elapsedTime?: number

    Milliseconds elapsed since starting to wait

    error?: string

    Error message if status is 'error'

    icons?: Partial<WaitingRoomGuestIcons>

    Custom icons

    labels?: Partial<WaitingRoomGuestLabels>

    Custom labels for i18n support

    onCancel?: () => void

    Called when user cancels waiting

    onExtendTimeout?: () => void

    Called when user extends timeout (keeps waiting)

    onLeave?: () => void

    Called when user leaves after rejection/error

    onRetry?: () => void

    Called when user retries after error

    renderProps?: WaitingRoomGuestRenderProps

    Render props for advanced customization

    roomName?: string

    Name of the room being joined

    status: WaitingStatus

    Current waiting status

    styles?: Partial<WaitingRoomGuestStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx prop for container styling

    totalTimeout?: number

    Maximum wait time in milliseconds

    Settings

    Member Visibility

    On This Page

    Properties