react-pdf-highlighter-plus

Interface FreetextHighlightProps

The props type for FreetextHighlight.

interface FreetextHighlightProps {
    backgroundColor?: string;
    backgroundColorPresets?: string[];
    bounds?: string | Element;
    color?: string;
    deleteIcon?: ReactNode;
    dragIcon?: ReactNode;
    editIcon?: ReactNode;
    fontFamily?: string;
    fontSize?: string;
    highlight: ViewportHighlight;
    isScrolledTo?: boolean;
    style?: CSSProperties;
    styleIcon?: ReactNode;
    textColorPresets?: string[];
    onChange?(rect): void;
    onContextMenu?(event): void;
    onDelete?(): void;
    onEditEnd?(): void;
    onEditStart?(): void;
    onStyleChange?(style): void;
    onTextChange?(text): void;
}

Properties

backgroundColor? backgroundColorPresets? bounds? color? deleteIcon? dragIcon? editIcon? fontFamily? fontSize? highlight isScrolledTo? style? styleIcon? textColorPresets?

Methods

onChange? onContextMenu? onDelete? onEditEnd? onEditStart? onStyleChange? onTextChange?

Properties

Optional backgroundColor

backgroundColor?: string

Background color.

Optional backgroundColorPresets

backgroundColorPresets?: string[]

Custom background color presets for the style panel. Default: ["#ffffc8", "#ffcdd2", "#c8e6c9", "#bbdefb", "#e1bee7"]

Optional bounds

bounds?: string | Element

react-rnd bounds on the highlight area.

Optional color

color?: string

Text color.

Optional deleteIcon

deleteIcon?: ReactNode

Custom delete icon. Replaces the default trash icon.

Optional dragIcon

dragIcon?: ReactNode

Custom drag icon. Receives default icon as child if not provided.

Optional editIcon

editIcon?: ReactNode

Custom edit icon. Receives default icon as child if not provided.

Optional fontFamily

fontFamily?: string

Font family.

Optional fontSize

fontSize?: string

Font size (e.g., "14px").

highlight

highlight: ViewportHighlight

The highlight to be rendered as a FreetextHighlight.

Optional isScrolledTo

isScrolledTo?: boolean

Has the highlight been auto-scrolled into view?

Optional style

style?: CSSProperties

Custom styling for the container.

Optional styleIcon

styleIcon?: ReactNode

Custom style/settings icon. Receives default icon as child if not provided.

Optional textColorPresets

textColorPresets?: string[]

Custom text color presets for the style panel. Default: ["#333333", "#d32f2f", "#1976d2", "#388e3c", "#7b1fa2"]

Methods

Optional onChange

Optional onContextMenu

  • onContextMenu(event): void

  • A callback triggered on context menu.

    Parameters

    • event: MouseEvent<HTMLDivElement, MouseEvent>

    Returns void

Optional onDelete

Optional onEditEnd

Optional onEditStart

Optional onStyleChange

Optional onTextChange

  • onTextChange(text): void

  • A callback triggered whenever the text content changes.

    Parameters

    • text: string

      The new text content.

    Returns void