1.0.1 • Published 1 year ago

react-image-area-select v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

react-image-area-select

React typescript lib, with ability to select area on the image and leave comments.

screencast-localhost_5173-2023.01.17-22_55_14.webm

Demo

Live Demo

Installation

# with npm
npm install react-image-area-select
# with yarn
yarn add react-image-area-select

Basic usage

import ImageSelectArea from 'react-image-area-select';

const saveDataHandler = (data: IAreaData) => {
  console.log('Area data : ', data)
}
<ImageSelectArea
  imageUrl="https://yourimageurl.jpg"
  width={ 900 }
  height={ 600 }
  borderColor={ '#0FB839' }
  borderWidth={ 3 }
  saveData={ saveDataHandler }
/>

Types

interface IAreaData {
  index: number,
  lineWidth: number,
  color: string,
  comment: string,
  coordinates: {
    width: number,
    height: number,
    x: number,
    y: number,
  },
}

Props

NAMETYPEDEFAULTDESCRIPTION
imageUrl?String" "Image url
id?StringimageSelectAreaComponent id
width? (px)Number400Component width
height? (px)Number300Component height
borderWidth? (px)Number2Selected area border width
borderColor?String#000000Selected area border color
initAreas?IAreaData[]imageSelectAreaPreinited areas values
saveData?(data: IAreaData) => void() => {}Fires on comment field blur event, or area position or size changing

Styling

Styling on you. Here classes you can use for that:

NAMEDESCRIPTION
selected-areaSelected area wrapper class
active-areaAdded to selected area when it focused
area-commentComment text block class
delete-buttonDelete area button class