Rich text / foldkit-mixins-richtext

SlashMenu

interface · packages/richtext-dom/src/editor.ts:316

interface SlashMenu<Payload> {
  readonly query: string
  readonly matches: ReadonlyArray<SlashEntry<Payload>>
  readonly highlighted: SlashEntry<Payload> | undefined
}

What a menu shows for one caret: its query, what matches, and what Enter would send.

Members

SlashMenu.query

property · packages/richtext-dom/src/editor.ts:317

readonly query: string

SlashMenu.matches

property · packages/richtext-dom/src/editor.ts:318

readonly matches: ReadonlyArray<SlashEntry<Payload>>

SlashMenu.highlighted

property · packages/richtext-dom/src/editor.ts:320

readonly highlighted: SlashEntry<Payload> | undefined

The entry Enter would choose; undefined when nothing matches the query.