{"id":23156538,"url":"https://github.com/thecreation/jquery-wizard","last_synced_at":"2025-08-17T23:32:37.560Z","repository":{"id":31286388,"uuid":"34848390","full_name":"thecreation/jquery-wizard","owner":"thecreation","description":"A powerful jquery plugin for creating step-by-step wizards. Work great with bootstrap.","archived":false,"fork":false,"pushed_at":"2018-02-21T16:06:31.000Z","size":413,"stargazers_count":85,"open_issues_count":15,"forks_count":25,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-08-05T23:25:22.353Z","etag":null,"topics":["jquery-plugin","wizard","wizards"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thecreation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-30T10:18:42.000Z","updated_at":"2025-01-09T21:42:44.000Z","dependencies_parsed_at":"2022-08-31T09:21:49.634Z","dependency_job_id":null,"html_url":"https://github.com/thecreation/jquery-wizard","commit_stats":null,"previous_names":["amazingsurge/jquery-wizard"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/thecreation/jquery-wizard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-wizard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-wizard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-wizard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-wizard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecreation","download_url":"https://codeload.github.com/thecreation/jquery-wizard/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-wizard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270922510,"owners_count":24668565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jquery-plugin","wizard","wizards"],"created_at":"2024-12-17T21:13:55.440Z","updated_at":"2025-08-17T23:32:37.226Z","avatar_url":"https://github.com/thecreation.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [jQuery wizard](https://github.com/amazingSurge/jquery-wizard) ![bower][bower-image] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![prs-welcome]](#contributing)\n\n\u003e A jquery plugin for creating step-by-step wizards.\n\n## Table of contents\n- [Main files](#main-files)\n- [Quick start](#quick-start)\n- [Requirements](#requirements)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Options](#options)\n- [Methods](#methods)\n- [Events](#events)\n- [No conflict](#no-conflict)\n- [Browser support](#browser-support)\n- [Contributing](#contributing)\n- [Development](#development)\n- [Changelog](#changelog)\n- [Copyright and license](#copyright-and-license)\n\n## Main files\n```\ndist/\n├── jquery-wizard.js\n├── jquery-wizard.es.js\n├── jquery-wizard.min.js\n└── css/\n    ├── wizard.css\n    └── wizard.min.css\n```\n\n## Quick start\nSeveral quick start options are available:\n#### Download the latest build\n\n * [Development](https://raw.githubusercontent.com/amazingSurge/jquery-wizard/master/dist/jquery-wizard.js) - unminified\n * [Production](https://raw.githubusercontent.com/amazingSurge/jquery-wizard/master/dist/jquery-wizard.min.js) - minified\n\n#### Install From Bower\n```sh\nbower install jquery-wizard.js --save\n```\n\n#### Install From Npm\n```sh\nnpm install jquery-wizard --save\n```\n\n#### Install From Yarn\n```sh\nyarn add jquery-wizard\n```\n\n#### Build From Source\nIf you want build from source:\n\n```sh\ngit clone git@github.com:amazingSurge/jquery-wizard.git\ncd jquery-wizard\nnpm install\nnpm install -g gulp-cli babel-cli\ngulp build\n```\n\nDone!\n\n## Requirements\n`jquery-wizard` requires the latest version of [`jQuery`](https://jquery.com/download/).\n\n## Usage\n#### Including files:\n\n```html\n\u003clink rel=\"stylesheet\" href=\"/path/to/wizard.css\"\u003e\n\u003cscript src=\"/path/to/jquery.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"/path/to/jquery-wizard.js\"\u003e\u003c/script\u003e\n```\n\n#### Required HTML structure\n\n```html\n\u003cdiv class=\"wizard\"\u003e\n  \u003cul class=\"wizard-steps\" role=\"tablist\"\u003e\n    \u003cli class=\"active\" role=\"tab\"\u003e\n      Step 1\n    \u003c/li\u003e\n    \u003cli role=\"tab\"\u003e\n      Step 2\n    \u003c/li\u003e\n    \u003cli role=\"tab\"\u003e\n      Step 3\n    \u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cdiv class=\"wizard-content\"\u003e\n    \u003cdiv class=\"wizard-pane active\" role=\"tabpanel\"\u003eStep Content 1\u003c/div\u003e\n    \u003cdiv class=\"wizard-pane\" role=\"tabpanel\"\u003eStep Content 2\u003c/div\u003e\n    \u003cdiv class=\"wizard-pane\" role=\"tabpanel\"\u003eStep Content 3\u003c/div\u003e\n  \u003c/div\u003e\n\u003c/div\u003e\n```\n\n#### Initialization\nAll you need to do is call the plugin on the element:\n\n```javascript\njQuery(function($) {\n  $('.example').wizard(); \n});\n```\n\n## Examples\nThere are some example usages that you can look at to get started. They can be found in the\n[examples folder](https://github.com/amazingSurge/jquery-wizard/tree/master/examples).\n\n## Options\n`jquery-wizard` can accept an options object to alter the way it behaves. You can see the default options by call `$.wizard.setDefaults()`. The structure of an options object is as follows:\n\n```\n{\n  step: '.wizard-steps \u003e li',\n\n  getPane: function(index, step) {\n    return this.$element.find('.wizard-content').children().eq(index);\n  },\n\n  buttonsAppendTo: 'this',\n  templates: {\n    buttons: function() {\n      const options = this.options;\n      return `\u003cdiv class=\"wizard-buttons\"\u003e\u003ca class=\"wizard-back\" href=\"#${this.id}\" data-wizard=\"back\" role=\"button\"\u003e${options.buttonLabels.back}\u003c/a\u003e\u003ca class=\"wizard-next\" href=\"#${this.id}\" data-wizard=\"next\" role=\"button\"\u003e${options.buttonLabels.next}\u003c/a\u003e\u003ca class=\"wizard-finish\" href=\"#${this.id}\" data-wizard=\"finish\" role=\"button\"\u003e${options.buttonLabels.finish}\u003c/a\u003e\u003c/div\u003e`;\n    }\n  },\n\n  classes: {\n    step: {\n      done: 'done',\n      error: 'error',\n      active: 'current',\n      disabled: 'disabled',\n      activing: 'activing',\n      loading: 'loading'\n    },\n\n    pane: {\n      active: 'active',\n      activing: 'activing'\n    },\n\n    button: {\n      hide: 'hide',\n      disabled: 'disabled'\n    }\n  },\n\n  autoFocus: true,\n  keyboard: true,\n\n  enableWhenVisited: false,\n\n  buttonLabels: {\n    next: 'Next',\n    back: 'Back',\n    finish: 'Finish'\n  },\n\n  loading: {\n    show: function(step) { },\n    hide: function(step) { },\n    fail: function(step) { }\n  },\n\n  cacheContent: false,\n\n  validator: function(step) {\n    return true;\n  },\n\n  onInit: null,\n  onNext: null,\n  onBack: null,\n  onReset: null,\n\n  onBeforeShow: null,\n  onAfterShow: null,\n  onBeforeHide: null,\n  onAfterHide: null,\n  onBeforeLoad: null,\n  onAfterLoad: null,\n\n  onBeforeChange: null,\n  onAfterChange: null,\n\n  onStateChange: null,\n\n  onFinish: null\n}\n```\n\n\n## Methods\nMethods are called on wizard instances through the wizard method itself.\nYou can also save the instances to variable for further use.\n\n```javascript\n// call directly\n$().wizard('goTo', 0);\n\n// or\nvar api = $().data('wizard');\napi.goTo(0);\n```\n\n#### goTo(index)\nGo to the specifc step.\n```javascript\n// go to the first step\n$().wizard('goTo', 0);\n\n// move to 50%\n$().wizard('moveTo', '50%');\n```\n\n#### length()\nGet the steps length.\n```javascript\n$().wizard('length');\n```\n\n#### get(index)\nGet the step instance further use.\n```javascript\n// get the second step instance\nvar step = $().wizard('get', 1);\n```\n\n#### current()\nGet the current shown step instance\n```javascript\nvar step = $().wizard('current');\n```\n\n#### currentIndex()\nGet the current shown step index\n```javascript\nvar index = $().wizard('currentIndex');\n```\n\n#### lastIndex()\nGet the last index\n```javascript\nvar index = $().wizard('lastIndex');\n```\n\n#### next()\nGo to the next step\n```javascript\n$().wizard('next');\n```\n\n#### back()\nGo back to the previous step\n```javascript\n$().wizard('back');\n```\n\n#### first()\nGo back to the first step\n```javascript\n$().wizard('first');\n```\n\n#### finish()\nFinish the wizard when the current step is the last one\n```javascript\n$().wizard('finish');\n```\n\n#### reset()\nReset the wizard.\n```javascript\n$().wizard('reset');\n```\n\n#### destroy()\nDestroy the wizard instance.\n```javascript\n$().wizard('destroy');\n```\n\n## Events\n`jquery-wizard` provides custom events for the plugin’s unique actions. \n\n```javascript\n$('.the-element').on('wizard::ready', function (e) {\n  // on instance ready\n});\n\n```\n\nEvent       | Description\n----------- | -----------\ninit        | Fires when the instance is setup for the first time.\nready       | Fires when the instance is ready for API use.\nnext        | Fired when the `next` instance method has been called.\nback        | Fired when the `back` instance method has been called.\nreset       | Fired when the `reset` instance method has been called.\nbeforeChange| This event is fired before the step change.\nafterChange | This event is fired after the step change.\nfinish      | Fires when the wizard is finished.\ndestroy     | Fires when an instance is destroyed. \n\n## No conflict\nIf you have to use other plugin with the same namespace, just call the `$.wizard.noConflict` method to revert to it.\n\n```html\n\u003cscript src=\"other-plugin.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"jquery-wizard.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  $.wizard.noConflict();\n  // Code that uses other plugin's \"$().wizard\" can follow here.\n\u003c/script\u003e\n```\n\n## Browser support\n\nTested on all major browsers.\n\n| \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/safari/safari_32x32.png\" alt=\"Safari\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/chrome/chrome_32x32.png\" alt=\"Chrome\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/firefox/firefox_32x32.png\" alt=\"Firefox\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/edge/edge_32x32.png\" alt=\"Edge\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/internet-explorer/internet-explorer_32x32.png\" alt=\"IE\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/opera/opera_32x32.png\" alt=\"Opera\"\u003e |\n|:--:|:--:|:--:|:--:|:--:|:--:|\n| Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |\n\nAs a jQuery plugin, you also need to see the [jQuery Browser Support](http://jquery.com/browser-support/).\n\n## Contributing\nAnyone and everyone is welcome to contribute. Please take a moment to\nreview the [guidelines for contributing](CONTRIBUTING.md). Make sure you're using the latest version of `jquery-wizard` before submitting an issue. There are several ways to help out:\n\n* [Bug reports](CONTRIBUTING.md#bug-reports)\n* [Feature requests](CONTRIBUTING.md#feature-requests)\n* [Pull requests](CONTRIBUTING.md#pull-requests)\n* Write test cases for open bug issues\n* Contribute to the documentation\n\n## Development\n`jquery-wizard` is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:\n\n```sh\nnpm install -g gulp\nnpm install -g babel-cli\nnpm install\n```\n\nThen you can generate new distributable files from the sources, using:\n```\ngulp build\n```\n\nMore gulp tasks can be found [here](CONTRIBUTING.md#available-tasks).\n\n## Changelog\nTo see the list of recent changes, see [Releases section](https://github.com/amazingSurge/jquery-wizard/releases).\n\n## Copyright and license\nCopyright (C) 2016 amazingSurge.\n\nLicensed under [the LGPL license](LICENSE).\n\n[⬆ back to top](#table-of-contents)\n\n[bower-image]: https://img.shields.io/bower/v/jquery-wizard.js.svg?style=flat\n[bower-link]: https://david-dm.org/amazingSurge/jquery-wizard/dev-status.svg\n[npm-image]: https://badge.fury.io/js/jquery-wizard.svg?style=flat\n[npm-url]: https://npmjs.org/package/jquery-wizard\n[license]: https://img.shields.io/npm/l/jquery-wizard.svg?style=flat\n[prs-welcome]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[daviddm-image]: https://david-dm.org/amazingSurge/jquery-wizard.svg?style=flat\n[daviddm-url]: https://david-dm.org/amazingSurge/jquery-wizard","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjquery-wizard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecreation%2Fjquery-wizard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjquery-wizard/lists"}