Adds multistep functionality to forms using jQuery.
- Source:
Methods
(static) .disableNavigation(panelopt)
Disable navigation.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
panel |
object |
<optional> |
The current panel | the panel node |
- Source:
Fires:
- event:multistepNavigationDisabled
(static) .disableSubmit()
Disable the submit button.
- Source:
(static) .enableNavigation(panelopt)
Enable navigation.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
panel |
object |
<optional> |
The current panel | the panel node |
- Source:
Fires:
- event:multistepNavigationEnabled
- event:multistepNextTriggered
- event:multistepPrevTriggered
(static) .getIndex(panelopt) → {object}
Get a panel index.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
panel |
object |
<optional> |
A panel | a panel node |
- Source:
Returns:
The current panel object.
- Type
- object
(static) .goto(index, onSuccess, onFailure)
Go to a panel.
Parameters:
Name | Type | Description |
---|---|---|
index |
number | the index of the panel in the panels array. |
onSuccess |
onSuccessCallback | success callback |
onFailure |
onFailureCallback | failure callback |
- Source:
Fires:
- event:multistepPanelLoaded
(static) .init(context)
Initialise the multistep form.
Parameters:
Name | Type | Description |
---|---|---|
context |
object | DOM element containing the multistep form |
- Source:
(static) .next(onSuccess, onFailure)
Go to the next panel.
Parameters:
Name | Type | Description |
---|---|---|
onSuccess |
onSuccessCallback | success callback |
onFailure |
onFailureCallback | failure callback |
- Source:
(static) .prev(onSuccess, onFailure)
Go to the previous panel.
Parameters:
Name | Type | Description |
---|---|---|
onSuccess |
onSuccessCallback | success callback |
onFailure |
onFailureCallback | failure callback |
- Source:
(static) .updateHeight(panelopt)
Update the container height.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
panel |
object |
<optional> |
The current panel | the panel node |
- Source:
Type Definitions
.onFailureCallback(message)
Callback for failed navigation to another panel.
Parameters:
Name | Type | Description |
---|---|---|
message |
string | failure message. |
- Source:
.onSuccessCallback(index)
Callback for successful navigation to another panel.
Parameters:
Name | Type | Description |
---|---|---|
index |
int | the index of the panel being navigated to. |
- Source: