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

    Interface PrebuiltRoomProps

    interface PrebuiltRoomProps {
        colors?: Partial<PrebuiltRoomColors>;
        controlBar?: Partial<PrebuiltRoomControlBarConfig>;
        controlledActiveTab?: string;
        controlledFileToOpen?: { file: unknown; tabId: string } | null;
        controlledSidebarOpen?: boolean;
        files?: unknown[];
        headerActions?: ReactNode;
        labels?: Partial<PrebuiltRoomLabels>;
        onActiveTabChanged?: (tabId: string) => void;
        onError?: (error: Error) => void;
        onFileClosed?: (tabId: string) => void;
        onFileOpened?: (tabId: string, file: unknown) => void;
        onLeave?: () => void;
        onSidebarOpenChanged?: (open: boolean) => void;
        participantList?: Partial<ParticipantListProps>;
        persistSidebarWidth?: boolean;
        roomName?: string;
        showRoomTimer?: boolean;
        sidebar?: PrebuiltRoomSidebarConfig;
        sidebarStorageKey?: string;
        styles?: Partial<PrebuiltRoomStyles>;
        userId?: string;
        videoGrid?: Partial<PrebuiltRoomVideoGridConfig>;
    }
    Index

    Properties

    colors? controlBar? controlledActiveTab? controlledFileToOpen? controlledSidebarOpen? files? headerActions? labels? onActiveTabChanged? onError? onFileClosed? onFileOpened? onLeave? onSidebarOpenChanged? participantList? persistSidebarWidth? roomName? showRoomTimer? sidebar? sidebarStorageKey? styles? userId? videoGrid?

    Properties

    colors?: Partial<PrebuiltRoomColors>

    Custom colors

    controlBar?: Partial<PrebuiltRoomControlBarConfig>

    ControlBar sub-component props (layout/onLeave/onError managed internally)

    controlledActiveTab?: string

    Controlled active tab. When provided, internal tab state is overridden.

    controlledFileToOpen?: { file: unknown; tabId: string } | null

    Controlled file to open. When provided, opens the specified file in the given tab.

    controlledSidebarOpen?: boolean

    Controlled sidebar open state. When provided, internal open/close state is overridden.

    files?: unknown[]

    File list for the Files sidebar tab. When provided, the file manager runs in library mode showing these files instead of only room-scoped files from the RTC cache. Use this to show all user files (including shared) inside a room.

    headerActions?: ReactNode

    Extra React nodes rendered in the app bar, before the clock/menu

    labels?: Partial<PrebuiltRoomLabels>

    Custom labels

    onActiveTabChanged?: (tabId: string) => void

    Called when the active sidebar tab changes

    onError?: (error: Error) => void

    Called when errors occur

    onFileClosed?: (tabId: string) => void

    Called when a file viewer is closed within a tab

    onFileOpened?: (tabId: string, file: unknown) => void

    Called when a file is opened via smart-opening (tab switch + file)

    onLeave?: () => void

    Called when user clicks leave

    onSidebarOpenChanged?: (open: boolean) => void

    Called when the sidebar open/closed state changes

    participantList?: Partial<ParticipantListProps>

    ParticipantList sub-component props

    persistSidebarWidth?: boolean

    Persist the sidebar width to localStorage across sessions

    roomName?: string

    Room name to display

    showRoomTimer?: boolean

    Show an elapsed room timer in the app bar

    false
    sidebar?: PrebuiltRoomSidebarConfig

    Sidebar configuration

    sidebarStorageKey?: string

    Custom localStorage key for persisted sidebar width (default: 'hiyve-sidebar-width')

    styles?: Partial<PrebuiltRoomStyles>

    Custom styles

    userId?: string

    User ID for features requiring identification

    videoGrid?: Partial<PrebuiltRoomVideoGridConfig>

    VideoGrid sub-component props (localVideoElementId/layout managed internally)

    Settings

    Member Visibility

    On This Page

    Properties