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

    Interface ActiveRoomsListProps

    Props for the ActiveRoomsList component.

    interface ActiveRoomsListProps {
        cardColors?: Partial<ActiveRoomCardColors>;
        cardIcons?: Partial<ActiveRoomCardIcons>;
        cardLabels?: Partial<ActiveRoomCardLabels>;
        cardStyles?: Partial<ActiveRoomCardStyles>;
        emptyStateContent?: ReactNode;
        labels?: Partial<ActiveRoomsListLabels>;
        onError?: (error: Error) => void;
        onJoinRoom?: (room: ActiveRoom) => void;
        renderCard?: (
            room: ActiveRoom,
            onJoin?: (room: ActiveRoom) => void,
        ) => ReactNode;
        showSearch?: boolean;
        showTitle?: boolean;
        streamUrl?: string;
    }
    Index

    Properties

    cardColors? cardIcons? cardLabels? cardStyles? emptyStateContent? labels? onError? onJoinRoom? renderCard? showSearch? showTitle? streamUrl?

    Properties

    cardColors?: Partial<ActiveRoomCardColors>

    Colors passed to each ActiveRoomCard

    cardIcons?: Partial<ActiveRoomCardIcons>

    Icons passed to each ActiveRoomCard

    cardLabels?: Partial<ActiveRoomCardLabels>

    Labels passed to each ActiveRoomCard

    cardStyles?: Partial<ActiveRoomCardStyles>

    Styles passed to each ActiveRoomCard

    emptyStateContent?: ReactNode

    Custom empty state content

    labels?: Partial<ActiveRoomsListLabels>

    Labels for the list component

    onError?: (error: Error) => void

    Error callback

    onJoinRoom?: (room: ActiveRoom) => void

    Called when a room's join button is clicked

    renderCard?: (
        room: ActiveRoom,
        onJoin?: (room: ActiveRoom) => void,
    ) => ReactNode

    Custom render function for each room card

    showSearch?: boolean

    Whether to show the search bar

    true
    showTitle?: boolean

    Whether to show the title

    true
    streamUrl?: string

    SSE stream URL for real-time updates (from await cloudClient.getActiveRoomsStreamUrl(userId)). When provided, the list opens the stream on mount and closes it on unmount. Omit when a parent already manages the active-rooms connection (via connectActiveRooms) — the list then renders from the shared store without touching the connection.

    Settings

    Member Visibility

    On This Page

    Properties