@shznet/pdf-sign-control 0.2.0 → 0.2.2

package/README.md

@@ -15,44 +15,52 @@ import { PdfSignControl } from '@shznet/pdf-sign-control';
 
 // 1. Initialize the control
 const container = document.getElementById('pdf-wrapper');
-const pdfControl = new PdfSignControl(container, {
-  allowEdit specific: true,
-  primaryColor: '#007bff'
+const pdfControl = new PdfSignControl({
+  container: container,
+  viewMode: 'scroll', // 'single' or 'scroll'
+  // pdfLoaderOptions: { ... }
 });
 
 // 2. Load a PDF
-await pdfControl.init('https://example.com/sample.pdf');
+await pdfControl.load('https://example.com/sample.pdf');
 
 // 3. Add a signature field
-pdfControl.addField({
-  page: 1,
-  x: 100,
-  y: 100,
-  width: 150,
-  height: 50,
-  id: 'sign_1'
+await pdfControl.addField({
+  pageIndex: 0, // 0-based index
+  rect: { x: 100, y: 100, width: 150, height: 50 },
+  id: 'sign_1',
+  type: 'signature', // or 'text', 'image', 'html'
+  draggable: true,
+  resizable: true
 });
 
 // 4. Listen to events
-container.addEventListener('field:change', (e) => {
-  console.log('Field updated:', e.detail);
+pdfControl.on('fields:change', (fields) => {
+  console.log('Fields updated:', fields);
 });
 ```
 
 ## API
 
-### `init(url: string): Promise<void>`
-Loads and renders the PDF from the given URL.
+### `load(source: string | Uint8Array | ArrayBuffer): Promise<void>`
+Loads and renders the PDF from the given URL or buffer.
 
-### `addField(field: SignatureField): void`
+### `addField(field: SignatureField): Promise<void>`
 Adds a new signature field to the document.
 
-### `setMode(mode: 'single-page' | 'scroll'): void`
+### `setViewMode(mode: 'single' | 'scroll'): Promise<void>`
 Switches between single page view and continuous scroll view.
 
-### `zoomIn() / zoomOut() / setScale(scale: number)`
+### `setScale(scale: number)`
 Controls the zoom level of the document.
 
+### `getFields(): SignatureField[]`
+Returns the current list of fields.
+
+### `print(options?: { withSignatures?: boolean }): Promise<void>`
+Prints the current document.
+- `withSignatures`: If `true`, prints with signature fields overlay. Defaults to `false`.
+
 ## License
 
 MIT