Package Exports

react-joyride

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-joyride) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React Joyride

View the demo here. [source]

Setup

Version 1.0 has a very different setup from 0.x versions. The old syntax will not work.

npm install --save react-joyride

Include Joyride in the parent component before anything else.

var react = require('react');
var Joyride = require('react-joyride');

var App = React.createClass({
    render: function () {
        return (
            <div className="app">
                <Joyride ref="joyride" steps={this.state.steps} debug={true} ... />
                <YourComponents .../>
            </div>
        );
    }
  ...
});

Don't forget to pass a ref to the component.

Styles

If your are using SCSS (and you should):

@include '../path/to/node-modules/react-joyride/lib/styles/react-joyride'

Or include this directly in your html:

<link rel="stylesheet" href="react-joyride/lib/styles/react-joyride-compiled.css" type="text/css">

Getting Started

Add a custom function to include steps and/or tooltips in your parent component

addSteps: function (steps) {
    let joyride = this.refs.joyride;
        
    if (!Array.isArray(steps)) {
        steps = [steps];
    }
    
    if (!steps.length) {
        return false;
    }
    
    this.setState(function(currentState) {
        currentState.steps = currentState.steps.concat(joyride.parseSteps(steps));
        return currentState;
    });
}

addTooltip: function (data) {
    this.refs.joyride.addTooltip(data);
}

Add steps after your components are mounted.

componentDidMount: function () {
    this.addSteps({...}); // or this.addTooltip({...});
    

    // or using props in your child components
    this.props.addSteps({...});
}
...   
render: function () {
    return (
        <Joyride ref="joyride" .../>
        <ChildComponent addSteps={this.addSteps} addTooltip={this.addTooltip} />
    );
}

Or you can start the tour after a criteria is met

componentDidUpdate (prevProps, prevState) {
    if (!prevState.ready && this.state.ready) {
        this.refs.joyride.start();
    }
},

Please refer to the source code of the demo if you need a practical example.

Options

You can change the initial options passing props to the component. All optional.

debug {bool}: Console.log Joyride's inner actions. Defaults to false

keyboardNavigation {bool}: Toggle keyboard navigation (esc, space bar, return). Defaults to true

locale {object}: The strings used in the tooltip. Defaults to { back: 'Back', close: 'Close', last: 'Last', next: 'Next', skip: 'Skip' }

resizeDebounce {bool}: Delay the reposition of the current step while the window is being resized. Defaults to false

resizeDebounceDelay {number}: The amount of delay for the resizeDebounce callback. Defaults to 200

scrollOffset {number}: The scrollTop offset used in scrollToSteps. Defaults to 20

scrollToSteps {bool}: Scroll the page to the next step if needed. Defaults to true

scrollToFirstStep {bool}: Scroll the page for the first step. Defaults to false

showBackButton {bool}: Display a back button. Defaults to true

showOverlay {bool}: Display an overlay with holes above your steps (for tours only). Defaults to true

showSkipButton {bool}: Display a link to skip the tour. It will trigger the completeCallback if it was defined. Defaults to false

showStepsProgress {bool}: Display the tour progress in the next button e.g. 2/5 in continuous tours. Defaults to false

steps {array}: The tour's steps. Defaults to []

tooltipOffset {number}: The tooltip offset from the target. Defaults to 30

type {string}: The type of your presentation. It can be continuous (played sequencially with the Next button) or single. Defaults to single

completeCallback {function}: It will be called after an user has completed all the steps or skipped the tour and passes two parameters, the steps {array} and if the tour was skipped {boolean}. Defaults to undefined

stepCallback {function}: It will be called after each step and passes the completed step {object}. Defaults to undefined

Example:

<Joyride ref="joyride" steps={this.state.steps} debug={true} type="single"
         stepCallback={this._stepCallback} ... />

API

this.refs.joyride.start(autorun)

Call this method to start the tour.

autorun {boolean} - Starts the tour with the first tooltip opened.

this.refs.joyride.stop()

Call this method to stop/pause the tour.

this.refs.joyride.reset(restart)

Call this method to reset the tour iteration back to 0

restart {boolean} - Starts the new tour right away

this.refs.joyride.getProgress()

Retrieve the current progress of your tour. The object returned looks like this:

{
    index: 2,
    percentageComplete: 50,
    step: {
        title: "...",
        text: "...",
        selector: "...",
        position: "...",
        ...
    }
}}

this.refs.joyride.parseSteps(steps)

Parse the incoming steps, check if it's already rendered and returns an array with valid items

steps {array|object}

var steps = this.refs.joyride.parseSteps({
    title: 'Title',
    text: 'description',
    selector: 'my-super-class',
    position: 'top'
});

// steps
[{
    title: 'Title',
    text: 'description',
    selector: '#super-panel',
    position: 'top'
}]

Only start the tour after all target elements (or at least the first step) are rendered in the page.

There are a few usable options but you can pass custom parameters.

title: The title of the tooltip
text: The tooltip's body text (required)
selector: The target DOM selector of your feature (required)
position: Relative position of you beacon and tooltip. It can be one of these:top, top-left, top-right, bottom, bottom-left, bottom-right, right and left. This defaults to top.
type: The event type that trigger the tooltip: click or hover. Defaults to click

Extra option for standalone tooltips

trigger: The DOM element that will trigger the tooltip

As of version 1.x you can style tooltips independently with these options: backgroundColor, borderRadius, color, mainColor, textAlign and width.

Also you can style button, skip, back and close individually using standard style options. And beacon inner and outer colors.