Trevixal API
    Preparing search index...

    Interface AngularEditorOptions

    Angular bindings for the Trevixal editor.

    There is no @Component, @Directive or @Injectable here, and that is deliberate. A package that ships those has to be built by Angular's own compiler into partial-Ivy output, which is a second toolchain for the sake of a few dozen lines of glue, and a hand-rolled imitation of that output would be worse than none, which is why this adapter was deferred for so long (ADR-0007).

    What the glue actually needs from Angular is signal, which is an ordinary function. So this ships ordinary functions: your component owns the decorators, and nothing here needs compiling beyond TypeScript.

    It is zoneless by construction. The snapshot is a signal, so a change notifies exactly the templates that read it, no NgZone, no markForCheck, and no re-render of anything else while somebody types.

    interface AngularEditorOptions {
        announce?: boolean;
        ariaLabel?: string;
        autofocus?: boolean;
        content?: NodeJSON;
        doc?: EditorNode;
        editable?: boolean;
        element?: HTMLElement | null;
        history?: HistoryOptions;
        inputRules?: readonly InputRule[];
        keymap?: Readonly<Record<string, KeyBinding>>;
        maxLength?: number;
        nodeViews?: Readonly<Record<string, NodeViewFactory>>;
        onChange?: (change: EditorChange) => void;
        placeholder?: string;
        schema: Schema;
        spellcheck?: boolean;
        view?: EditorViewOptions;
    }

    Hierarchy

    • EditorOptions
      • AngularEditorOptions
    Index
    announce? ariaLabel? autofocus? content? doc? editable? element? history? inputRules? keymap? maxLength? nodeViews? onChange? placeholder? schema spellcheck? view?
    announce?: boolean

    Announce structural edits to assistive technology; see EditorViewOptions.announce. On by default. Ignored without an element: a headless editor has no live region to write to.

    ariaLabel?: string

    Accessible name for the surface; see EditorViewOptions.ariaLabel.

    autofocus?: boolean

    Optional Readonlycontent

    content?: NodeJSON

    Initial content as canonical JSON.

    doc?: EditorNode
    editable?: boolean

    Start read-only. Flip at runtime with Editor.setEditable.

    element?: HTMLElement | null

    Mount point for the contenteditable view. Omit for a headless editor.

    history?: HistoryOptions
    inputRules?: readonly InputRule[]

    Replaces the default markdown-style input rules when provided.

    keymap?: Readonly<Record<string, KeyBinding>>

    Extra key bindings for the view; they win over the base keymap.

    maxLength?: number

    Reject edits that would push the character count past this limit.

    nodeViews?: Readonly<Record<string, NodeViewFactory>>

    Custom renderers per node type (framework components in the document).

    onChange?: (change: EditorChange) => void
    placeholder?: string

    Text shown while the document is empty.

    schema: Schema
    spellcheck?: boolean

    Browser spell checking on the editing surface. Left to the browser's default when omitted; flip at runtime with Editor.setSpellcheck.

    view?: EditorViewOptions

    Options for the view, applied when AngularEditor.attach is called.

    Settings
    Member Visibility

    On This Page
    Properties