Function Highlighter

  • Highlighter(
        props: {
            cssSelectionColor?: string;
            enableAreaSelection?: (event: MouseEvent) => boolean;
            highlights: Highlights;
            layerBackgroundColor?: string;
            layerScrolledToBackgroundColor?: string;
            pdfDocument?: PDFDocumentProxy;
            pdfViewer?: PDFViewer;
            renderHighlightLayer: () => Element;
        } & { children?: ReactNode } & RefAttributes<HighlighterRef>,
    ): ReactNode

    Parameters

    • props: {
          cssSelectionColor?: string;
          enableAreaSelection?: (event: MouseEvent) => boolean;
          highlights: Highlights;
          layerBackgroundColor?: string;
          layerScrolledToBackgroundColor?: string;
          pdfDocument?: PDFDocumentProxy;
          pdfViewer?: PDFViewer;
          renderHighlightLayer: () => Element;
      } & { children?: ReactNode } & RefAttributes<HighlighterRef>
      • OptionalcssSelectionColor?: string

        CSS selection highlight color

        Default

        "rgba(255, 226, 143, 0.5)"
      • OptionalenableAreaSelection?: (event: MouseEvent) => boolean

        Area selection enablement control

      • highlights: Highlights

        Collection of highlight data

        Default

        []
      • OptionallayerBackgroundColor?: string

        Background color for highlight layers

        Default

        "rgba(255, 226, 143, 0.5)"
      • OptionallayerScrolledToBackgroundColor?: string

        Background color when scrolled to a highlight

        Default

        "rgba(255, 226, 143, 0.8)"
      • OptionalpdfDocument?: PDFDocumentProxy

        PDF document proxy instance (from PDF.js)

      • OptionalpdfViewer?: PDFViewer

        PDF viewer instance (from PDF.js)

      • renderHighlightLayer: () => Element

        Render function for highlight overlay layer

      • Optionalchildren?: ReactNode

    Returns ReactNode

Properties

$$typeof defaultProps? displayName? propTypes?

Properties

Readonly$$typeof

$$typeof: symbol

OptionaldefaultProps

defaultProps?: Partial<
    {
        cssSelectionColor?: string;
        enableAreaSelection?: (event: MouseEvent) => boolean;
        highlights: Highlights;
        layerBackgroundColor?: string;
        layerScrolledToBackgroundColor?: string;
        pdfDocument?: PDFDocumentProxy;
        pdfViewer?: PDFViewer;
        renderHighlightLayer: () => Element;
    } & { children?: ReactNode } & RefAttributes<HighlighterRef>,
>

Deprecated

Use values for destructuring assignments instead.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

OptionalpropTypes

propTypes?: WeakValidationMap<
    {
        cssSelectionColor?: string;
        enableAreaSelection?: (event: MouseEvent) => boolean;
        highlights: Highlights;
        layerBackgroundColor?: string;
        layerScrolledToBackgroundColor?: string;
        pdfDocument?: PDFDocumentProxy;
        pdfViewer?: PDFViewer;
        renderHighlightLayer: () => Element;
    } & { children?: ReactNode } & RefAttributes<HighlighterRef>,
>

Settings

Member Visibility

On This Page

Properties