react-joyride

What is react-joyride?

react-joyride is a React component that helps you create guided tours for your web applications. It allows you to highlight elements, provide step-by-step instructions, and enhance user onboarding experiences.

What are react-joyride's main functionalities?

Creating a Basic Tour

This code demonstrates how to create a basic tour with react-joyride. It defines a series of steps, each with a target element and content, and then renders the Joyride component with these steps.

import React from 'react';
import Joyride from 'react-joyride';

const App = () => {
  const steps = [
    {
      target: '.my-first-step',
      content: 'This is my first step!'
    },
    {
      target: '.my-second-step',
      content: 'This is my second step!'
    }
  ];

  return (
    <div>
      <Joyride steps={steps} />
      <div className="my-first-step">First Step</div>
      <div className="my-second-step">Second Step</div>
    </div>
  );
};

export default App;

Customizing Tour Appearance

This code shows how to customize the appearance of the tour. You can change the primary color, z-index, and other styles to match your application's design.

import React from 'react';
import Joyride, { STATUS } from 'react-joyride';

const App = () => {
  const steps = [
    {
      target: '.my-first-step',
      content: 'This is my first step!',
      styles: {
        options: {
          zIndex: 10000,
        }
      }
    }
  ];

  return (
    <div>
      <Joyride
        steps={steps}
        styles={{
          options: {
            primaryColor: '#e91e63',
            zIndex: 10000,
          }
        }}
      />
      <div className="my-first-step">First Step</div>
    </div>
  );
};

export default App;

Controlling Tour Programmatically

This code demonstrates how to control the tour programmatically. You can start the tour with a button click and handle the tour's status changes using a callback function.

import React, { useState } from 'react';
import Joyride, { STATUS } from 'react-joyride';

const App = () => {
  const [run, setRun] = useState(false);
  const steps = [
    {
      target: '.my-first-step',
      content: 'This is my first step!'
    }
  ];

  const handleJoyrideCallback = (data) => {
    const { status } = data;
    if ([STATUS.FINISHED, STATUS.SKIPPED].includes(status)) {
      setRun(false);
    }
  };

  return (
    <div>
      <button onClick={() => setRun(true)}>Start Tour</button>
      <Joyride
        steps={steps}
        run={run}
        callback={handleJoyrideCallback}
      />
      <div className="my-first-step">First Step</div>
    </div>
  );
};

export default App;

Other packages similar to react-joyride

reactour

reactour is another React library for creating guided tours. It offers a simple API and is highly customizable. Compared to react-joyride, reactour is more lightweight but may lack some advanced features.

shepherd.js

shepherd.js is a JavaScript library for creating guided tours that can be used with React. It provides a more flexible and powerful API compared to react-joyride, but it requires more setup and configuration.

intro.js

intro.js is a standalone JavaScript library for creating step-by-step guides and feature introductions. It can be integrated with React and offers a wide range of customization options. It is more feature-rich but also more complex to use compared to react-joyride.

README

React Joyride

View the demo here [source]

Setup

npm install --save react-joyride

Include Joyride in the parent component.

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

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

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

Styles

If you are using SCSS (and you should):

@import '~react-joyride/lib/react-joyride'

Or include this directly in your html:

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

Getting Started

Add a custom method to include steps to your component state (or store).

addSteps: function (steps) {
  if (!steps || typeof steps !== 'object') return false;

  this.setState(function(currentState) {
    currentState.steps = currentState.steps.concat(steps);
    return currentState;
  });
}

// Render a standalone tooltip
addTooltip: function(data) {
  this.joyride.addTooltip(data);
}

When your component is mounted or his child components, just add steps.

componentDidMount: function () {
  this.addSteps({...}); // or this.props.addSteps({...}); in your child components
}
...  
render: function () {
  return (
   <div>
     <Joyride
       ref="joyride"
       steps={this.state.steps}
       run={this.state.steps.length} //or some other trigger to start the Joyride
       ...
     />
     <ChildComponent
       addSteps={this.addSteps}
       addTooltip={this.addTooltip}
     />
    </div>
  );
}

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.

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

stepIndex {number}: Jump to a specific step index.

run {bool}: Run/stop the tour.

autoStart {bool}: Open the tooltip automatically when started, without showing a beacon.

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

holePadding {number}: The gap around the target inside the hole. Defaults to 5

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

allowClicksThruHole {bool}: Allow mouse and touch events within overlay hole, and prevent hole:click callback from being sent. Defaults to false

showSkipButton {bool}: Display a link to skip the tour. Defaults to false

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

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

disableOverlay {bool}: Don't close the tooltip on clicking the overlay. Defaults to false

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

callback {function}: It will be called when the tour's state changes and returns a single parameter:

• entering a step { type: 'step:before', index: 0, step: {...} }
• rendering the beacon { type: 'beacon:before', step: {...} }
• triggering the beacon { type: 'beacon:trigger', step: {...} }
• rendering the tooltip { type: 'tooltip:before', step: {...} }
• closing a step { type: 'step:after', step: {...} }
• clicking on the overlay (if not disabled) { type: 'overlay:click', step: {...} }
• clicking on the hole { type: 'hole:click', step: {...} }
• the target could not be found { type: 'error:target_not_found', step: {...} }
• the tour ends. { type: 'finished', steps: [{...}], skipped: boolean }

