React-custom-pdf-highlighter NPM

react-custom-pdf-highlighter

react-custom-pdf-highlighter is a React library that provides annotation experience for PDF documents on web. It is built on top of PDF.js by Mozilla. Text and rectangular highlights are supported. Highlight data format is independent of the viewport, making it suitable for saving on the server.

Install

npm i react-custom-pdf-highlighter

or

yarn add react-custom-pdf-highlighter

Usage

import  { PopupHighlighter } from 'react-custom-pdf-highlighter';

// Inside of a component's render() method:
render() {
  return (
  <PopupHighlighter 
    features={{ width: 1000, height: 700, top: 100, left: 100 }}
    center=false  // You need to explicitly say "false" for "top" and "left" to work!!
    title='PDF Viewer' // default PDF Viewer
    searchObj=searchObj
    pdfUrl= URL  // URL = pdf_url
    mark=true // true to highlight & default true
/>
  );
}

import  { CustomHighlighter } from 'react-custom-pdf-highlighter';

// Inside of a component's render() method:
render() {
  return (
    <CustomHighlighter
        searchObj=searchObj
        pdfUrl= URL  // URL = pdf_url
        mark=true // true to highlight & default true
    />
  );
}

DEFAULT - SearchObject

searchObj: {
    content: { "text": '' }, // default empty string - required filed
    position: {
        "boundingRect": { "x1": 30, "y1": 30, "x2": 30, "y2": 30, "width": pdf_width || 612, "height": pdf_height || 792 },
        "rects": [{ "x1": 30, "y1": 30, "x2": 30, "y2": 30, "width": pdf_width || 612, "height": pdf_height || 792 }],
        "pageNumber": 1 // default 1
   }
    comment: {
        "text": "",
        "emoji": ""
    }
}

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.