Skip to main content

Supported behavior and limitations

The public compatibility boundary and where to find its executable evidence.

Nuxt PDF supports the behavior listed in its public guides and reference pages against exact pinned layout, font, and serialization packages. It does not claim the complete React PDF API or test suite.

Supported areas

The repository tests these user-facing areas:

  • document trees, pagination, flex layout, styles, text, and raster images;
  • local fonts and admitted local or allowlisted remote image sources;
  • metadata, links, notes, bookmarks, and destination page numbers;
  • SVG shapes, gradients, clip paths, transforms, and SVG text;
  • semantic PDF inspection and raster snapshot helpers;
  • production removal of preview routes and preview data;
  • bounded render time, tree size, image admission, page count, and output size.

The detailed support status for scripts and fonts is in Add images and fonts. Exact primitive and style support belongs to the reference section.

Differences from React PDF

Three behaviors differ where matching the pinned lower engine would produce a wrong or unstable public result:

  • A table-of-contents destination resolves to the section's first page.
  • Dynamic page text does not inherit a lineHeight multiplier. Apply line height to static PdfText instead.
  • Explicit zero values keep SVG meaning for fill opacity, stroke width, and supported gradient coordinates.

These differences have geometry or raster regression coverage.

Outside the current boundary

Nuxt PDF does not claim:

  • full React PDF API, hook, browser-helper, or runtime compatibility;
  • Nuxt 3, Node 20, browser rendering, or edge rendering;
  • HTML printing, browser CSS, tables, charts, forms, signing, editing, or PDF merging as built-in features;
  • tagged PDF, PDF/UA, or archival compliance profiles;
  • byte-identical output across operating systems and viewers;
  • authenticated remote requests, custom headers, remote fonts, or SSRF protection beyond the exact-prefix allowlist;
  • SVG image files, SVG markers, or the complete browser SVG model;
  • multi-pass resolution of values other than destination page numbers.

Evidence record

This page is the public summary. Maintainers and reviewers can inspect:

  • CONFORMANCE.md for version pins, paired comparisons, tested fixtures, and explicit non-claims;
  • CONTRACTS.md for the renderer's durable engine contracts.

When the documentation and public source disagree, the source is authoritative and the documentation needs a correction.