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

    Interface ActiveRoomCardProps

    Props for the ActiveRoomCard component.

    interface ActiveRoomCardProps {
        colors?: Partial<ActiveRoomCardColors>;
        displayName?: string;
        icons?: Partial<ActiveRoomCardIcons>;
        labels?: Partial<ActiveRoomCardLabels>;
        onError?: (error: Error) => void;
        onJoin?: (room: ActiveRoom) => void;
        room: ActiveRoom;
        styles?: Partial<ActiveRoomCardStyles>;
    }
    Index

    Properties

    colors? displayName? icons? labels? onError? onJoin? room styles?

    Properties

    colors?: Partial<ActiveRoomCardColors>

    Custom colors

    displayName?: string

    Human-readable title to show instead of room.name. Use this when the room's wire name is an internal id and you have a friendlier label (e.g. a classroom name). Falls back to room.name when omitted. The join action and accessibility labels still use room.name.

    icons?: Partial<ActiveRoomCardIcons>

    Custom icons

    labels?: Partial<ActiveRoomCardLabels>

    Custom labels

    onError?: (error: Error) => void

    Error callback

    onJoin?: (room: ActiveRoom) => void

    Called when the join button is clicked

    room: ActiveRoom

    The active room to display

    styles?: Partial<ActiveRoomCardStyles>

    Custom styles

    Settings

    Member Visibility

    On This Page

    Properties