@embedpdf/plugin-annotation 2.10.1 → 2.11.0

package/dist/shared/components/types.d.ts

@@ -1,5 +1,5 @@
 import { PdfAnnotationObject, PdfBlendMode, Rect } from '@embedpdf/models';
-import { TrackedAnnotation } from '../../index.ts';
+import { TrackedAnnotation, PreviewState } from '../../index.ts';
 import { HandleElementProps, SelectionMenuPropsBase, SelectionMenuRenderFn } from '../../react/utils.ts';
 import { JSX, CSSProperties, MouseEvent } from '../../react/adapter.ts';
 import { VertexConfig } from '../types';
@@ -144,16 +144,24 @@ export interface SelectOverrideHelpers {
 export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject, P = never> {
     /** Unique identifier for this renderer (usually matches tool id) */
     id: string;
-    /** Returns true if this renderer should handle the annotation */
-    matches: (annotation: PdfAnnotationObject) => annotation is T;
-    /** The component to render the annotation */
-    render: (props: AnnotationRendererProps<T>) => JSX.Element;
+    /** Returns true if this renderer should handle the annotation. Optional for preview-only renderers. */
+    matches?: (annotation: PdfAnnotationObject) => annotation is T;
+    /** The component to render the annotation. Optional for preview-only renderers. */
+    render?: (props: AnnotationRendererProps<T>) => JSX.Element;
+    /** Returns true if this renderer should handle the given preview state */
+    matchesPreview?: (preview: PreviewState) => boolean;
     /** Render a preview during drag-to-create. P is the preview data type. */
     renderPreview?: (props: {
         data: P;
         bounds: Rect;
         scale: number;
     }) => JSX.Element;
+    /** Extra styles merged onto the preview container div (e.g. mixBlendMode for ink). */
+    previewContainerStyle?: (props: {
+        data: P;
+        bounds: Rect;
+        scale: number;
+    }) => CSSProperties;
     /** Vertex configuration for annotations with draggable vertices (line, polyline, polygon) */
     vertexConfig?: VertexConfig<T>;
     /** z-index for the annotation container (default: 1, text markup uses 0) */
@@ -194,11 +202,17 @@ export interface BoxedAnnotationRenderer {
     id: string;
     matches: (annotation: PdfAnnotationObject) => boolean;
     render: (props: AnnotationRendererProps) => JSX.Element;
+    matchesPreview?: (preview: PreviewState) => boolean;
     renderPreview?: (props: {
         data: unknown;
         bounds: Rect;
         scale: number;
     }) => JSX.Element;
+    previewContainerStyle?: (props: {
+        data: unknown;
+        bounds: Rect;
+        scale: number;
+    }) => CSSProperties;
     vertexConfig?: VertexConfig<PdfAnnotationObject>;
     zIndex?: number;
     defaultBlendMode?: PdfBlendMode;

package/dist/shared-preact/components/types.d.ts

@@ -1,5 +1,5 @@
 import { PdfAnnotationObject, PdfBlendMode, Rect } from '@embedpdf/models';
-import { TrackedAnnotation } from '../../lib/index.ts';
+import { TrackedAnnotation, PreviewState } from '../../lib/index.ts';
 import { HandleElementProps, SelectionMenuPropsBase, SelectionMenuRenderFn } from '../../preact/utils.ts';
 import { JSX, CSSProperties, MouseEvent } from '../../preact/adapter.ts';
 import { VertexConfig } from '../types';
@@ -144,16 +144,24 @@ export interface SelectOverrideHelpers {
 export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject, P = never> {
     /** Unique identifier for this renderer (usually matches tool id) */
     id: string;
-    /** Returns true if this renderer should handle the annotation */
-    matches: (annotation: PdfAnnotationObject) => annotation is T;
-    /** The component to render the annotation */
-    render: (props: AnnotationRendererProps<T>) => JSX.Element;
+    /** Returns true if this renderer should handle the annotation. Optional for preview-only renderers. */
+    matches?: (annotation: PdfAnnotationObject) => annotation is T;
+    /** The component to render the annotation. Optional for preview-only renderers. */
+    render?: (props: AnnotationRendererProps<T>) => JSX.Element;
+    /** Returns true if this renderer should handle the given preview state */
+    matchesPreview?: (preview: PreviewState) => boolean;
     /** Render a preview during drag-to-create. P is the preview data type. */
     renderPreview?: (props: {
         data: P;
         bounds: Rect;
         scale: number;
     }) => JSX.Element;
+    /** Extra styles merged onto the preview container div (e.g. mixBlendMode for ink). */
+    previewContainerStyle?: (props: {
+        data: P;
+        bounds: Rect;
+        scale: number;
+    }) => CSSProperties;
     /** Vertex configuration for annotations with draggable vertices (line, polyline, polygon) */
     vertexConfig?: VertexConfig<T>;
     /** z-index for the annotation container (default: 1, text markup uses 0) */
@@ -194,11 +202,17 @@ export interface BoxedAnnotationRenderer {
     id: string;
     matches: (annotation: PdfAnnotationObject) => boolean;
     render: (props: AnnotationRendererProps) => JSX.Element;
+    matchesPreview?: (preview: PreviewState) => boolean;
     renderPreview?: (props: {
         data: unknown;
         bounds: Rect;
         scale: number;
     }) => JSX.Element;
+    previewContainerStyle?: (props: {
+        data: unknown;
+        bounds: Rect;
+        scale: number;
+    }) => CSSProperties;
     vertexConfig?: VertexConfig<PdfAnnotationObject>;
     zIndex?: number;
     defaultBlendMode?: PdfBlendMode;

package/dist/shared-react/components/types.d.ts

@@ -1,5 +1,5 @@
 import { PdfAnnotationObject, PdfBlendMode, Rect } from '@embedpdf/models';
-import { TrackedAnnotation } from '../../lib/index.ts';
+import { TrackedAnnotation, PreviewState } from '../../lib/index.ts';
 import { HandleElementProps, SelectionMenuPropsBase, SelectionMenuRenderFn } from '../../react/utils.ts';
 import { JSX, CSSProperties, MouseEvent } from '../../react/adapter.ts';
 import { VertexConfig } from '../types';
@@ -144,16 +144,24 @@ export interface SelectOverrideHelpers {
 export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject, P = never> {
     /** Unique identifier for this renderer (usually matches tool id) */
     id: string;
-    /** Returns true if this renderer should handle the annotation */
-    matches: (annotation: PdfAnnotationObject) => annotation is T;
-    /** The component to render the annotation */
-    render: (props: AnnotationRendererProps<T>) => JSX.Element;
+    /** Returns true if this renderer should handle the annotation. Optional for preview-only renderers. */
+    matches?: (annotation: PdfAnnotationObject) => annotation is T;
+    /** The component to render the annotation. Optional for preview-only renderers. */
+    render?: (props: AnnotationRendererProps<T>) => JSX.Element;
+    /** Returns true if this renderer should handle the given preview state */
+    matchesPreview?: (preview: PreviewState) => boolean;
     /** Render a preview during drag-to-create. P is the preview data type. */
     renderPreview?: (props: {
         data: P;
         bounds: Rect;
         scale: number;
     }) => JSX.Element;
+    /** Extra styles merged onto the preview container div (e.g. mixBlendMode for ink). */
+    previewContainerStyle?: (props: {
+        data: P;
+        bounds: Rect;
+        scale: number;
+    }) => CSSProperties;
     /** Vertex configuration for annotations with draggable vertices (line, polyline, polygon) */
     vertexConfig?: VertexConfig<T>;
     /** z-index for the annotation container (default: 1, text markup uses 0) */
@@ -194,11 +202,17 @@ export interface BoxedAnnotationRenderer {
     id: string;
     matches: (annotation: PdfAnnotationObject) => boolean;
     render: (props: AnnotationRendererProps) => JSX.Element;
+    matchesPreview?: (preview: PreviewState) => boolean;
     renderPreview?: (props: {
         data: unknown;
         bounds: Rect;
         scale: number;
     }) => JSX.Element;
+    previewContainerStyle?: (props: {
+        data: unknown;
+        bounds: Rect;
+        scale: number;
+    }) => CSSProperties;
     vertexConfig?: VertexConfig<PdfAnnotationObject>;
     zIndex?: number;
     defaultBlendMode?: PdfBlendMode;

package/dist/svelte/components/annotations/CirclePreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { CirclePreviewData } from '../../../lib/index.ts';
+interface CirclePreviewProps {
+    data: CirclePreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const CirclePreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<CirclePreviewProps, {}, "">;
+type CirclePreview = ReturnType<typeof CirclePreview>;
+export default CirclePreview;

package/dist/svelte/components/annotations/FreeTextPreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { FreeTextPreviewData } from '../../../lib/index.ts';
+interface FreeTextPreviewProps {
+    data: FreeTextPreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const FreeTextPreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<FreeTextPreviewProps, {}, "">;
+type FreeTextPreview = ReturnType<typeof FreeTextPreview>;
+export default FreeTextPreview;

package/dist/svelte/components/annotations/InkPreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { InkPreviewData } from '../../../lib/index.ts';
+interface InkPreviewProps {
+    data: InkPreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const InkPreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<InkPreviewProps, {}, "">;
+type InkPreview = ReturnType<typeof InkPreview>;
+export default InkPreview;

package/dist/svelte/components/annotations/LinePreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { LinePreviewData } from '../../../lib/index.ts';
+interface LinePreviewProps {
+    data: LinePreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const LinePreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<LinePreviewProps, {}, "">;
+type LinePreview = ReturnType<typeof LinePreview>;
+export default LinePreview;

package/dist/svelte/components/annotations/PolygonPreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { PolygonPreviewData } from '../../../lib/index.ts';
+interface PolygonPreviewProps {
+    data: PolygonPreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const PolygonPreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<PolygonPreviewProps, {}, "">;
+type PolygonPreview = ReturnType<typeof PolygonPreview>;
+export default PolygonPreview;

package/dist/svelte/components/annotations/PolylinePreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { PolylinePreviewData } from '../../../lib/index.ts';
+interface PolylinePreviewProps {
+    data: PolylinePreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const PolylinePreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<PolylinePreviewProps, {}, "">;
+type PolylinePreview = ReturnType<typeof PolylinePreview>;
+export default PolylinePreview;

package/dist/svelte/components/annotations/SquarePreview.svelte.d.ts

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { SquarePreviewData } from '../../../lib/index.ts';
+interface SquarePreviewProps {
+    data: SquarePreviewData;
+    bounds: Rect;
+    scale: number;
+}
+declare const SquarePreview: import('svelte', { with: { "resolution-mode": "import" } }).Component<SquarePreviewProps, {}, "">;
+type SquarePreview = ReturnType<typeof SquarePreview>;
+export default SquarePreview;

package/dist/svelte/context/types.d.ts

@@ -1,6 +1,6 @@
 import { Component } from 'svelte';
 import { PdfAnnotationObject, PdfBlendMode, Rect } from '@embedpdf/models';
-import { TrackedAnnotation } from '../../lib/index.ts';
+import { TrackedAnnotation, PreviewState } from '../../lib/index.ts';
 import { VertexConfig } from '../../shared-svelte/types';
 /**
  * Properly typed event for annotation interactions (click, select, etc.)
@@ -38,10 +38,10 @@ export interface SelectOverrideHelpers {
 export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject, P = never> {
     /** Unique identifier for this renderer */
     id: string;
-    /** Returns true if this renderer handles the annotation */
-    matches: (annotation: PdfAnnotationObject) => annotation is T;
-    /** Svelte component to render the annotation */
-    component: Component<AnnotationRendererProps<T>>;
+    /** Returns true if this renderer handles the annotation. Optional for preview-only renderers. */
+    matches?: (annotation: PdfAnnotationObject) => annotation is T;
+    /** Svelte component to render the annotation. Optional for preview-only renderers. */
+    component?: Component<AnnotationRendererProps<T>>;
     /** Vertex configuration for annotations with draggable vertices (line, polyline, polygon) */
     vertexConfig?: VertexConfig<T>;
     /** z-index for the annotation container (default: 1, text markup uses 0) */
@@ -69,12 +69,20 @@ export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnno
     selectOverride?: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation<T>, helpers: SelectOverrideHelpers) => void;
     /** Return true to hide the selection menu for this annotation */
     hideSelectionMenu?: (annotation: T) => boolean;
+    /** Returns true if this renderer should handle the given preview state */
+    matchesPreview?: (preview: PreviewState) => boolean;
     /** Render a preview during drag-to-create. P is the preview data type. */
     renderPreview?: Component<{
         data: P;
         bounds: Rect;
         scale: number;
     }>;
+    /** Extra styles merged onto the preview container div (e.g. mix-blend-mode for ink). */
+    previewContainerStyle?: (props: {
+        data: P;
+        bounds: Rect;
+        scale: number;
+    }) => string;
     /** When true, the annotation is completely hidden when locked (e.g., form widgets defer to the form-filling layer). */
     hiddenWhenLocked?: boolean;
     /** Optional locked-mode renderer. When the annotation is locked, this replaces `component` inside the container. */
@@ -105,11 +113,17 @@ export interface BoxedAnnotationRenderer {
     onDoubleClick?: (annotationId: string, setEditingId: (id: string) => void) => void;
     selectOverride?: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation, helpers: SelectOverrideHelpers) => void;
     hideSelectionMenu?: (annotation: PdfAnnotationObject) => boolean;
+    matchesPreview?: (preview: PreviewState) => boolean;
     renderPreview?: Component<{
         data: unknown;
         bounds: Rect;
         scale: number;
     }>;
+    previewContainerStyle?: (props: {
+        data: unknown;
+        bounds: Rect;
+        scale: number;
+    }) => string;
     hiddenWhenLocked?: boolean;
     renderLocked?: Component<AnnotationRendererProps>;
 }