annotorious / annotorious

Add image annotation functionality to any web page with a few lines of JavaScript.

Annotorious - JavaScript Image Annotation

Add image annotation functionality to any web page with a few lines of JavaScript. Visit the project website for documentation and live demos.

npm install @annotorious/annotorious

Quick Start

import { createImageAnnotator } from '@annotorious/annotorious';

import '@annotorious/annotorious/annotorious.css';

const anno = createImageAnnotator('image-to-annotate');

// Load annotations from a file
anno.loadAnnotations('./annotations.json');

// Listen to user events
anno.on('createAnnotation', function(annotation) {
  console.log('new annotation', annotation);
});

License

BSD 3-Clause (= feel free to use this code in whatever way you wish. But keep the attribution/license file, and if this code breaks something, don't complain to me :-)

Community

Visit the Discussion Forum for community support, or file an issue on the Issue Tracker.

Become a Sponsor

Using Annotorious at work? Become a sponsor! Your support helps me cover hosting costs, spend more time supporting the community, and make Annotorious better for everyone. Make a one-time or monthly donation via my SteadyHQ account.

Older Versions

Documentation for Annotorious version 2.7 is available here.