@matthesketh/react-guidetour

React 19 guided tour component. A modernised fork of react-joyride by Gil Barbara.

Why this fork?

react-joyride v2.9.3 uses ReactDOM.unmountComponentAtNode() and ReactDOM.unstable_renderSubtreeIntoContainer(), both removed in React 19. This fork:

• Converts all class components to functional components with hooks
• Uses createPortal directly (no legacy React 15/16 branching)
• Removes legacy browser detection (IE/Edge legacy)
• Targets React 19+ only

Install

npm install @matthesketh/react-guidetour

Usage

The API is the same as react-joyride. See the react-joyride documentation for full usage details.

import Joyride from '@matthesketh/react-guidetour';

const steps = [
  {
    target: '.my-first-step',
    content: 'This is my first step!',
  },
];

function App() {
  return <Joyride steps={steps} />;
}

Attribution

Original work by Gil Barbara under the MIT License.