Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

React component that help you create nice step-by-step intros.

react-tour

Live demo

Installation

npm install react-tour --save

Usage

var ReactTour = require('react-tour');
// [...]
var ReactTourConfig = [{
 node: React.findDOMNode(this.refs.step1),
 text: 'This is the step 1'
}, {
 node: React.findDOMNode(this.refs.step2),
 text: 'This is the step 2'
}, {
 node: React.findDOMNode(this.refs.step3),
 text: 'This is the step 3'
}];
// [...]
<ReactTour
 config={ReactTourConfig}
 currentStep={<integer>}
 visible={<bool>}
 showDots={<bool>} />

Don't forget to add styles!

@import url(node_modules/react-tour/dist/style.css);

Props

  • config: An array that contain the steps of the tour. Each step can have a node and text properties that contains the dom node to focus and the help text to display.
  • currentStep: Integer. The current step to display.
  • showDots: Bool. Show progress dots?
  • visible: Bool. Is the component visible?

About

Create nice step-by-step intros with React. [unmaintained]

Resources

Stars

29 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /