Api

Core Props

Complete reference for core vue-pdf-export component props covering rendering mode, layout, download, preview, filenames, pagination, margins and output behavior.

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.
`collectMetrics`	`boolean`	`false`	Collect total, stage, and per-page generation metrics.
`styling`	`PdfStylingOptions`	disabled/defaults	Export-only page/body styles, scoped CSS, external stylesheets, theme and auto-fit controls.

Header and footer props are documented in their dedicated sections.

Advanced html2pdf Options

const htmlToPdfOptions = {
  margin: [0, 0, 0, 0],
  enableLinks: true,

  pagebreak: {
    mode: ['css', 'legacy'],
  },

  image: {
    type: 'jpeg',
    quality: 1,
  },

  html2canvas: {
    scale: 3,
    useCORS: true,
    backgroundColor: '#FFFFFF',
  },

  jsPDF: {
    unit: 'px',
    format: 'a4',
    orientation: 'p',
    hotfixes: ['px_scaling'],
    optimizeForBrowser: true,
  },
}

<Html2Pdf :html-to-pdf-options="htmlToPdfOptions" />

Important precedence rules:

metadata overrides raw htmlToPdfOptions.metadata when provided.
compress overrides raw htmlToPdfOptions.jsPDF.compress when provided.
security.enabled: true overrides raw jsPDF encryption.
security.enabled: false removes raw encryption.
Non-empty headerHtml takes precedence over headerText.
In HTML footer mode, non-empty footerHtml takes precedence over footerText.
headerLogoEnabled controls only header logo visibility.
footerLogoEnabled controls only footer logo visibility.
Explicit user margins remain even when header/footer rendering is disabled.
enableLinks: true enables generated PDF link annotations.

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.

Headers

Configure PDF headers in vue-pdf-export with text or trusted HTML, logos, page targeting, spacing, dimensions and header-specific rendering options.