From html2pdf.js

The default export implements a PDF-oriented subset of the html2pdf.js chain.

import html2pdf from "@imggion/html2realpdf";

await html2pdf()
  .set({
    filename: "invoice.pdf",
    margin: [10, 12],
    jsPDF: {
      format: "a4",
      unit: "mm",
      orientation: "portrait",
    },
  })
  .from(document.querySelector("#invoice")!)
  .save();

Supported stages

supported

Use from, set, using, toPdf, save, saveAs, outputPdf, output, and the Promise-like chain methods.

The page-break compatibility object supports css, legacy, and avoid-all modes plus before, after, and avoid selectors.

Unsupported raster stages

unsupported

Do not use toCanvas, toImg, outputImg, canvas input, image input, html2canvas options, or raster image options. These operations throw UnsupportedCompatibilityFeatureError.

html2realpdf does not run a full-page canvas pipeline. It writes supported content as native PDF primitives.

Margin order

One, two, and four value margins are accepted. Four values use this order:

[top, left, bottom, right]

This matches the compatibility contract. It does not match CSS shorthand order.

Move to the modern API

Use renderPdf for new direct calls.

import { renderPdf } from "@imggion/html2realpdf";

const pdf = await renderPdf(document.querySelector("#invoice")!, {
  page: {
    format: "a4",
    unit: "mm",
    margin: [10, 12],
  },
});

try {
  pdf.download("invoice.pdf");
} finally {
  pdf.dispose();
}

The modern API makes document ownership, diagnostics, preview, resources, and renderer lifetime explicit.

Supported stages#

Unsupported raster stages#

Margin order#

Move to the modern API#

Supported stages

Unsupported raster stages

Margin order

Move to the modern API