Skip to content

wearefractal/react-gandalf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-gandalf NPM version Downloads Support us Build Status Coveralls Status

Information














Packagereact-gandalf
DescriptionReact component for setup wizards and steps
Node Version>= 0.10

Usage

Install

npm install react-gandalf --save

Example

Wizard

var Wizard = React.createClass({
  render: function(){
    var LoginStep = {
      name: 'Login',
      component: Login,
      skippable: false
    };
    var AddFriendsStep = {
      name: 'Add Friends',
      component: AddFriends,
      skippable: true
    };
    var FinishStep = {
      name: 'Finish Setup',
      component: FinishSetup,
      skippable: false
    };
    return Gandalf({
      steps: [
        LoginStep,
        AddFriendsStep,
        FinishStep
      ]
    });
  }
});

Each Child Step

var Login = React.createClass({
  PropTypes: {
    nextStep: PropTypes.func,
    previousStep: PropTypes.func
  }
  render: function() {
    return DOM.div({
      className: 'first'
    },
      DOM.button({
        className: 'button',
        onClick: this.props.nextStep
      }, 'Next');
    );
  }
})

LICENSE

(MIT License)

Copyright (c) 2015 Fractal [email protected]

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.