Get Started

Introduction

vue-pdf-export is a Vue + TypeScript HTML-to-PDF component and composable for browser applications.

Introduction

vue-pdf-export is a Vue + TypeScript HTML-to-PDF component and composable for browser applications.

It supports two rendering modes:

  • Canvas mode - maximum HTML/CSS visual fidelity through html2pdf.js + html2canvas + jsPDF.
  • Selectable text mode - browser-side vector PDF rendering with real selectable/searchable/copyable text, clickable PDF links, password protection, metadata, compression, page-aware headers/footers, and watermarks.

It also includes manual and automatic pagination, preview, download, print, safe filename normalization, progress stages, custom loaders, current-page progress, cancellation, page targeting, PDF permissions, large-document optimizations, and advanced renderer configuration.

Default package behavior remains renderMode="canvas" for backwards compatibility. The live playground may choose a different default for demonstration purposes.

Highlights

  • Browser-side PDF generation with no package-managed upload service
  • Canvas and selectable-text rendering
  • Incremental page-by-page Canvas rendering when page-break markers are present
  • Cooperative cancellation for long-running exports
  • Page-aware progress with currentPage / totalPages
  • Repeated-image caching in selectable-text rendering
  • Temporary DOM/canvas cleanup between expensive rendering steps
  • Password protection, owner password, PDF permission flags, metadata, and compression
  • Headers, footers, logos, watermarks, page targeting, and clickable links
  • Stress/regression coverage for 10 / 25 / 50 / 100-page documents
Try it before integrating
The live playground exposes the package options interactively.
Open playground
Copyright © 2026