Lightweight jQuery step wizard plugin.
Branch: master
Clone or download
Latest commit 97c0ca0 Sep 15, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
examples Initial commit Apr 19, 2017
src Incremented version Sep 12, 2017
test
.editorconfig Added .editorconfig Apr 22, 2017
.eslintrc.yml Add eslint with airbnb-config Apr 22, 2017
.gitattributes Added .gitattributes & .gitignore files Apr 22, 2017
.gitignore Added .gitattributes & .gitignore files Apr 22, 2017
README.md Changed package name Sep 15, 2017
package-lock.json Incremented version Sep 12, 2017
package.json Changed package name Sep 15, 2017
rollup.config.js Initial commit Apr 19, 2017

README.md

jquery-steps

License: MIT

A simple, lightweight jQuery step wizard plugin.

Features

  • Easy configuration
  • Lightweight (2KB gzipped)
  • Works in all major browsers including IE11+

Compatibility

IE11+, Edge, Chrome, Firefox, Opera, Safari

Installation

NPM

npm install jquery.steps

Github

git clone http://github.com/oguzhanoya/jquery-steps.git

Setup

Include plugin stylesheets.

<link rel="stylesheet" href="css/jquery-steps.css">

Make necessary markup for wizard. That's all, you don't need to do anything else.

<div id="demo">
    <div class="step-app">
        <ul class="step-steps">
            <li><a href="#step1">Step 1</a></li>
            <li><a href="#step2">Step 2</a></li>
            <li><a href="#step3">Step 3</a></li>
        </ul>
        <div class="step-content">
            <div class="step-tab-panel" id="step1">
                ...
            </div>
            <div class="step-tab-panel" id="step2">
                ...
            </div>
            <div class="step-tab-panel" id="step3">
                ...
            </div>
        </div>
        <div class="step-footer">
            <button data-direction="prev">Previous</button>
            <button data-direction="next">Next</button>
            <button data-direction="finish">Finish</button>
        </div>
    </div>
</div>

Include plugin and dependeces. jQuery is the only dependency, make sure to include it.

<script src="http://code.jquery.com/jquery-latest.min.js"></script>
<script src="js/jquery-steps.js"></script>

Init plugin with choosen options.

<script>
    $('#demo').steps({
        onFinish: function () { alert('complete'); }
    });
</script>

Configuration

Setting Default Value Description
startAt 0 Start wizard at specifed step number.
showBackButton true Indicates whether the back button will be visible.
showFooterButtons true Indicates whether the footer buttons will be visible.
stepSelector .step-steps > li The selector used for each step.
contentSelector .step-content > .step-tab-panel The selector used for the step content.
footerSelector .step-footer The selector used for the buttons.
buttonSelector button The selector used for the footer buttons.
activeClass active The class used when a step is active.
doneClass done The class used when a step is done.
errorClass error The class used when an error occurs in a step.
onInit function(){} Fired when plugin is initialized
onChange function(currentIndex, newIndex, stepDirection){return true;} Fired when plugin step changed
onFinish function(){} Fired when plugin wizard finished
onDestroy function(){} Fired when plugin destroy

License

MIT