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

    Interface AssignmentSessionProps

    Props for the AssignmentSession component.

    The AssignmentSession component manages the assignment editing experience within a session context, including empty state handling, session header, and integration with the session file list.

    import { AssignmentSession } from '@hiyve/react-assignments';

    function AssignmentsTab() {
      return (
        <AssignmentSession
          assignmentEditorProps={{
            enableAutoSave: true,
            enableActivityTracking: true,
          }}
        />
      );
    }
    interface AssignmentSessionProps {
        assignmentEditorProps?: Omit<
            AssignmentEditorProps,
            | "initialContent"
            | "initialTitle"
            | "initialAssignment"
            | "fileId"
            | "onAutoSave"
            | "showHeader"
            | "ref",
        >;
        fileToOpen?: FileEntry;
        labels?: AssignmentSessionLabels;
        onError?: (error: Error) => void;
        roomName?: string;
        storageKey?: string;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    assignmentEditorProps? fileToOpen? labels? onError? roomName? storageKey? sx?

    Properties

    assignmentEditorProps?: Omit<
        AssignmentEditorProps,
        | "initialContent"
        | "initialTitle"
        | "initialAssignment"
        | "fileId"
        | "onAutoSave"
        | "showHeader"
        | "ref",
    >

    Props forwarded to the AssignmentEditor (some props are managed by the session)

    fileToOpen?: FileEntry

    File to open programmatically (e.g. from FileManager smart opening)

    labels?: AssignmentSessionLabels

    Custom labels for session UI elements

    onError?: (error: Error) => void

    Called when errors occur (file loading, saving)

    roomName?: string

    Room name for filtering files to current room

    storageKey?: string

    localStorage key for persisting filter and sort state

    sx?: SxProps<Theme>

    MUI sx styling prop

    Settings

    Member Visibility

    On This Page

    Properties