Skip to content

Releases: gilbarbara/react-joyride

3.0.2

01 Apr 17:09
c57a23b

Choose a tag to compare

  • Fix React 18 aggressive batching: 79a7ef0
  • Re-organize modules: 324b5c9
  • Propagate origin through all UI-triggered control methods: ee6aad3

3.0.1

31 Mar 22:51
2a47b6d

Choose a tag to compare

  • Upgrade dependencies: 2199f9e
  • Add support to spotlight styles (SVGPath): 40e6faa

3.0.0

23 Mar 00:57
d59792a

Choose a tag to compare

V3 is a complete rewrite focused on modern React patterns, smaller bundle size, and a more intuitive API.

Highlights

  • useJoyride hook — replaces getHelpers with a proper hook returning controls, state, current step, failures, and event subscriptions
  • New event system — discriminated event types (tour:start, step:before, tooltip, etc.) with onEvent(data, controls) and selective subscription via on()
  • Step hooks — async before/after callbacks for per-step logic
  • Floating UI — replaced Popper.js/react-floater with direct @floating-ui/react-dom integration
  • Flexible targetsscrollTarget and spotlightTarget for independent positioning; targets accept RefObject, callbacks, and CSS selectors
  • SVG overlay — precise spotlight rendering replacing CSS box-shadow
  • Portal rendering — tour UI renders via React portal with custom container support
  • New component propsarrowComponent, loaderComponent
  • React 16.8–19 support
  • ~30% smaller bundle through dependency replacement

Breaking changes

  • Named export: import { Joyride } from 'react-joyride'
  • callback replaced by onEvent prop
  • run defaults to false
  • getHelpers replaced by useJoyride() hook
  • Step-level props consolidated into flat options (set globally or per-step)
  • styles.options theming moved to options prop
  • Button visibility via buttons array (['back', 'close', 'primary'])
  • Multiple prop renames (disableBeaconskipBeacon, disableCloseOnEscdismissKeyAction, floaterPropsfloatingOptions, etc.)
  • Removed: disableScrollParentFix, styles.spotlight, legacy overlay styles

Full migration guide: https://react-joyride.com/docs/migration
What's new: https://react-joyride.com/docs/new-in-v3

For a complete list of changes, check the PR.


We'd love your feedback! If you run into issues, have questions about migrating, or want to share ideas, join the discussion: #1196

2.9.3

18 Nov 12:38
5fce6a4

Choose a tag to compare

  • Update custom-components docs: 650ab36
  • Upgrade dependencies: 9874150
  • Fix scroll for targets with custom scroll parent or fixed position: 3648311
  • Disable tooltip keyboard focus if the disableScrolling is set: af6fa9e
  • Fix locale handling of custom components: 826669d

2.9.2

11 Sep 20:13
d162ff8

Choose a tag to compare

  • Fix primary button text with showProgress: 58ecae0
  • Fix lifecycle for centered steps: 8ee561a
  • Fix docs and types: 6bf66ca

2.9.1

10 Sep 20:29
20e3b89

Choose a tag to compare

  • Remove duplicate store update for placement "center": 9bac425

2.9.0

10 Sep 00:30
41a85b5

Choose a tag to compare

  • Upgrade dependencies: 76b0eae
  • Add try/catch to getElement helper: 92e204d
  • Add LIFECYCLE.INIT to Overlay "hideSpotlight": e4a75a4
  • Add "nextLabelWithProgress" to step locale: 0fbf346
  • Update "getDocumentHeight" median parameter default to false: d7febf7
  • Fix types and defaults: 805356c

2.8.2

21 May 18:15
c6c7bd7

Choose a tag to compare

  • Upgrade dependencies: 0b4912f
  • Update GH Actions workflow: 7327b2c
  • Hide the Beacon for centered steps or disableBeacon: 8fc34df

2.8.1

10 Apr 01:18
82d1a7c

Choose a tag to compare

  • Replace @gilbarbara/helpers with local utils: 84f8b24
  • Upgrade dependencies: 7f078e3
  • Add optional "data" to step: d6d6eaa

2.8.0

18 Mar 16:34
72cf740

Choose a tag to compare

  • Upgrade dependencies and migrate to pnpm: 6dd35ef
  • Remove unnecessary "as const" statements: 703c453
  • Fix getStyles: af4a702
  • Update Tooltip to hide the primary button if the locale is empty: 444b7c9
  • Refactor Overlay: 77dc4c8
  • Migrate tests to vitest: 024f3e0