jspdf-utils 0.4.7 → 0.5.0

package/README.md

@@ -111,6 +111,7 @@ Important:
 - `border?: Border`
 - `textBorder?: TextBorder`
 - `forcedPageCount?: number`
+- `repeatTableHeaders?: boolean` (default: `true`)
 
 `forcedPageCount` behavior:
 
@@ -120,6 +121,15 @@ Important:
 - `generateImages` and `previewImages`: only returns/displays first `N` pages.
 - Invalid values (`<= 0`, `NaN`, `Infinity`) are ignored.
 
+`repeatTableHeaders` behavior:
+
+- Accepted by `generatePDF`, `generateImagePDF`, `generateImages`, and
+  `previewImages`.
+- When a table is split across pages, its header rows (all rows in `<thead>`,
+  or a leading all-`<th>` row) are repeated at the top of each page the table
+  continues onto — at most once per page.
+- Set to `false` to render the header only once, where the table starts.
+
 ## Margin Content and Borders
 
 `marginContent`, `border`, and `textBorder` are independent, top-level page

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

@@ -30,6 +30,15 @@ export interface PageOptions {
 export type PageOptionsInput = Partial<Omit<PageOptions, "margin">> & {
     margin?: MarginInput;
 };
+export interface PaginationOptions {
+    /**
+     * Repeat a table's header rows (all rows in `<thead>`, or a leading
+     * all-`<th>` row) at the top of every page a page-split table continues
+     * onto. When `false`, the header appears only once — where the table
+     * starts. Default: `true`.
+     */
+    repeatTableHeaders?: boolean;
+}
 /** Standard page dimensions in mm (portrait). */
 declare const PAGE_SIZES: Record<PageFormat, [number, number]>;
 /** Standard margins in mm per format. */
@@ -49,7 +58,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" | "html2canvasOptions">): Promise<jsPDF>;
+declare function generatePDF(doc: jsPDF, source: HTMLElement, opts?: PageOptionsInput & Pick<ImagePDFOptions, "marginContent" | "forcedPageCount" | "textBorder" | "border" | "html2canvasOptions" | "repeatTableHeaders">): Promise<jsPDF>;
 type MarginResult = HTMLElement | string | null | undefined | void;
 type MarginFactory = (page: number, totalPages: number) => MarginResult;
 export interface Border {
@@ -99,7 +108,7 @@ export interface MarginContentInput {
         left?: number;
     };
 }
-export interface ImagePDFOptions {
+export interface ImagePDFOptions extends PaginationOptions {
     imageFormat?: "JPEG" | "PNG";
     imageQuality?: number;
     scale?: number;