react-joyride
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.2 • Public • Published

    React Joyride

    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

    Chat about it in our Spectrum community

    Setup

    npm i react-joyride

    Getting Started

    import Joyride from 'react-joyride';
    
    export class App extends React.Component {
      state = {
        steps: [
          {
            target: '.my-first-step',
            content: 'This is my awesome feature!',
          },
          {
            target: '.my-other-step',
            content: 'This another awesome feature!',
          },
          ...
        ]
      };
    
      render () {
        const { steps } = this.state;
    
        return (
          <div className="app">
            <Joyride
              steps={steps}
              ...
            />
            ...
          </div>
        );
      }
    }

    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:

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

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

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

    Start coding! 🎉

    Install

    npm i react-joyride

    DownloadsWeekly Downloads

    132,637

    Version

    2.3.2

    License

    MIT

    Unpacked Size

    188 kB

    Total Files

    6

    Last publish

    Collaborators

    • gilbarbara