Resource

---

A curated collection of documentation, guides, and tutorials organized by feature category to help you get the most out of Vue PDF Viewer.

Getting Started

• Install and set up Vue PDF Viewer in your Vue 3 or Nuxt project
• Render a PDF document with the VPdfViewer component
• Scaffold a project quickly with the starter toolkit
• Create a reusable PDF viewer wrapper component
• Configure Vue PDF Viewer for Nuxt client-side rendering
• Override the bundled PDF.js version or worker URL
• Browse all available VPdfViewer props
• Explore TypeScript interfaces and type definitions

Annotation

• Overview of the annotation plugin and supported types
• Install and register the annotation plugin
• Configure available annotation tools and their defaults
• Handle annotation events with callback functions
• Configure annotation options for free text, highlight, image, and text selection
• Reference annotation TypeScript interfaces

Customizable

• Add a custom localization to translate the viewer UI
• Adjust CSS variables and styles to match your design
• Show, hide, or reorder toolbar buttons
• Get started with the built-in toolbar
• Replace toolbar icons with custom SVGs or components
• Build your own toolbar from scratch
• Listen for dark mode toggle changes with update:darkMode event
• Customize toolbar tool components with named slots
• Override toolbar icons through icon slots
• Replace the theme toggle with a custom switcher
• Define localization object structure with the Localization interface
• Control toolbar visibility with the ToolbarOptions interface

Interactive

• Search for text within a PDF and navigate between matches
• Highlight with keywords programmatically using strings and regex
• Manage text highlights programmatically across pages
• Add a custom action to text selected from the PDF
• Customize the full screen toggle button via slot
• Switch between text selection and hand tool modes

General

• Control PDF operations programmatically via instance API
• Trigger PDF downloads with optional custom filenames
• Initiate PDF printing programmatically
• Display a print preview dialog before printing
• Handle password-protected PDFs with a custom UI
• Detect when a PDF document has fully loaded with loaded event
• Track PDF loading progress with loadProgress event
• Handle document loading errors with loadError event
• Respond to password prompts with passwordRequired event
• Detect successful password entry with passwordSuccess event
• Handle incorrect passwords with passwordError event
• Browse all available named slots for the viewer
• Replace the download button via downloadTool slot
• Customize the open file button via openFileTool slot
• Override the drag-and-drop file zone via dropFileZone slot
• Replace the print button via printTool slot
• Customize the loading indicator via loader slot
• Configure document loading with PdfDocumentOptions interface
• Specify a character map for CJK and complex scripts

Navigation

• Navigate to specific pages programmatically
• Rotate the PDF document clockwise or counterclockwise
• Control zoom level with zoom in, zoom out, and fit-to-page
• Track the current page number with pageChanged event
• Detect rotation changes with rotate event
• Monitor scroll position with scroll event
• Replace page navigation controls via pageNavigationTool slot
• Customize the thumbnail sidebar via thumbnailTool slot
• Replace zoom controls via zoomTool slot
• Set scroll direction with ScrollMode interface
• Configure page view layout with ViewMode interface
• Use predefined zoom levels with ZoomLevel interface

Responsive

• Adapt the viewer layout and toolbar for mobile and tablet screens

Advanced

• Add a custom watermark to each PDF page
• Highlight with Bbox coordinates programmatically on PDF pages
• Add custom HTML overlays on pages via pageOverlay slot
• Access rendered canvas for custom drawing via CanvasLoadedCallback