Export Plugin

The Export Plugin provides a simple way for users to download and save the PDF file they are viewing.

Installation

The plugin is available as a separate NPM package.

npm install @embedpdf/plugin-export

pnpm add @embedpdf/plugin-export

yarn add @embedpdf/plugin-export

bun add @embedpdf/plugin-export

Registration

Import ExportPluginPackage and add it to the plugins array. You can configure a fallback filename for the downloaded file.

import { createPluginRegistration } from '@embedpdf/core'
import { EmbedPDF } from '@embedpdf/core/react'
// ... other imports
import { ExportPluginPackage } from '@embedpdf/plugin-export/react'
 
const plugins = [
  // ... other essential plugins
  createPluginRegistration(DocumentManagerPluginPackage, { /* ... */ }),
  createPluginRegistration(ViewportPluginPackage),
  createPluginRegistration(ScrollPluginPackage),
  createPluginRegistration(RenderPluginPackage),
 
  // Register the export plugin
  createPluginRegistration(ExportPluginPackage, {
    defaultFileName: 'my-document.pdf',
  }),
]

Usage

The plugin works by combining a hook for initiating the download with a component that handles the browser interaction.

Triggering a Download

Use the useExport hook to get access to the plugin’s download method for the specific document. Call this method from a button in your toolbar to start the download process.

import { useExport } from '@embedpdf/plugin-export/react';
 
export const ExportToolbar = ({ documentId }) => {
  const { provides: exportApi } = useExport(documentId);
 
  return (
    <button onClick={() => exportApi?.download()} disabled={!exportApi}>
      Download
    </button>
  );
};

Live Example

This example shows a viewer with a download button. Clicking it will trigger a download of the PDF file.

API Reference

Configuration (ExportPluginConfig)

Hook: useExport(documentId)

This hook connects your component to the export plugin’s functions for a specific document.

Returns

ExportCapability Methods