react-pdf-highlighter-plus

Interface ExportableHighlight

A highlight that can be exported to PDF.

interface ExportableHighlight {
    backgroundColor?: string;
    color?: string;
    content?: {
        image?: string;
        shape?: ShapeData;
        text?: string;
    };
    fontFamily?: string;
    fontSize?: string;
    highlightColor?: string;
    highlightStyle?: "underline" | "highlight" | "strikethrough";
    id: string;
    position: ScaledPosition;
    shapeType?: "rectangle" | "circle" | "arrow";
    strokeColor?: string;
    strokeWidth?: number;
    type?: "text" | "area" | "freetext" | "image" | "drawing" | "shape";
}

Properties

backgroundColor? color? content? fontFamily? fontSize? highlightColor? highlightStyle? id position shapeType? strokeColor? strokeWidth? type?

Properties

Optional backgroundColor

backgroundColor?: string

Background color for freetext highlights

Optional color

color?: string

Text color for freetext highlights

Optional content

content?: {
    image?: string;
    shape?: ShapeData;
    text?: string;
}

Type declaration

  • Optional image?: string
  • Optional shape?: ShapeData
  • Optional text?: string

Optional fontFamily

fontFamily?: string

Font family for freetext highlights (not used in export, Helvetica is always used)

Optional fontSize

fontSize?: string

Font size for freetext highlights

Optional highlightColor

highlightColor?: string

Per-highlight color override (for text/area highlights)

Optional highlightStyle

highlightStyle?: "underline" | "highlight" | "strikethrough"

Style mode for text highlights: "highlight" (default), "underline", or "strikethrough"

id

id: string

position

position: ScaledPosition

Optional shapeType

shapeType?: "rectangle" | "circle" | "arrow"

Shape type for shape highlights

Optional strokeColor

strokeColor?: string

Stroke color for shape highlights

Optional strokeWidth

strokeWidth?: number

Stroke width for shape highlights

Optional type

type?: "text" | "area" | "freetext" | "image" | "drawing" | "shape"