@libresign/pdf-elements 0.3.1 → 1.0.0

package/README.md

@@ -5,10 +5,16 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 
 # PDF Elements
 
-A Vue 2 component for rendering PDFs with draggable and resizable element overlays.
+A Vue 3 component for rendering PDFs with draggable and resizable element overlays.
 
 **[Demo](https://libresign.github.io/pdf-elements/)** · [Examples](examples/)
 
+## Development
+
+- `npm run dev` - Run the demo with Vite
+- `npm run build` - Build the library (ESM + types)
+- `npm run build:demo` - Build the demo to `dist-demo`
+
 ## API
 
 ### Props
@@ -28,6 +34,23 @@ A Vue 2 component for rendering PDFs with draggable and resizable element overla
 | `ignoreClickOutsideSelectors` | Array | `[]` | CSS selectors that keep the selection active when clicking outside the element |
 | `pageCountFormat` | String | `'{currentPage} of {totalPages}'` | Format string for page counter |
 | `autoFitZoom` | Boolean | `false` | Automatically adjust zoom to fit viewport on window resize |
+| `pdfjsOptions` | Object | `{}` | Options passed to PDF.js `getDocument` (advanced) |
+
+### PDF.js options
+
+`pdfjsOptions` is forwarded to PDF.js `getDocument(...)` and can be used to tune performance.
+
+Example:
+
+```ts
+<PDFElements
+	:pdfjs-options="{
+		disableFontFace: true,
+		disableRange: true,
+		disableStream: true,
+	}"
+/>
+```
 
 ### Events
 

package/dist/components/DraggableElement.vue.d.ts

@@ -0,0 +1,240 @@
+import { PropType, CSSProperties } from 'vue';
+import { PDFElementObject } from '../types';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    object: {
+        type: PropType<PDFElementObject>;
+        required: true;
+    };
+    pagesScale: {
+        type: NumberConstructor;
+        default: number;
+    };
+    pageWidth: {
+        type: NumberConstructor;
+        required: true;
+    };
+    pageHeight: {
+        type: NumberConstructor;
+        required: true;
+    };
+    onUpdate: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDelete: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDuplicate: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDragStart: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDragMove: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDragEnd: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    isBeingDraggedGlobally: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    draggingClientPos: {
+        type: PropType<{
+            x: number;
+            y: number;
+        }>;
+        default: () => {
+            x: number;
+            y: number;
+        };
+    };
+    currentDocIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    currentPageIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    globalDragDocIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    globalDragPageIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    showSelectionUi: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showDefaultActions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    ignoreClickOutsideSelectors: {
+        type: PropType<string[]>;
+        default: () => any[];
+    };
+}>, {}, {
+    isSelected: boolean;
+    mode: string;
+    direction: string;
+    startX: number;
+    startY: number;
+    startLeft: number;
+    startTop: number;
+    startWidth: number;
+    startHeight: number;
+    offsetX: number;
+    offsetY: number;
+    resizeOffsetX: number;
+    resizeOffsetY: number;
+    resizeOffsetW: number;
+    resizeOffsetH: number;
+    aspectRatio: number;
+    lastMouseX: number;
+    lastMouseY: number;
+    pointerOffsetDoc: {
+        x: number;
+        y: number;
+    };
+    currentPageRect: any;
+    rafId: any;
+}, {
+    resizeDirections(): string[];
+    elementStyle(): CSSProperties;
+    toolbarStyle(): CSSProperties;
+    dragElementStyle(): CSSProperties;
+}, {
+    handleElementClick(event: any): void;
+    handleClickOutside(event: any): void;
+    startResizeFromSlot(direction: any, event: any): void;
+    startDrag(event: any): void;
+    startResize(direction: any, event: any): void;
+    handleMove(event: any): void;
+    stopInteraction(): void;
+    capturePageRect(): any;
+    resetResizeOffsets(): void;
+    resetOffsets(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    object: {
+        type: PropType<PDFElementObject>;
+        required: true;
+    };
+    pagesScale: {
+        type: NumberConstructor;
+        default: number;
+    };
+    pageWidth: {
+        type: NumberConstructor;
+        required: true;
+    };
+    pageHeight: {
+        type: NumberConstructor;
+        required: true;
+    };
+    onUpdate: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDelete: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDuplicate: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDragStart: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDragMove: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    onDragEnd: {
+        type: PropType<(...args: any[]) => void>;
+        default: () => void;
+    };
+    isBeingDraggedGlobally: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    draggingClientPos: {
+        type: PropType<{
+            x: number;
+            y: number;
+        }>;
+        default: () => {
+            x: number;
+            y: number;
+        };
+    };
+    currentDocIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    currentPageIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    globalDragDocIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    globalDragPageIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    showSelectionUi: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showDefaultActions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    ignoreClickOutsideSelectors: {
+        type: PropType<string[]>;
+        default: () => any[];
+    };
+}>> & Readonly<{}>, {
+    pagesScale: number;
+    onUpdate: (...args: any[]) => void;
+    onDelete: (...args: any[]) => void;
+    onDuplicate: (...args: any[]) => void;
+    onDragStart: (...args: any[]) => void;
+    onDragMove: (...args: any[]) => void;
+    onDragEnd: (...args: any[]) => void;
+    isBeingDraggedGlobally: boolean;
+    draggingClientPos: {
+        x: number;
+        y: number;
+    };
+    currentDocIndex: number;
+    currentPageIndex: number;
+    globalDragDocIndex: number;
+    globalDragPageIndex: number;
+    showSelectionUi: boolean;
+    showDefaultActions: boolean;
+    readOnly: boolean;
+    ignoreClickOutsideSelectors: string[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;