jspdf-utils 0.3.0 → 0.4.1

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

@@ -4,6 +4,7 @@
  * Helpers that prepare an HTML element for clean, paginated PDF output
  * via jsPDF's doc.html() renderer.
  */
+import { type Options as Html2CanvasOptions } from "html2canvas-pro";
 import jsPDF from "jspdf-with-html2canvas-pro";
 export interface Margin {
     top: number;
@@ -48,7 +49,7 @@ 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" | "textBorder" | "border">): Promise<jsPDF>;
+declare function generatePDF(doc: jsPDF, source: HTMLElement, opts?: PageOptionsInput & Pick<ImagePDFOptions, "marginContent" | "forcedPageCount" | "textBorder" | "border" | "html2canvasOptions">): Promise<jsPDF>;
 type MarginResult = HTMLElement | string | null | undefined | void;
 type MarginFactory = (page: number, totalPages: number) => MarginResult;
 export interface Border {
@@ -112,6 +113,13 @@ export interface ImagePDFOptions {
      * Example: 1 means only page 1 is generated/exported.
      */
     forcedPageCount?: number;
+    /**
+     * Options forwarded directly to html2canvas-pro. Anything supported by
+     * html2canvas (e.g. `foreignObjectRendering`, `useCORS`, `proxy`,
+     * `windowWidth`, `logging`) can be set here. Note that `scale` and
+     * `backgroundColor` are controlled by this library and will be overridden.
+     */
+    html2canvasOptions?: Partial<Html2CanvasOptions>;
 }
 /**
  * Render an HTML element as an image-based PDF. Each page is a rasterized
@@ -124,9 +132,17 @@ declare function generateImagePDF(source: HTMLElement, opts?: PageOptionsInput &
  * visual output of renderImagePDF.
  */
 declare function generateImages(source: HTMLElement, opts?: PageOptionsInput & ImagePDFOptions): Promise<string[]>;
+export interface PreviewOptions {
+    /**
+     * Height of the preview container. A number is treated as pixels;
+     * a string is used verbatim (e.g. "400px", "60vh", "30rem").
+     * Defaults to one full page height (`pageHeight` in mm).
+     */
+    containerHeight?: number | string;
+}
 /**
  * Render an HTML element as page images and inject them into a scrollable
  * container. Each image is sized to match the page format dimensions.
  */
-declare function previewImages(source: HTMLElement, container: HTMLElement, opts?: PageOptionsInput & ImagePDFOptions): Promise<void>;
+declare function previewImages(source: HTMLElement, container: HTMLElement, opts?: PageOptionsInput & ImagePDFOptions & PreviewOptions): Promise<void>;
 export { PAGE_SIZES, PAGE_MARGINS, generatePDF, generateImagePDF, generateImages, previewImages, };

package/dist/html-to-pdf.js

@@ -5497,7 +5497,11 @@ async function Rg(t, A, e = {}) {
           n.margin.right,
           n.margin.bottom,
           n.margin.left
-        ]
+        ],
+        // jspdf's bundled html2canvas type is older than html2canvas-pro's
+        // (e.g. onclone signature differs). The runtime call forwards
+        // identically, so cast through unknown.
+        html2canvas: e.html2canvasOptions
       });
     });
   } finally {
@@ -5893,6 +5897,7 @@ async function Gg(t, A = {}) {
   );
   try {
     const a = await ae(o, {
+      ...A.html2canvasOptions,
       scale: s,
       backgroundColor: null
     }), { jsPDF: c } = await import("./jspdf.es.min-BDu0IqVE.js").then((p) => p.j), l = Jn(a, n, B, s), g = Math.ceil(a.height / l.contentHeightPx), Q = _n(
@@ -5948,6 +5953,7 @@ async function Mg(t, A = {}) {
   );
   try {
     const a = await ae(o, {
+      ...A.html2canvasOptions,
       scale: s,
       backgroundColor: null
     }), c = Jn(a, n, B, s), l = Math.ceil(a.height / c.contentHeightPx), g = _n(
@@ -5984,20 +5990,22 @@ async function Mg(t, A = {}) {
   }
 }
 async function Ng(t, A, e = {}) {
-  const r = le(e), s = await Mg(t, e);
+  const r = le(e), s = await Mg(t, e), n = e.containerHeight == null ? r.pageHeight + "mm" : typeof e.containerHeight == "number" ? e.containerHeight + "px" : e.containerHeight;
   A.innerHTML = "", Object.assign(A.style, {
     display: "flex",
     flexDirection: "column",
     direction: "ltr",
     width: "fit-content",
-    height: r.pageHeight + "mm",
-    maxHeight: "100vh",
-    overflowY: s.length > 1 ? "auto" : "hidden",
+    height: n,
+    maxHeight: n,
+    // When the caller fixes the height, content may overflow even with a
+    // single page, so always allow scrolling in that case.
+    overflowY: e.containerHeight != null || s.length > 1 ? "auto" : "hidden",
     background: "#e0e0e0"
   });
-  for (let n = 0; n < s.length; n++) {
-    const o = document.createElement("img");
-    o.src = s[n], o.alt = `Page ${n + 1}`, Object.assign(o.style, {
+  for (let o = 0; o < s.length; o++) {
+    const B = document.createElement("img");
+    B.src = s[o], B.alt = `Page ${o + 1}`, Object.assign(B.style, {
       width: r.pageWidth + "mm",
       maxWidth: "100%",
       height: "auto",
@@ -6005,7 +6013,7 @@ async function Ng(t, A, e = {}) {
       border: "1px solid #bbb",
       boxShadow: "0 2px 8px rgba(0,0,0,0.2)",
       marginBottom: "16px"
-    }), o.style.setProperty("display", "inline", "important"), A.appendChild(o);
+    }), B.style.setProperty("display", "inline", "important"), A.appendChild(B);
   }
 }
 async function Og(t, A, e = {}, r, s) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jspdf-utils",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Utility helpers for jsPDF's doc.html() renderer with automatic page breaking, table splitting, and RTL support",
   "type": "module",
   "main": "dist/html-to-pdf.js",