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

    Interface ParticipantListProps

    Props for the ParticipantList component.

    interface ParticipantListProps {
        colors?: Partial<ParticipantListColors>;
        labels?: Partial<ParticipantListLabels>;
        localUserId: string | null;
        ownerId?: string;
        participants: Participant[];
        showHeader?: boolean;
    }
    Index

    Properties

    colors? labels? localUserId ownerId? participants showHeader?

    Properties

    colors?: Partial<ParticipantListColors>

    Partial color overrides merged with built-in defaults. See ParticipantListColors.

    labels?: Partial<ParticipantListLabels>

    Partial label overrides merged with built-in defaults. See ParticipantListLabels.

    localUserId: string | null

    The local user's ID. Used to append the "(You)" suffix to the local user's row.

    ownerId?: string

    User ID of the room owner/host. When a participant matches this ID, the "Host" status label is shown.

    participants: Participant[]

    Array of participants to display. Typically the combined list of local + remote participants from useParticipants.

    showHeader?: boolean

    Whether to display the header row showing the title and participant count.

    true

    Settings

    Member Visibility

    On This Page

    Properties