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

    Interface WaitForHostScreenProps

    Props for the WaitForHostScreen component.

    This component displays a waiting screen when a guest joins a room before the host has started the meeting. This is different from the waiting room - it's shown when the host hasn't created the room yet.

    When used inside HiyveProvider, state is automatically derived from the useWaitForHost() and useConnection() hooks.

    Context-connected usage (recommended):

    import { HiyveProvider } from '@hiyve/react';
    import { WaitForHostScreen } from '@hiyve/react-ui';

    function App() {
      const { isWaiting } = useWaitForHost();

      if (isWaiting) {
        return <WaitForHostScreen />;
      }
      return <VideoRoom />;
    }

    Manual prop-based usage:

    <WaitForHostScreen
      roomName="Team Meeting"
      timeout={60}
      elapsedTime={30}
      onCancel={() => navigate('/')}
    />
    interface WaitForHostScreenProps {
        colors?: Partial<WaitForHostScreenColors>;
        elapsedTime?: number;
        icons?: Partial<WaitForHostScreenIcons>;
        labels?: Partial<WaitForHostScreenLabels>;
        onCancel?: () => void;
        renderProps?: WaitForHostScreenRenderProps;
        roomName?: string | null;
        styles?: Partial<WaitForHostScreenStyles>;
        sx?: SxProps<Theme>;
        timeout?: number | null;
    }
    Index

    Properties

    colors? elapsedTime? icons? labels? onCancel? renderProps? roomName? styles? sx? timeout?

    Properties

    colors?: Partial<WaitForHostScreenColors>

    Custom colors

    elapsedTime?: number

    Seconds elapsed since started waiting. When used inside HiyveProvider, this is automatically populated from useWaitForHost().

    icons?: Partial<WaitForHostScreenIcons>

    Custom icons

    labels?: Partial<WaitForHostScreenLabels>

    Custom labels for i18n support

    onCancel?: () => void

    Callback when user cancels waiting. When used inside HiyveProvider, this is automatically connected to leaveRoom().

    renderProps?: WaitForHostScreenRenderProps

    Render props for advanced customization

    roomName?: string | null

    Name of the room waiting for. When used inside HiyveProvider, this is automatically populated from useWaitForHost().

    styles?: Partial<WaitForHostScreenStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx prop for container styling

    timeout?: number | null

    Timeout in seconds. When used inside HiyveProvider, this is automatically populated from useWaitForHost().

    Settings

    Member Visibility

    On This Page

    Properties