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

    Interface RoomSummaryViewerProps

    Props for the RoomSummaryViewer component.

    interface RoomSummaryViewerProps {
        colors?: Partial<RoomSummaryViewerColors>;
        file?: FileEntry | null;
        getFilesByType?: (type: string) => Promise<FileEntry[]>;
        labels?: Partial<RoomSummaryViewerLabels>;
        onClose?: () => void;
        onEnrichSummary?: (fileId: string) => Promise<RoomSummaryData | null>;
        onFileOpen?: (file: RoomSummaryFile) => void;
        resolveDisplayName?: (userId: string, defaultName?: string) => string;
        summaryData:
            | RoomSummaryData
            | { roomSummary: RoomSummaryData
            | { roomSummary: RoomSummaryData } };
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    colors? file? getFilesByType? labels? onClose? onEnrichSummary? onFileOpen? resolveDisplayName? summaryData sx?

    Properties

    colors?: Partial<RoomSummaryViewerColors>

    Custom colors

    file?: FileEntry | null

    File entry for the summary (used for enrichment)

    getFilesByType?: (type: string) => Promise<FileEntry[]>

    Function to get files by type from cache

    labels?: Partial<RoomSummaryViewerLabels>

    Custom labels

    onClose?: () => void

    Close handler

    onEnrichSummary?: (fileId: string) => Promise<RoomSummaryData | null>

    Function to enrich summary with additional data

    onFileOpen?: (file: RoomSummaryFile) => void

    Callback to open a file from the summary

    resolveDisplayName?: (userId: string, defaultName?: string) => string

    Resolve a userId to a friendly display name (email → cleaned id → user's name → teacher-assigned nickname). When omitted, the viewer falls back to the participant's stored name, then to a title-cased version of the userId (or the auto-generated Guest-<8chars> placeholder if neither yields anything better).

    Consumers in a lesson context should pass the app's useResolveDisplayName so a teacher's nickname for a student appears in every summary row.

    summaryData:
        | RoomSummaryData
        | { roomSummary: RoomSummaryData
        | { roomSummary: RoomSummaryData } }

    Room summary data to display

    sx?: SxProps<Theme>

    MUI sx styling prop

    Settings

    Member Visibility

    On This Page

    Properties