Skip to content

Latest commit

 

History

History
429 lines (212 loc) · 21.9 KB

CHANGELOG.md

File metadata and controls

429 lines (212 loc) · 21.9 KB

Changelog

3.2.1 (2026-01-23)

Bug Fixes

  • target and container size initialization order should not affect base transform calculations (#190) (52afd14)

3.2.0 (2026-01-20)

Features

  • add update angle action (#189) (3e50924)
  • allow a zoom init level which transforms the image relative to the center of the container (#186) (6536d80)
  • make 1D side resize handle easier to use (#188) (138e5fb)

3.1.0 (2026-01-08)

Features

3.0.0 (2025-11-21)

⚠ BREAKING CHANGES

  • getStyle, getReadOnly, renderLabel, getOverlayOpacity callback props on RoiList have changed their contract.
  • rename allowRotate to displayRotationHandle on RoiList. The old option did not have a good name because it was only controlling the ability to rotate by showing and hiding the handle. There are other ways now to rotate an ROI.

Features

  • add commitRoiBoundaryStrategy configuration (#172) (b4a7c3a)
  • add new rotate_selected mode (#171) (ad3578f)
  • add option not to commit when updating through actions api (#168) (168dc05)
  • add options to customize the number of grid lines in select ROIs (#170) (ba318fc)
  • allow boundary strategy to be passed when updating rois programmatically (#177) (863c925)

Bug Fixes

2.0.1 (2025-11-03)

Bug Fixes

  • revert to using a mutable ref in useResizeObserver hook (#165) (b5a8f06)

2.0.0 (2025-11-03)

⚠ BREAKING CHANGES

  • the API for lifecycle callbacks has changed, but still support the same features

Features

  • improve and add lifecycle callback and some fixes (#161) (89620dc)

1.5.0 (2024-06-04)

Features

  • add showGrid prop to RoiList component (#159) (3b99bce)

1.4.2 (2024-05-22)

Bug Fixes

  • do not preventDefault on mouse down, only on context menu (#155) (b8c514a)

1.4.1 (2024-05-18)

Bug Fixes

1.4.0 (2024-05-15)

Features

1.3.0 (2024-05-10)

Features

  • add getRectanglePoints method to committed roi (ca58b1a)

1.2.0 (2024-04-09)

Features

  • pan with middle or right mouse (f4df4ed)

Bug Fixes

  • prevent context menu from appearing when using right click (c4a45de)

1.1.0 (2024-03-22)

Features

  • export helper to help appropriately build image styles (98b4b6c)

1.0.1 (2024-03-21)

Bug Fixes

1.0.0 (2024-03-12)

⚠ BREAKING CHANGES

  • make round the default commit box strategy

Features

  • add prop to opt into zooming with mouse wheel without the alt key (#131) (c79e779)

Bug Fixes

  • no jittering with "round" commit strategy (#133) (71dd546)

0.16.1 (2024-03-06)

Bug Fixes

  • add missing on rotate callback (c6e0595)
  • make sure handler has a default color (a2791ce)
  • make sure initial roi values get rounded and bounded (8c790f3)

Documentation

  • improve organization of stories (9ad7106)
  • make sure committed rois are displayed even if roi coordinates are not integers (0025d06)

0.16.0 (2024-03-06)

Features

  • add commitRoiBoxStrategy prop to opt in to rounding box properties (#124) (897ec95)

0.15.0 (2024-03-04)

⚠ BREAKING CHANGES

  • the ROI coordinates are no longer floored to an integer. x, y, width and height are all floating point numbers. RoiAction type renamed to ReactRoiAction to avoid name conflict.

Features

  • add getOverlayOpacity prop which allows to darken the container around the ROI (#120) (91615df)
  • rotate ROIs (#122) (4e25be5)

0.14.0 (2024-02-02)

⚠ BREAKING CHANGES

  • action callback defined as props of the provider instead of the container. Action callbacks like onDrawFinish no longer responsible for making the action.

Features

  • set initial zoom level and add onAfterZoomChange callback (d819099)

0.13.1 (2024-02-01)

Bug Fixes

  • add vendor prefix for userSelect property (375ec57)
  • disable touch action on the container (6085bd3)

0.13.0 (2024-02-01)

Features

  • change mouse event to pointer for extended devices compatibility (732031e)

0.12.1 (2024-01-31)

Bug Fixes

0.12.0 (2024-01-29)

Features

  • add getNewRoiData prop to initialize roi data on draw (fde6a87)
  • on create, move and resize hooks (99c3782)
  • preserve spaces in label (039084a)

0.11.0 (2024-01-23)

Features

  • allow custom svg to be produced which enables filling roi with custom patterns (c236822)

0.10.1 (2024-01-23)

Bug Fixes

  • reset TargetImage style properties which can influence it's dimensions (92e5f3c)

0.10.0 (2024-01-23)

⚠ BREAKING CHANGES

  • introduce new hybrid mode

Features

  • add option to initial config to configure initial mode (1641606)
  • introduce new hybrid mode (26f71ed)

Bug Fixes

  • send the container size only when it has a non-zero size (aed07f9)

0.9.0 (2024-01-22)

⚠ BREAKING CHANGES

  • always use target coordinate system in rois and snap roi to pixel (#93)

Features

  • always use target coordinate system in rois and snap roi to pixel (#93) (443d0c4)

Bug Fixes

  • handle size must be at least 1 (8132008)
  • render roi label with constant font size (4e6d903)

0.8.1 (2024-01-10)

Bug Fixes

  • allow to pan hover a readOnly roi and other edge cases (#90) (a876b43)

0.8.0 (2023-12-15)

Features

0.7.0 (2023-12-08)

⚠ BREAKING CHANGES

  • there are no keyboard shortcuts anymore, those must be configured by the user

Features

  • add noUnselection prop to prevent unselect by clicking in the container outside of any ROI (b42f894)
  • add selectRoi action (8fa6c81)
  • initial selection of an ROI (597133f)
  • remove react-kbs, add cancelAction aciton and add TargetImage component (#76) (ee07373)

0.6.1 (2023-12-01)

Bug Fixes

0.6.0 (2023-11-24)

Features

  • pan without the alt key (6647c62)

Bug Fixes

  • correct leaking event listener (937d005)
  • use correct cursor during action after releasing the alt key (5467213)

0.5.0 (2023-11-23)

⚠ BREAKING CHANGES

  • the initial configuration is now passed as a single prop to RoiProvider

Features

  • do not scale handlers with zoom level (6ce10ac)
  • provide different initial rescaling strategies (4537913)
  • show corner handles inside of ROI boundaries (f83ef2a)

0.4.0 (2023-11-22)

⚠ BREAKING CHANGES

  • roi label must be a string and cannot be a ReactNode anymore
  • getStyle prop changed
  • rename useRoiActions to useActions
  • do not export useRois hook

Features

  • add className support (#44) (c51728f)
  • add readOnly ROI (#58) (b22ec6a)
  • add renderLabel prop for more flexibility (7856372)
  • add zoom action (#60) (09f70b3)
  • add ZoomLevel on provider (#62) (60f4e29)
  • change corner appearance (99a15f8)
  • customize resize handler color (97ab51b)
  • fit the target inside of the container (9374eb9)
  • improve default style of roi (5fdce8f)
  • pass data about readonly and scale in getStyle callback (6d28ad1)

Bug Fixes

  • improve interactions when using browser zoom (ecb14e5)
  • make sure selected roi is rendered on top of other rois (#46) (6963ba3), closes #37
  • prevent scrolling while zooming (3162404)
  • rescale roi before updating (#42) (c7068d0)
  • unselect roi when cancelling a draw action (a947c09)

Documentation

  • add scroll stories (556c9c2)
  • add stories who update a label (67ff936)
  • fix layout of zoom story (26c12ef)

0.3.0 (2023-09-08)

Features

Bug Fixes

  • hide content overflowing the container (c99f839)

Documentation

  • intiated roi with styled label (bdbdd3b)

0.2.0 (2023-08-28)

⚠ BREAKING CHANGES

  • add API implementation close #20 (#21)

Code Refactoring

0.1.0 (2023-07-06)

Features

  • add preview github action (ee66266)
  • allow to work with images and div elements close #18 (#19) (3cf310f)

0.0.2 (2023-06-29)

Bug Fixes

0.0.1 (2023-06-29)

Features

Bug Fixes

  • allow the addition of multiple rectangles (c2b7752)
  • allow to resize the image (2cbef46)

release-as