JSPM

react-pdfviewer-annotator

0.0.7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q48662F
  • License MIT

Set of React components for PDF annotation

Package Exports

  • react-pdfviewer-annotator

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-pdfviewer-annotator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-pdfviewer-annotator

react-pdfviewer-annotator provides annotation experience for PDF documents on web built on top of PDF.js. Text and rectangular highlights are supported. Highlight data format is independent of the viewport, making it suitable for saving on the server.

Demo

https://agentcooper.github.io/react-pdf-annotator/

Installation

npm install react-pdfviewer-annotator

Example

See demo/src/App.js for React component API example.

While docs are in progress, feel free to check the source annotated with Flow type signatures.

Prior art

react-pdf and react-pdfjs only provide React wrappers for PDF.js and do not have built-in annotation functionality.

pdfjs-annotate does not provide text highlights out of the box.

PDF.js provides only viewer:

PDF.js is mainly written for reading PDF files, not editing them. Because of that we don't yet support adding any kind of annotations. We do however support rendering a number of annotation types for viewing.

See also:

FAQ

Can I get a new PDF with the highlights embedded into the document?

No, but pdf-annotation-service might be helpful for you.

Compatibility

Works in Google Chrome, Safari 10+, Firefox 52+. Not tested in Internet Explorer.