jquery.steps

!jquery-steps


> 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
``sh
npm install jquery.steps
`
Github
`sh
git clone http://github.com/oguzhanoya/jquery-steps.git
`
CDN
`html


`

Setup

Include plugin stylesheets.
`html

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



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


`
Init plugin with choosen options.
`html

`

Configuration

|Setting|Default Value|Description|
|---|---|---|
|startAt|0|Starts 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|The selector used for each step.|
|contentSelector|.step-content|The selector used for the step content.|
|footerSelector|.step-footer|The selector used for the 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.|

Methods

|Name|Description|
|---|---|
|destory|Destroy the plugin instance.|
|next|Goes to the next step.|
|prev|Goes to the previous step.|
|finish|Trigger the onFinish event.|
|getStepIndex|Gets the current step index.(start from 0)|
|getMaxStepIndex|Gets the max step index.|
|setStepIndex|Sets the step index.|

License

MIT