Need help with react-joyride?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

gilbarbara
3.6K Stars 377 Forks MIT License 718 Commits 8 Opened issues

Description

Create guided tours in your apps

Services available

!
?

Need anything else?

Contributors list

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}" ...></joyride>
    ...
  </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! 🎉

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.