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

    Function WaitingRoomGuest

    • WaitingRoomGuest - Guest waiting screen component.

      Parameters

      Returns Element | null

      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:

      • idle: Initial state before join attempt
      • waiting: Waiting for host to admit
      • joining: Host admitted, now connecting
      • joined: Successfully joined (component typically unmounts)
      • rejected: Host denied entry
      • timeout: Wait time expired
      • error: An error occurred

      Basic usage:

      <WaitingRoomGuest
      status={waitStatus}
      roomName="Team Meeting"
      onCancel={() => navigate('/')}
      />

      With timeout handling:

      const [elapsedMs, setElapsedMs] = useState(0);
      const TIMEOUT_MS = 300000; // 5 minutes

      <WaitingRoomGuest
      status={waitStatus}
      roomName="Team Meeting"
      elapsedTime={elapsedMs}
      totalTimeout={TIMEOUT_MS}
      onCancel={() => handleCancel()}
      onExtendTimeout={() => setElapsedMs(0)}
      onLeave={() => navigate('/')}
      />

      With custom labels (i18n):

      <WaitingRoomGuest
      status={waitStatus}
      labels={{
      waitingTitle: 'En attente de l\'hôte',
      waitingMessage: 'Veuillez patienter pendant que l\'hôte vous admet...',
      cancelButton: 'Annuler',
      }}
      />