capacitor-pdf-annotations
v1.0.1
Published
A Capacitor plugin for iOS that provides a wrapper around QLPreviewController to enable opening, viewing, and saving PDFs with annotations
Readme
capacitor-pdf-annotations
A Capacitor plugin for iOS that provides a wrapper around QLPreviewController to enable opening, viewing, and saving PDFs with annotations
Install
npm install capacitor-pdf-annotations
npx cap syncAPI
openPdf(...)
openPdf(options: OpenPdfOptions) => Promise<OpenPdfResult>Open a PDF file with optional annotation/save capability (iOS only)
| Param | Type |
| ------------- | --------------------------------------------------------- |
| options | OpenPdfOptions |
Returns: Promise<OpenPdfResult>
Interfaces
OpenPdfResult
| Prop | Type | Description |
| --------------- | -------------------- | ------------------------------------ |
| dismissed | boolean | Whether the PDF viewer was dismissed |
OpenPdfOptions
| Prop | Type | Description |
| ---------------- | -------------------- | --------------------------------------------------------------- |
| url | string | Local file URL to the PDF file |
| enableSave | boolean | Enable or disable file save/annotation editing (default: false) |
