React Joyride

Create guided tours in your apps

Tour - GuideReact
gilbarbara/react-joyridereact-joyride.com/react-joyride

README

React Joyride

undefined CI undefined undefined
Joyride example image

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


  1. ``` sh
  2. npm i react-joyride
  3. ```

Getting Started


  1. ``` js
  2. import Joyride from 'react-joyride';

  4. export class App extends React.Component {
  5.   state = {
  6.     steps: [
  7.       {
  8.         target: '.my-first-step',
  9.         content: 'This is my awesome feature!',
  10.       },
  11.       {
  12.         target: '.my-other-step',
  13.         content: 'This another awesome feature!',
  14.       },
  15.       ...
  16.     ]
  17.   };

  19.   render () {
  20.     const { steps } = this.state;

  22.     return (
  23.       <div className="app">
  24.         <Joyride
  25.           steps={steps}
  26.           ...
  27.         />
  28.         ...
  29.       </div>
  30.     );
  31.   }
  32. }
  33. ```

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


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:

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

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

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

Start coding! 🎉