Primitives

Every primitive is an auto-registered global component. The tables below are drawn from the shipped prop types. style values use Nuxt PDF's framework-owned PdfStyle contract, not CSS or the wider upstream stylesheet types (see Styling and layout.

The same surface is enforced after Vue mounts the tree. Each primitive has a closed runtime prop allowlist; unknown props, DOM/event attributes, and props used on the wrong primitive fail with PDF_TREE_INVALID rather than passing through or silently doing nothing.

Shared base props

PdfPage, PdfView, page-flow PdfText, PdfImage, PdfLink, and PdfNote share these:

PdfPage, PdfView, PdfText, and PdfImage additionally accept bookmark (string, or { title, expanded? }) to build the outline.

PdfDocument

The root. Carries document metadata; takes no base props.

Reader page mode, encryption passwords, and PDF permission flags are not public props. Their serialized behavior is not part of the current public contract.

modificationDate is also absent. The pinned engine writes its upstream prop under a non-standard custom key rather than the PDF ModDate entry, so exposing it would promise metadata that common readers do not see.

When definePdf supplies title or language, that value is authoritative and overrides the corresponding PdfDocument prop. Without a definition value, the root prop is preserved as the rendered fallback. Nuxt PDF reapplies the authoritative values after each page-number update in a multi-pass render.

PdfPage

Plus the base and bookmark props.

PdfView

The flexbox container. Base and bookmark props, plus:

PdfText

The only container for text has two context-specific prop branches.

In normal page flow it accepts the base and bookmark props, plus:

Inside PdfSvg, it instead accepts:

SVG text rejects page-flow-only props such as id, bookmark, fixed, break, wrap, widows, orphans, and render.

PdfImage

Base and bookmark props, plus:

PdfImageSource is a pdfs/assets-relative path, a Uint8Array/ArrayBuffer, { data, format: 'png' \| 'jpg' }, or { uri, format? }.

PdfLink

Base props (no bookmark), plus:

PdfNote

A sticky-note annotation. Base props only; its text comes from its content.

SVG primitives

SVG primitives render inside a PdfSvg. Paint, geometry, clipping, and transforms are direct props. PdfG and the shape primitives have no generic style prop, so there is no style-precedence path; kebab-case Vue attributes are normalized to the equivalent camelCase key. See SVG graphics.

PdfSvgNumber is a finite number or numeric string. PdfSvgLength additionally accepts a numeric percentage string where the individual prop permits it. strokeWidth is never a percentage. Non-negative geometry and unit-interval opacity/stop ranges are checked at runtime.

Shared SVG presentation props

Available on PdfG, PdfPath, PdfRect, PdfCircle, PdfEllipse, PdfLine, PdfPolyline, and PdfPolygon:

Geometry props

Alternate gradient coordinate systems, transforms, inheritance, and SVG preserveAspectRatio modes are not public props. See Supported behavior and limitations.

Each PdfSvg accepts at most one direct PdfDefs child. Definition ids are safe, unique, and scoped to that one SVG. fill="url(#id)" must resolve to a linear or radial gradient; clipPath="url(#id)" must resolve to a PdfClipPath. Missing, malformed, or incompatible references fail with PDF_TREE_INVALID.

Explicit zero has SVG semantics: zero fill opacity is transparent, zero stroke width removes the stroke instead of requesting a PDF hairline, and supported gradient coordinates remain zero. The engine repairs upstream truthiness fallbacks after layout and before serialization.

Exported primitive types

Import prop and value types from @lupinum/nuxt-pdf when you type reusable document components: