KTWizard
is a Keen's custom plugin defined in [keen]/theme/[demo]/src/js/components/wizard.js
.
KTWizard
is a Keen's custom plugin defined in [keen]/theme/[demo]/src/js/components/wizard.js
.
First parameter is the id, class, or tag of the HTML element. The second parameter is for the options.
wizard = new KTWizard('kt_wizard_v1', {
startStep: 1, // Initial active step number
clickableSteps: true, // Allow step clicking
});
wizard.goTo(2); // Change to a step by step number
alert(wizard.getStep()); // Get current step number. For more info see the full API functions list in the below table.
var options = {
startStep: 1, // Initial active step number
clickableSteps: true, // Allow step clicking
};
Field | Type | Description | ||
---|---|---|---|---|
startStep |
number |
The page number of step to start at the initial load.
|
||
clickableSteps |
boolean |
Enable/disable wizard step click on the wizard navigation bar.
|
||
navigation |
boolean |
Enable/disable wizard previouse and next navigation default handlers to allow attaching custom navgiation handlers that allows implementing custom form validaiton flow.
|
Atrribute | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data-wizard-state |
Set the initial KTWizard initial state. The state value will be changed based on interaction to the wizard.
|
||||||||||||||
data-wizard-type |
|
||||||||||||||
data-wizard-clickable |
|
Method | Description |
---|---|
setDefaults(options) |
Set default options. |
goNext() |
Go to the next step. |
goPrev() |
Go to the prev step. |
goLast() |
Go to the last step. |
goFirst() |
Go to the first step. |
goTo(number) |
Go to a step. |
stop() |
Stop wizard. |
resume() |
Resume wizard. |
getStep() |
Get current step number. |
getNewStep() |
Get new step number. |
setNewStep(number) |
Set new step number. |
isLastStep() |
Check last step. |
isFirstStep() |
Check first step. |
on(name, handler) |
Attach event("change", "changed", "submit"). |
one(name, handler) |
Attach event that will be fired once. |