React Joyride

Create awesome tours for your app!

Showcase your app to new users or explain functionality of new features.

It uses react-floater for positioning and styling.
And you can use your own components too!

View the demo here (or the codesandbox examples)

Read the docs

Talk about it on the Discussions board.

Setup

1npm i react-joyride

Getting Started

1import Joyride from 'react-joyride';
2
3export class App extends React.Component {
4  state = {
5    steps: [
6      {
7        target: '.my-first-step',
8        content: 'This is my awesome feature!',
9      },
10      {
11        target: '.my-other-step',
12        content: 'This another awesome feature!',
13      },
14      ...
15    ]
16  };
17
18  render () {
19    const { steps } = this.state;
20
21    return (
22      <div className="app">
23        <Joyride
24          steps={steps}
25          ...
26        />
27        ...
28      </div>
29    );
30  }
31}

If you need to support legacy browsers you need to include the scrollingelement polyfill.

---

Sponsored by

React Joyride is proud to be sponsored by Frigade, a developer tool for building better product onboarding: guided tours, getting started checklists, announcements, etc.

---

Development

Setting up a local development environment is easy!

Clone (or fork) this repo on your machine, navigate to its location in the terminal and run:

1npm install
2npm link # link your local repo to your global packages
3npm run watch # build the files and watch for changes

Now clone https://github.com/gilbarbara/react-joyride-demo and run:

1npm install
2npm link react-joyride # just link your local copy into this project's node_modules
3npm start

Start coding! 🎉