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

    Interface UseAssignmentEditorOptions

    Options for the useAssignmentEditor hook.

    Configures the TipTap editor instance with assignment-specific extensions and behavior. The hook manages editor lifecycle including initialization, content updates, and cleanup.

    interface UseAssignmentEditorOptions {
        editable?: boolean;
        extensions?: { highlight?: boolean; tables?: boolean; taskLists?: boolean };
        initialContent?: JSONContent;
        onBlur?: () => void;
        onFocus?: () => void;
        onUpdate?: (content: JSONContent) => void;
        placeholder?: string;
    }
    Index

    Properties

    editable?: boolean

    Whether the editor is editable

    extensions?: { highlight?: boolean; tables?: boolean; taskLists?: boolean }

    Extension options

    Type Declaration

    • Optionalhighlight?: boolean

      Enable highlighting (default: true)

    • Optionaltables?: boolean

      Enable table support (default: true)

    • OptionaltaskLists?: boolean

      Enable task lists (default: true)

    initialContent?: JSONContent

    Initial content for the editor

    onBlur?: () => void

    Callback when editor is blurred

    onFocus?: () => void

    Callback when editor is focused

    onUpdate?: (content: JSONContent) => void

    Callback when content updates

    placeholder?: string

    Placeholder text when empty