Download Latest Version 3.1.0 source code.tar.gz (45.5 MB)
Email in envelope

Get an email when there's a new version of React Joyride

Home / v3.1.0
Name Modified Size InfoDownloads / Week
Parent folder
3.1.0 source code.tar.gz 2026-04-29 45.5 MB
0
3.1.0 source code.zip 2026-04-29 45.7 MB
0
README.md 2026-04-29 1.0 kB
0
Totals: 3 Items   91.1 MB 0

Features

  • controls.replay(origin?) — re-run current step. Re-emits step:after → step:before, re-runs before/after hooks, index unchanged. Only valid from RUNNING + TOOLTIP.
  • New 'replay' value for closeButtonAction, dismissKeyAction, overlayClickAction. Dismiss tooltip → show beacon on same step (resolves [#1205]).
  • New ACTIONS.REPLAY literal.

Internal

  • Floater zIndex offset reduced (+100 → +1). Relative stacking with overlay unchanged.

Controlled-mode note

Parent onEvent must skip index increment on STEP_AFTER + ACTIONS.REPLAY:

:::tsx
if (type === EVENTS.STEP_AFTER && action === ACTIONS.REPLAY) return;

Docs

  • New recipe: Conditional / Dynamic Steps — use before hooks, not useEffect-driven stepIndex.
  • Controlled mode: "use sparingly" guidance.
  • Updated ControlsTable, OptionsTable, exports reference, and architecture doc.

Full Changelog: https://github.com/gilbarbara/react-joyride/compare/v3.0.2...v3.1.0

Source: README.md, updated 2026-04-29