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

    Interface AssignmentViewerProps

    interface AssignmentViewerProps {
        activityTickMs?: number;
        assignment?: AssignmentFile;
        colors?: Partial<AssignmentEditorColors>;
        content?: JSONContent;
        hideTitle?: boolean;
        maxHeight?: string | number;
        minHeight?: string | number;
        onActivityTick?: (elapsedSeconds: number) => void;
        onOpenEmbed?: EmbedOpenCallback;
        resolveFile?: EmbedFileResolver;
        title?: string;
    }
    Index

    Properties

    activityTickMs? assignment? colors? content? hideTitle? maxHeight? minHeight? onActivityTick? onOpenEmbed? resolveFile? title?

    Properties

    activityTickMs?: number

    Tick interval in milliseconds. Default 30s.

    assignment?: AssignmentFile

    Either a full assignment document or just its rich-text body. When an AssignmentFile is supplied, the viewer additionally renders the title and (if present) the due date / time estimate header.

    colors?: Partial<AssignmentEditorColors>

    Color overrides; merged with sensible defaults.

    Optionalcontent

    content?: JSONContent

    Body content — supplied when assignment isn't (preview mode etc.).

    hideTitle?: boolean

    Hide the assignment title row (the body is always rendered).

    maxHeight?: string | number

    Max height — when set, the body scrolls.

    minHeight?: string | number

    Min height for the rendered body area (CSS length). Default 200.

    onActivityTick?: (elapsedSeconds: number) => void

    Optional periodic activity tick. Fires every activityTickMs milliseconds while the viewer is mounted and visible. Consumers wire this to their own activity-tracking; the SDK doesn't persist it.

    onOpenEmbed?: EmbedOpenCallback

    Called when the user clicks an embedded file's open action.

    resolveFile?: EmbedFileResolver

    Resolve a fileId to a URL the viewer can render (image thumbnails etc.).

    title?: string

    Override the title rendering. Defaults to assignment?.title.

    Settings

    Member Visibility

    On This Page

    Properties