API

Html2Pdf Component

The component owns the export DOM, generation state, preview/download flow, cancellation state and exposed methods. Use it directly when you want a template-first Vue API.

`<Html2Pdf>`

The component owns the export DOM, generation state, preview/download flow, cancellation state and exposed methods. Use it directly when you want a template-first Vue API.

Core props

Prop	Type	Default	Description
`renderMode`	`'canvas' \	'text'`	`'canvas'`
`showLayout`	`boolean`	`false`	Show export layout.
`floatLayout`	`boolean`	`false`	Use fixed/floating export layout.
`enableDownload`	`boolean`	`true`	Download after generation.
`previewModal`	`boolean`	`false`	Show PDF preview modal.
`filename`	`string`	timestamp fallback	PDF filename.
`pdfQuality`	`number`	`2`	Default html2canvas scale; mainly relevant to canvas mode/images.
`pdfFormat`	PDF format	`'a4'`	PDF format.
`pdfOrientation`	`'portrait' \	'landscape'`	`'portrait'`
`pdfContentWidth`	`string`	`'800px'`	Export wrapper width.
`htmlToPdfOptions`	`Html2PdfOptions`	package defaults	Advanced options.
`metadata`	`PdfMetadataOptions`	undefined	PDF metadata.
`compress`	`boolean`	undefined	jsPDF stream compression override.
`security`	`PdfSecurityOptions`	undefined	Password/security configuration.
`manualPagination`	`boolean`	`false`	Manual pagination mode.
`paginateElementsByHeight`	`number`	required for auto mode	Automatic page height.
`showLoader`	`boolean`	`true`	Show loader.
`loaderText`	`string`	`'Generating PDF...'`	Loader text.
`watermark`	`WatermarkOptions`	disabled	Watermark configuration.

Header and footer props are documented in their dedicated sections.

Exposed methods

interface Html2PdfInstance {
  generatePdf: () => Promise<Blob>
  print: () => Promise<void>
  closePreview: () => void
  resetPagination: () => void
  cancelGeneration: () => void
}

See Programmatic API for behavior and cancellation details.

Core Props