https://github.com/agentcooper/react-pdf-highlighter

Set of React components for PDF annotation
https://github.com/agentcooper/react-pdf-highlighter

annotator highlighting pdf pdf-viewer react

Last synced: about 1 month ago
JSON representation

Set of React components for PDF annotation

• Host: GitHub
• URL: https://github.com/agentcooper/react-pdf-highlighter
• Owner: agentcooper
• License: mit
• Created: 2017-11-25T19:36:50.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-09-24T04:47:55.000Z (about 2 months ago)
• Last Synced: 2024-10-13T15:31:00.170Z (about 1 month ago)
• Topics: annotator, highlighting, pdf, pdf-viewer, react
• Language: TypeScript
• Homepage: https://agentcooper.github.io/react-pdf-highlighter/
• Size: 14.8 MB
• Stars: 1,048
• Watchers: 25
• Forks: 409
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
☕️ [Buy me a coffee](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SC4D2NS8G2JJ8&source=url)

![Node CI](https://github.com/agentcooper/react-pdf-highlighter/workflows/Node%20CI/badge.svg)

# react-pdf-highlighter

Set of React components for PDF annotation.

Features:

- Built on top of PDF.js

- Text and image highlights

- Popover text for highlights

- Scroll to highlights

## Importing CSS

The bundled CSS include the CSS for pdfjs.

```tsx

import "react-pdf-highlighter/dist/style.css";

```

## Example

See demo https://agentcooper.github.io/react-pdf-highlighter/.

To run the example app locally:

```bash

npm install

npm start

```

## Install

```bash

npm install react-pdf-highlighter

```

## How to use

See [`./example/src/App.tsx`](https://github.com/agentcooper/react-pdf-highlighter/blob/main/example/src/App.tsx) for the React component API example.