pdf.js Annotation Extension ⚡️
An annotation extension based on the PDF.js viewer
Supporting the editing of existing PDF file annotations, posting comments, replying, submitting annotation data, and loading for further editing.
🚀 Now supports exporting annotations to PDF files.
---
## 📢 React Version Available
### A React-based implementation of this project is now available:
👉 [pdfjs-annotation-extension-for-react](https://github.com/Laomai-codefee/pdfjs-annotation-extension-for-react/)
1. The new project is built on the same core ideas as this repository.
It provides an extensible annotation system powered by PDF.js and is fully refactored into a modern React component architecture.
2. If you are building applications with React and need an extensible PDF annotation solution, we highly recommend checking out the new React version.
3. This repository will remain as a reference for the original implementation and design concepts, while ongoing development and new features will primarily focus on the React version.
---
English | [简体中文](./README_CN.md)
## 🧭 Online Demo
Site： [https://laomai-codefee.github.io/pdfjs-annotation-extension/](https://laomai-codefee.github.io/pdfjs-annotation-extension/)
---
## 📣 Recent Updates
🔥🔥 **2025.6.27 v2.2.0 Version**, main updates include:
1. **New Annotation Types** – Added arrow and cloud line annotations
2. **Signature** – Added support for creating signatures via text input or image upload; text input supports font selection
3. **Stamping** – Added default stamps, custom stamp creation, and image-based stamp uploads; custom stamps support settings for text color, style, font, background, and border; timestamp supports username, date, and custom text
4. **Annotation Status** – Added annotation status options: Accepted, Rejected, Canceled, Completed, Closed, and None
5. **Annotation Export** – Added Excel export functionality for annotations
6. **Connecting Lines** – Added connectors between annotations and shapes
7. **Annotation Styles** – Added style settings for each annotation type, supporting color, stroke width, and opacity adjustments
8. **Bug Fixes and Interaction Improvements** – Various bug fixes and optimizations to enhance user experience
---
* **2025.5.19 Version 2.1.1** – Key features include:
1. **Sidebar Collapse Support** – Added `DEFAULT_SIDE_BAR_OPEN` to control whether the sidebar is shown. It is visible by default.
2. **Annotation Filtering Support** – Added annotation filtering functionality, allowing filters by author and annotation type.
3. **Improved Annotation Highlighting Logic** – Annotations are now highlighted even when not selected, improving the overall user experience.
* **2025.5.16 Version 2.1.0** – Key features include:
1. **Added PDF export functionality**: Export drawn annotations to a new PDF file. Supported annotation types: TEXT, HIGHLIGHT, UNDERLINE, STRIKEOUT, SQUARE, CIRCLE, INK, POLYLINE, FREETEXT, STAMP.
2. **Signatures and stamps**: Introduced the `ALLOW_REPLY_ON_STAMP` parameter to control whether comments/replies are allowed on stamps (disabled by default).
3. **New Note annotation tool**: Corresponds to the PDF Text annotation type.
---
## 1. Background
[PDF.js](https://mozilla.github.io/pdf.js/) provides a [Viewer](https://mozilla.github.io/pdf.js/web/viewer.html) for online PDF preview and includes some basic annotation functionalities (FREETEXT, HIGHLIGHT, STAMP, INK).
In actual use cases, there is often a need for various annotation tools, leading to the idea of extending the viewer to add more annotation capabilities.
This project is based on `konva`, `react`, `antd`, and `web-highlighter`. It introduces additional annotation types by extending the existing `pdf.js` viewer without modifying its original code. Supports editing existing annotations, submitting annotation data, and loading for further editing, as shown below:
