Skip to content

v1.0.0-alpha

Choose a tag to compare

@dansreis dansreis released this 18 Jun 16:22
· 189 commits to main since this release

Description

We are excited to announce the first alpha release of react-canvas-annotator! This version marks the beginning of our journey in providing a powerful and flexible annotation tool for React applications. The 1.0.0-alpha release is aimed at developers who want to explore and contribute to the early stages of the project. Please note that this is an alpha version, so expect some rough edges and incomplete features.

Features

  • Annotations on Images:

    • Support for adding various types of annotations such as bounding boxes, polygons, and points.
  • Image Zoom and Drag:

    • Users can zoom in and out of images and drag to navigate.
  • Polygon Annotation:

    • Create and manipulate polygonal shapes for detailed annotations.

Initial API

BoardProps

  • items: CanvasObject[]
    • Array of canvas objects to be displayed.
  • image: { name: string; src: string }
    • Object containing the image name and source URL.
  • initialStatus: { draggingEnabled?: boolean; currentZoom?: number; scaleRatio?: number }
    • Initial status settings for the board.
  • onResetZoom: () => void
    • Callback function when the zoom is reset.
  • onZoomChange: (currentZoom: number) => void
    • Callback function when the zoom changes.
  • onToggleDragging: (currentStatus: boolean) => void
    • Callback function when the dragging status is toggled.
  • onLoadedImage: ({ width, height }: { width: number; height: number }) => void
    • Callback function when the image is loaded.

What's Changed

New Contributors

Full Changelog: https://github.com/dansreis/react-canvas-annotator/commits/1.0.0-alpha