react-pdf-highlighter-plus

Interface ShapeCanvasProps

The props type for ShapeCanvas.

interface ShapeCanvasProps {
    isActive: boolean;
    onCancel: (() => void);
    onComplete: ((position, shape) => void);
    shapeType: ShapeType;
    strokeColor?: string;
    strokeWidth?: number;
    viewer: PDFViewer;
}

Properties

isActive onCancel onComplete shapeType strokeColor? strokeWidth? viewer

Properties

isActive

isActive: boolean

Whether shape mode is active.

onCancel

onCancel: (() => void)

Callback when shape creation is cancelled.

Type declaration

    • (): void

    • Returns void

onComplete

onComplete: ((position, shape) => void)

Callback when shape creation is complete.

Type declaration

    • (position, shape): void

    • Parameters

      Returns void

shapeType

shapeType: ShapeType

The type of shape to create.

Optional strokeColor

strokeColor?: string

Stroke color for the shape.

Default

"#000000"

Optional strokeWidth

strokeWidth?: number

Stroke width for the shape.

Default

2

viewer

viewer: PDFViewer

The PDF viewer instance.