platform-bible-react
    Preparing search index...

    Interface FootnoteEditorMarkerPalette

    Driver for the standard-view \ marker palette (PT9 parity), supplied by a host that wires it to its own overlay/command-palette implementation (e.g. papi.overlays.* keyed by webViewId in the platform-scripture-editor web view). Extends the shared PaletteDriver contract (update/commit/dismiss — from platform-bible-utils/experimental, outside this package's docs entry, so a code reference rather than a link) with the open step.

    interface FootnoteEditorMarkerPalette {
        commit(): void;
        dismiss(): void;
        show(
            items: PaletteItem[],
            anchor: { height?: number; width?: number; x: number; y: number },
            passive: boolean,
            keyForwarding?: PaletteKeyForwarding,
        ): Promise<undefined | string>;
        update(update: { filterText?: string; moveSelection?: number }): void;
    }

    Hierarchy

    • PaletteDriver
      • FootnoteEditorMarkerPalette
    Index

    Methods

    commit dismiss show update

    Methods

    • Shows the palette anchored at the given position. passive mirrors CommandPaletteRequest.passive — when true, the palette never steals focus and its filter and highlighted selection are driven externally via the driver's update.

      Parameters

      • items: PaletteItem[]
      • anchor: { height?: number; width?: number; x: number; y: number }
      • passive: boolean
      • OptionalkeyForwarding: PaletteKeyForwarding

        Keys the session claims while the palette is open. The palette forwards exactly these back instead of acting on them, so the session's semantics run whichever document holds focus — without it, a palette that takes focus silently takes the session's keys with it.

      Returns Promise<undefined | string>

      The selected item's id, or undefined if dismissed.

    • Updates the filter text and/or moves the highlighted selection of the active palette.

      Parameters

      • update: { filterText?: string; moveSelection?: number }

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods