jspdf-utils 0.1.29 → 0.2.1

package/README.md

@@ -17,7 +17,7 @@ npm install jspdf-utils jspdf html2canvas-pro
 - `previewImages(source, container, opts)`
 - `PAGE_SIZES`
 - `PAGE_MARGINS`
-- Types: `PageOptions`, `PageOptionsInput`, `ImagePDFOptions`
+- Types: `PageOptions`, `PageOptionsInput`, `ImagePDFOptions`, `MarginContentInput`, `Border`, `TextBorder`
 
 Type import example:
 
@@ -106,6 +106,8 @@ Important:
 - `imageQuality?: number`
 - `scale?: number`
 - `marginContent?: MarginContentInput`
+- `border?: Border`
+- `textBorder?: TextBorder`
 - `forcedPageCount?: number`
 
 `forcedPageCount` behavior:
@@ -118,18 +120,42 @@ Important:
 
 ## Margin Content and Borders
 
-`marginContent` supports:
+`marginContent`, `border`, and `textBorder` are independent, top-level page
+options. Each has its own `margin` property that controls its distance from the
+page edge, fully decoupled from the main `margin` (which only controls where
+the HTML content is placed).
 
-- `top`, `right`, `bottom`, `left` as:
-  - `HTMLElement`, or
-  - `(page: number, totalPages: number) => HTMLElement`
-- `contentBorder` (vector rectangle)
-- `textBorder` (repeated text around page edges)
+### `MarginContentInput`
 
-Rendering order:
+- `top`, `right`, `bottom`, `left` — each accepts:
+  - `HTMLElement` or `string` (static, rendered once and reused), or
+  - `(page: number, totalPages: number) => HTMLElement | string` (per-page)
+- `margin?` — distance in mm from the page edge to the content area (default: format default margin)
 
-- Margin content and borders are rendered beneath page content.
-- Main document content stays visually above borders/text borders.
+### `Border`
+
+Draws a vector rectangle around the page.
+
+- `color?: string` (default: `"#000000"`)
+- `width?: number` — line width in mm (default: `0.3`)
+- `margin?` — distance in mm from the page edge to the border (default: page margin)
+
+### `TextBorder`
+
+Draws repeated text along all four page edges.
+
+- `text: string` — the text to repeat
+- `color?: string` (default: `"#000000"`)
+- `fontSize?: number` — in mm (default: `2.5`)
+- `fontFamily?: string` (default: `"Arial, sans-serif"`)
+- `fontWeight?: string` (default: `"normal"`)
+- `gap?: number` — gap between repetitions in mm (default: `fontSize * 0.5`)
+- `margin?` — distance in mm from the page edge to the text border (default: page margin)
+
+### Rendering order
+
+- Margin content, borders, and text borders are rendered beneath page content.
+- Main document content stays visually above them.
 
 ## Development
 

package/dist/html-to-pdf.d.ts

@@ -48,9 +48,10 @@ export interface PrepareResult {
 /**
  * Render an HTML element to PDF using doc.html().
  */
-declare function generatePDF(doc: jsPDF, source: HTMLElement, opts?: PageOptionsInput & Pick<ImagePDFOptions, "marginContent" | "forcedPageCount">): Promise<jsPDF>;
-type MarginFactory = (page: number, totalPages: number) => HTMLElement;
-export interface ContentBorder {
+declare function generatePDF(doc: jsPDF, source: HTMLElement, opts?: PageOptionsInput & Pick<ImagePDFOptions, "marginContent" | "forcedPageCount" | "textBorder" | "border">): Promise<jsPDF>;
+type MarginResult = HTMLElement | string | null | undefined | void;
+type MarginFactory = (page: number, totalPages: number) => MarginResult;
+export interface Border {
     /** Stroke color (default: "#000000") */
     color?: string;
     /** Line width in mm (default: 0.3) */
@@ -85,20 +86,27 @@ export interface TextBorder {
     };
 }
 export interface MarginContentInput {
-    top?: HTMLElement | MarginFactory;
-    right?: HTMLElement | MarginFactory;
-    bottom?: HTMLElement | MarginFactory;
-    left?: HTMLElement | MarginFactory;
-    /** Draw a rectangle border around the content area. */
-    contentBorder?: ContentBorder;
-    /** Draw a repeated-text border around the content area. */
-    textBorder?: TextBorder;
+    top?: HTMLElement | string | MarginFactory;
+    right?: HTMLElement | string | MarginFactory;
+    bottom?: HTMLElement | string | MarginFactory;
+    left?: HTMLElement | string | MarginFactory;
+    /** Distance in mm from the page edge to the margin content area (default: uses page margins). */
+    margin?: number | {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
 }
 export interface ImagePDFOptions {
     imageFormat?: "JPEG" | "PNG";
     imageQuality?: number;
     scale?: number;
     marginContent?: MarginContentInput;
+    /** Draw a rectangle border around the content area. */
+    border?: Border;
+    /** Draw a repeated-text border around the content area. */
+    textBorder?: TextBorder;
     /**
      * Force output to the first N pages only.
      * Example: 1 means only page 1 is generated/exported.