Skip to content

v3.0.0

Compare
Choose a tag to compare
@github-actions github-actions released this 22 Mar 20:03
· 189 commits to main since this release

3.0.0 (2023-03-22)

Upgrading from v2?

Review the v3 Breaking Changes

Bug Fixes

  • fix captions flickering in iOS Safari (530fd9e)

Features

  • make index and slides props responsive (ec555dc)
  • add Controller ref (06e6daa)
  • add Fullscreen ref (cc3e653)
  • add Slideshow ref (b888ae2)
  • add Zoom ref (b3b4761)
  • streamline animation easing settings (4011639)
  • add render function for custom elements or controls (bc1a938)
  • add addModule plugin prop (14876c1)
  • add useLightboxProps hook and LightboxPropsContext (598b007)
  • streamline lightbox events (41583db)
  • refactor types (94ae012)

BREAKING CHANGES

  • index and slides props can now be updated
  • animation easing settings moved to animation.easing
  • slide render function props changed
  • slideHeader, slideFooter and slideContainer render functions props changed
  • view, click and zoom callbacks props changed
  • render.buttonFullscreen render function props changed
  • render.buttonSlideshow render function props changed
  • buttonZoomIn and buttonZoomOut custom render functions are replaced with buttonZoom
  • fullscreen prop is no longer a boolean
  • ControllerContext no longer provides getLightboxProps, use useLightboxProps hook instead
  • PluginMethods type was renamed to PluginProps
  • animationDuration prop is no longer available in the LightboxState
  • removed YARL_EVENT_BACKDROP_CLICK and YARL_EVENT_TOOLBAR_WIDTH events