react-pdf-highlighter-extended

Interface TextHighlightProps

The props type for TextHighlight.

interface TextHighlightProps {
    highlight: ViewportHighlight;
    isScrolledTo: boolean;
    style?: CSSProperties;
    onClick?(event): void;
    onContextMenu?(event): void;
    onMouseOut?(event): void;
    onMouseOver?(event): void;
}

Properties

highlight isScrolledTo style?

Methods

onClick? onContextMenu? onMouseOut? onMouseOver?

Properties

highlight

highlight: ViewportHighlight

Highlight to render over text.

isScrolledTo

isScrolledTo: boolean

Indicates whether the component is autoscrolled into view, affecting default theming.

Optional style

style?: CSSProperties

Optional CSS styling applied to each TextHighlight part.

Methods

Optional onClick

  • onClick(event): void

  • Callback triggered whenever the user clicks on the part of a highlight.

    Parameters

    • event: MouseEvent<HTMLDivElement, MouseEvent>

      Mouse event associated with click.

    Returns void

Optional onContextMenu

  • onContextMenu(event): void

  • Callback triggered whenever the user tries to open context menu on highlight.

    Parameters

    • event: MouseEvent<HTMLDivElement, MouseEvent>

      Mouse event associated with click.

    Returns void

Optional onMouseOut

  • onMouseOut(event): void

  • Callback triggered whenever the user leaves the area of a text highlight.

    Parameters

    • event: MouseEvent<HTMLDivElement, MouseEvent>

      Mouse event associated with movement.

    Returns void

Optional onMouseOver

  • onMouseOver(event): void

  • Callback triggered whenever the user enters the area of a text highlight.

    Parameters

    • event: MouseEvent<HTMLDivElement, MouseEvent>

      Mouse event associated with movement.

    Returns void