Skip to main content

HighlighterConfig

Interface defining the configuration options for the Highlighter class.

Properties​

autoHighlightOnClick​

autoHighlightOnClick: boolean

Whether to automatically highlight fragments on click.

hoverColor​

hoverColor: Color

Color used for hover.

hoverEnabled​

hoverEnabled: boolean

Toggles the hover functionality.

hoverName​

hoverName: string

Name of the hover event.

selectEnabled​

selectEnabled: boolean

Toggles the select functionality.

selectName​

selectName: string

Name of the selection event.

selectionColor​

selectionColor: Color

Color used for selection.

world​

world: null | World

The world in which the highlighter operates.