Skip to content

README.md

Latest commit

 

History

History
141 lines (103 loc) · 2.75 KB

README.md

File metadata and controls

141 lines (103 loc) · 2.75 KB

Annotation Examples (Local)

These are runnable examples you can clone and run locally. Each demonstrates specific annotation features in Nutrient Web SDK.

For interactive playground examples, see Annotations Playground Examples.

Available Examples

comment-annotations

Description: Demonstrates how to create and manage comment annotations on PDFs.

Quick start:

cd comment-annotations
npm install
npm start

comments-status

Description: Shows how to track and manage comment status (e.g., open, resolved).

Quick start:

cd comments-status
npm install
npm start

create-annotation-from-clipboard

Description: Create annotations from clipboard content (images, text).

Quick start:

cd create-annotation-from-clipboard
npm install
npm start

customise-annotation-sidebar

Description: Customize the appearance and behavior of the annotation sidebar.

Quick start:

cd customise-annotation-sidebar
npm install
npm start

get-all-annotations-boundingBox

Description: Retrieve and work with bounding boxes of all annotations in a document.

Quick start:

cd get-all-annotations-boundingBox
npm install
npm start

redact-one-by-one

Description: Progressive redaction workflow - redact sensitive content one item at a time.

Quick start:

cd redact-one-by-one
npm install
npm run dev

snipping-annotation

Description: Create snipping tool-style annotations for screenshots.

Quick start:

cd snipping-annotation
npm install
npm start

speech-2-text

Description: Convert speech to text annotations using browser speech recognition.

Quick start:

cd speech-2-text
npm install
npm start

text-2-speech

Description: Convert annotation text to speech using browser text-to-speech.

Quick start:

cd text-2-speech
npm install
npm start

polygon-clipping-outline

Description: Custom SVG polygon outlines for text markup annotations (highlights, underlines, strikeouts, squiggles) using the polygon-clipping library. More precise than the default rectangular selection outline.

Quick start:

cd polygon-clipping-outline
npm install
npm start

Prerequisites

All examples require:

  • Node.js (v16 or higher recommended)
  • npm or yarn

Need Help?