Framework Adapters

annotate-image ships framework-specific adapters that wrap the core library with idiomatic APIs for React, Vue, and jQuery.

Each adapter is published as a separate entry point in the npm package. Adapters are tree-shakeable — importing annotate-image/react does not bundle the jQuery or Vue adapters. Only the core library and your chosen adapter are included in the final bundle.

React

An <AnnotateImage> component with props-driven configuration and ref-based imperative methods.

View docs

Vue

A Vue 3 component with props, events via emit, and exposed methods via template refs.

View docs

jQuery

A jQuery plugin that adds an .annotateImage() method to jQuery objects.

View docs

Installation

Install the core package and your framework of choice:

Bash

# React
npm install annotate-image react react-dom

# Vue
npm install annotate-image vue

# jQuery
npm install annotate-image jquery

Or use the CDN for quick prototyping — see each adapter's documentation for CDN-specific setup.