platform-bible-react
    Preparing search index...

    Interface FootnoteEditorProps

    Interface containing the types of the properties that are passed to the FootnoteEditor

    interface FootnoteEditorProps {
        classNameForEditor?: string;
        defaultMarkerMenuTrigger: string;
        editorOptions: EditorOptions;
        localizedStrings: FootnoteEditorLocalizedStrings;
        markerPalette?: FootnoteEditorMarkerPalette;
        noteKey: undefined | string;
        noteOps: undefined | DeltaOpInsertNoteEmbed[];
        onChange?: (noteOps: DeltaOpInsertNoteEmbed[]) => void;
        onClose: () => void;
        onNoteEdit?: () => void;
        parentEditorRef?: RefObject<null | EditorRef>;
        scrRef: SerializedVerseRef;
    }
    Index

    Properties

    classNameForEditor?: string

    Class name for styling the embedded Editor component in this editor popover

    defaultMarkerMenuTrigger: string

    Trigger key to open the footnote editor marker menu

    editorOptions: EditorOptions

    View options of the parent editor

    Localized strings to be passed to the footnote editor component

    Optional marker-palette driver (standard-view host wiring for PT9 parity). When provided in editable marker mode, a typed \ inside this popover's own editor opens the same palette the main editor uses instead of the built-in inline markers menu below; when absent, editable mode falls back to pass-through-only behavior (literal typing works, no menu) — a graceful degradation for hosts that haven't wired one up. Never consulted outside editable marker mode — the built-in MarkerMenu popup below owns that path unconditionally.

    noteKey: undefined | string

    The unique note key to identify the note being edited used to apply changes to the note

    noteOps: undefined | DeltaOpInsertNoteEmbed[]

    Delta ops for the current note being edited that are applied to the note editorial

    onChange?: (noteOps: DeltaOpInsertNoteEmbed[]) => void

    Called on every change to the footnote with the updated note ops. An implementation of this function is required only if the parent does not supply parentEditorRef or if some additional logic is needed to handle the changes. The note ops passed in this function are the full ops for the note, not just the changes since the last call.

    onClose: () => void

    External function to handle closing the footnote editor

    onNoteEdit?: () => void

    Called whenever the user edits the note in this popover: a content change (the auto-save path), a caller-type change, or a custom-caller change. NOT called for programmatic initialization (popover mount / initial content load). Carries no data — onChange is the data path — so hosts can use it as a pure liveness signal for the editing session (e.g. refreshing a staleness clock so a long live edit is never treated as an abandoned session).

    parentEditorRef?: RefObject<null | EditorRef>

    Ref to the parent editor. When provided, the footnote editor will apply changes directly to the parent editor, so the client does not need to handle this in the onChange callback.

    scrRef: SerializedVerseRef

    The scripture reference for the parent editor