Interface FootnoteEditorProps

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

interface FootnoteEditorProps {
    editorOptions: EditorOptions;
    localizedStrings: FootnoteEditorLocalizedStrings;
    noteKey: undefined | string;
    noteOps: undefined | DeltaOpInsertNoteEmbed[];
    onClose: () => void;
    onSave: (noteOps: DeltaOpInsertNoteEmbed[]) => void;
    scrRef: SerializedVerseRef;
}

Properties

editorOptions: EditorOptions

View options of the parent editor

Localized strings to be passed to the footnote editor component

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

onClose: () => void

External function to handle closing the footnote editor. Gets called when the editor is closed without saving changes

onSave: (noteOps: DeltaOpInsertNoteEmbed[]) => void

External function to handle saving changes to the footnote

scrRef: SerializedVerseRef

The scripture reference for the parent editor