PDF Viewer Capacitor plugin

Using @capgo/capacitor-pdf-viewer

Native PDF viewing on iOS (PDFKit), Android (Pdfium), and web with paths, URLs, base64, and inline mode.

Install

bun add @capgo/capacitor-pdf-viewer
bunx cap sync

What This Plugin Exposes

• open - Open a PDF from a file, path, URL, or base64 source.
• close - Close the active viewer and remove any overlay.
• goToPage - Jump to a 1-based page number.
• setZoom - Set the zoom scale multiplier.
• getPluginVersion - Get the native or web implementation version marker.
• addListener - Listen for load, pageChange, error, close, and linkTap events.

Example Usage

open

import { PdfViewer } from '@capgo/capacitor-pdf-viewer';

await PdfViewer.addListener('pageChange', ({ page, pageCount }) => {
  console.log(`Page ${page} of ${pageCount}`);
});

const { pageCount } = await PdfViewer.open({
  source: 'https://example.com/manual.pdf',
  mode: 'fullscreen',
  scrollMode: 'continuous',
  page: 1,
});

console.log(`Opened ${pageCount} pages`);

close

import { PdfViewer } from '@capgo/capacitor-pdf-viewer';

await PdfViewer.close();

Full Reference

• GitHub: https://github.com/Cap-go/capacitor-pdf-viewer/
• Docs: /docs/plugins/pdf-viewer/