The callback object also receives an action string ('start'|'next'|'back') and the step index.

Defaults to undefined

Example:

<Joyride
  ref="joyride"
  steps={this.state.steps}
  run={this.state.steps.length}
  debug={true}
  type="single"
  callback={this.callback}
  ...
/>

API

this.joyride.addTooltip(data)

Add tooltips in your elements.

• data {object} - A step object (check the syntax below)

this.joyride.start(autorun)

Call this method to start the tour.

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

this.joyride.next()

Call this method to programmatically advance to the next step.

this.joyride.back()

Call this method to programmatically return to the previous step.

this.joyride.stop()

Call this method to stop/pause the tour.

this.joyride.reset(restart)

Call this method to reset the tour iteration back to 0

• restart {boolean} - Starts the tour again

this.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.joyride.parseSteps(steps) Deprecated

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

• steps {array|object}

var steps = this.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.

Step Syntax

There are some usable options but you can pass custom parameters.

• title: The title of the tooltip
• text: The tooltip's body text
• 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
• isFixed: If true, the tooltip will remain in a fixed position within the viewport. Defaults to false.
• allowClicksThruHole: Set to true to allow pointer-events (hover, clicks, etc) or touch events within overlay hole. If true, the hole:click callback will not be sent. Defaults to false. Takes precedence over a allowClicksThruHole prop provided to <Joyride />
• style: An object with stylesheet options.

Extra option for standalone tooltips

• trigger: The DOM element that will trigger the tooltip

You can style the tooltip UI for each step with these options: backgroundColor, borderRadius, color, mainColor, textAlign and width.

You can also style header, main, footer, button, skip, back, close and hole independently using standard style options. Plus beacon offset, inner and outer colors and arrow visibility.

Example:

{
  title: 'First Step',
  text: 'Start using the <strong>joyride</strong>', // supports html tags
  selector: '.first-step',
  position: 'bottom-left',
  type: 'hover',
  isFixed: true,
  // optional styling
  style: {
    backgroundColor: 'rgba(0, 0, 0, 0.8)',
    borderRadius: '0',
    color: '#fff',
    mainColor: '#ff4456',
    textAlign: 'center',
    width: '29rem',
    arrow: {
      display: 'none'
    },
    beacon: {
      offsetX: 10,
      offsetY: 10,
      inner: '#000',
      outer: '#000'
    },
    header: {
      textAlign: 'right''
      // or any style attribute
    },
    main: {
      padding: '20px'
    },
    footer: {
      display: 'none'
    },
    skip: {
      color: '#f04'
    },
    hole: {
      backgroundColor: 'rgba(201, 23, 33, 0.2)',
    }
    ...
  },
  // custom params...
  name: 'my-first-step',
  parent: 'MyComponentName'
}

SCSS Options

Basic

• $joyride-color: The base color. Defaults to #f04
• $joyride-zindex: Defaults to 1500
• $joyride-overlay-color: Defaults to rgba(#000, 0.5)
• $joyride-beacon-color: Defaults to $joyride-color
• $joyride-beacon-size: Defaults to 36px
• $joyride-hole-border-radius: Defaults to 4px
• $joyride-hole-shadow: Defaults to 0 0 15px rgba(#000, 0.5)

Tooltip

• $joyride-tooltip-arrow-size: You must use even numbers to avoid half-pixel inconsistencies. Defaults to 28px
• $joyride-tooltip-bg-color: Defaults to #fff
• $joyride-tooltip-border-radius: Defaults to 4px
• $joyride-tooltip-color: The header and text color. Defaults to #555
• $joyride-tooltip-font-size: Defaults to 16px
• $joyride-tooltip-padding: Defaults to 20px
• $joyride-tooltip-shadow: Sass list for drop-shadow. Defaults to (x: 1px, y: 2px, blur: 3px, color: rgba(#000, 0.3))
• $joyride-tooltip-width: Sass list of Mobile / Tablet / Desktop sizes. Defaults to (290px, 360px, 450px)
• $joyride-header-color: Defaults to $joyride-tooltip-header-color
• $joyride-header-font-size: Defaults to 20px
• $joyride-header-border-color: Defaults to $joyride-color
• $joyride-header-border-width: Defaults to 1px
• $joyride-button-bg-color: Defaults to $joyride-color
• $joyride-button-color: Defaults to #fff
• $joyride-button-border-radius: Defaults to 4px
• $joyride-back-button-color: Defaults to $joyride-color
• $joyride-skip-button-color: Defaults to #ccc
• $joyride-close: Sass list for the close button: Defaults to (color: rgba($joyride-tooltip-color, 0.5), size: 12px, top: 10px, right: 10px)
• $joyride-close-visible: Default to true;

License

Copyright © 2016 Gil Barbara - MIT License

---

Inspired by react-tour-guide and jquery joyride tour