Rich text / foldkit-mixins-richtext

FootnotePreviewInput

interface · packages/mixins-richtext/src/footnote.ts:20

interface FootnotePreviewInput<Message> {
  readonly document: RichText.Document
  readonly selection: RichText.Selection | null
  readonly opened: (definition: RichText.NodeId) => Message
  readonly wrap: (message: EditorEvent) => Message
}

Members

FootnotePreviewInput.document

property · packages/mixins-richtext/src/footnote.ts:21

readonly document: RichText.Document

FootnotePreviewInput.selection

property · packages/mixins-richtext/src/footnote.ts:22

readonly selection: RichText.Selection | null

FootnotePreviewInput.opened

property · packages/mixins-richtext/src/footnote.ts:24

readonly opened: (definition: RichText.NodeId) => Message

Go to the note: the caller puts the caret at the definition's start (focus).

FootnotePreviewInput.wrap

property · packages/mixins-richtext/src/footnote.ts:26

readonly wrap: (message: EditorEvent) => Message

An editor Message as this caller's, usually its edited(...) wrapper.