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

    Interface WaitingRoomAdmittanceProps

    Props for the WaitingRoomAdmittance component.

    This component shows waiting participants and provides admit/reject controls. It can be displayed as a popover, inline list, or dialog.

    <WaitingRoomAdmittance
      participants={waitingList}
      onAdmit={async (userId) => {
        await client.admitWaitingRoomUser({ userToAdmit: userId });
      }}
      onReject={async (userId) => {
        await client.rejectWaitingRoomUser({ userToReject: userId });
      }}
      variant="popover"
      anchorEl={anchorEl}
      open={open}
      onClose={() => setOpen(false)}
    />
    interface WaitingRoomAdmittanceProps {
        anchorEl?: HTMLElement | null;
        autoAdmitSystemUsers?: boolean;
        colors?: Partial<WaitingRoomAdmittanceColors>;
        icons?: Partial<WaitingRoomAdmittanceIcons>;
        labels?: Partial<WaitingRoomAdmittanceLabels>;
        notificationSoundUrl?: string;
        onAdmit?: (userId: string) => void | Promise<void>;
        onAdmitAll?: () => void | Promise<void>;
        onClose?: () => void;
        onReject?: (userId: string) => void | Promise<void>;
        open?: boolean;
        participants?: WaitingParticipant[];
        playNotificationSound?: boolean;
        renderProps?: WaitingRoomAdmittanceRenderProps;
        styles?: Partial<WaitingRoomAdmittanceStyles>;
        sx?: SxProps<Theme>;
        variant?: WaitingRoomAdmittanceVariant;
    }
    Index

    Properties

    anchorEl? autoAdmitSystemUsers? colors? icons? labels? notificationSoundUrl? onAdmit? onAdmitAll? onClose? onReject? open? participants? playNotificationSound? renderProps? styles? sx? variant?

    Properties

    anchorEl?: HTMLElement | null

    Anchor element for popover variant

    autoAdmitSystemUsers?: boolean

    Automatically admit system users (recorders, streamers, transcribers). These are identified by userId prefixes like 'RECORDER-', 'STREAMER-', 'TRANSCRIBER-'.

    false
    colors?: Partial<WaitingRoomAdmittanceColors>

    Custom colors

    icons?: Partial<WaitingRoomAdmittanceIcons>

    Custom icons

    labels?: Partial<WaitingRoomAdmittanceLabels>

    Custom labels for i18n support

    notificationSoundUrl?: string

    Custom notification sound URL

    onAdmit?: (userId: string) => void | Promise<void>

    Callback when a participant is admitted. When used inside HiyveProvider, this is automatically connected to admitUser().

    onAdmitAll?: () => void | Promise<void>

    Callback when all participants are admitted

    onClose?: () => void

    Callback when the popover/dialog is closed

    onReject?: (userId: string) => void | Promise<void>

    Callback when a participant is rejected. When used inside HiyveProvider, this is automatically connected to rejectUser().

    open?: boolean

    Whether the popover/dialog is open

    participants?: WaitingParticipant[]

    List of participants waiting to be admitted. When used inside HiyveProvider, this is automatically populated from useWaitingRoom().

    playNotificationSound?: boolean

    Play a sound when new participants arrive

    renderProps?: WaitingRoomAdmittanceRenderProps

    Render props for advanced customization

    styles?: Partial<WaitingRoomAdmittanceStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx prop for container styling

    variant?: WaitingRoomAdmittanceVariant

    Display variant: popover, inline, or dialog

    Settings

    Member Visibility

    On This Page

    Properties