• API Documentation
• Simple input/output format
• Bounding Box, Point and Polygon Annotation
• Zooming, Scaling, Panning
• Multiple Images
• Cursor Crosshair

npm install react-image-annotate

import React from "react";
import ReactImageAnnotate from "react-image-annotate";

const App = () => (
  <ReactImageAnnotate
    labelImages
    regionClsList={["Alpha", "Beta", "Charlie", "Delta"]}
    regionTagList={["tag1", "tag2", "tag3"]}
    images={[
      {
        src: "https://placekitten.com/408/287",
        name: "Image 1",
        regions: []
      }
    ]}
  />
);

export default App;

To get the proper fonts, make sure to import the Inter UI or Roboto font, the following line added to a css file should suffice.

@import url("https://rsms.me/inter/inter.css");

All of the following properties can be defined on the Annotator...

To begin developing run the following commands in the cloned repo.

1. npm install
2. npm start

Then navigate to http://localhost:5173/ and start testing.

See more details in the contributing guidelines.

Consult these icon repositories:

• Material Icons
• Font Awesome Icons

To test this package in your project follow this quickstart:

1. Run npm link in the root directory of this project (where the package.json is located)
2. With the same Terminal window, go to your target project folder where the package.json is located
3. Run npm link "@starwit/react-image-annotate" to install the package. It might be necessary to remove a previously installed @starwit/react-image-annotate package. Please use the same node version when using npm link and executing the application.
4. Changes to this repository will apply live to the running dev session in your target project :)

Currently, there is an issue with vite-plugin-node-polyfills (0.15.0 at the time of writing), which shows many warnings while building (related to "use client"). That is expected and will probably be fixed in the future. See here: davidmyersdev/vite-plugin-node-polyfills#49