Interface DefaultContextMenuOptions

Options for buildDefaultContextMenu.

interface DefaultContextMenuOptions {
    canAddTextMarkup?: () => boolean;
    onAddTextMarkup?: (
        subtype: TextMarkupAnnotationSubtype,
        color: string,
    ) => void;
    textMarkupTypes?: readonly TextMarkupAnnotationSubtype[];
}

Index

Properties

canAddTextMarkup? onAddTextMarkup? textMarkupTypes?

Properties

`Optional`canAddTextMarkup

canAddTextMarkup?: () => boolean

Additional check for enabling the markup item, e.g. a host permission.

`Optional`onAddTextMarkup

onAddTextMarkup?: (subtype: TextMarkupAnnotationSubtype, color: string) => void

Replaces the native PDF mutation. The host persists the markup for the current text selection itself, e.g. as an application annotation.

`Optional`textMarkupTypes

textMarkupTypes?: readonly TextMarkupAnnotationSubtype[]

Markup subtypes offered in the palette, in the default order. All by default.