platform-bible-react
    Preparing search index...

    Interface FootnoteEditorProps

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

    interface FootnoteEditorProps {
        noteKey: undefined | string;
        noteOps: undefined | Op[];
        onClose: () => void;
        onSave: (noteOps: Op[]) => void;
        scrRef: SerializedVerseRef;
        viewOptions: ViewOptions;
    }
    Index

    Properties

    noteKey noteOps onClose onSave scrRef viewOptions

    Properties

    noteKey: undefined | string

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

    noteOps: undefined | Op[]

    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: Op[]) => void

    External function to handle saving changes to the footnote

    scrRef: SerializedVerseRef

    The scripture reference for the parent editor

    viewOptions: ViewOptions

    View options of the parent editor

    Settings

    Member Visibility

    On This Page

    Properties