Coral.WizardView API

Constructor

JavaScript:

new Coral.WizardView() or document.createElement('coral-wizardview')

HTML Tag:

<coral-wizardview>

Extends

Instance Properties

instance.panelStacks {Coral.Collection}

Readonly
The set of controlled PanelStacks. Each PanelStack must have the coral-wizardview-panelstack attribute. See Coral.Collection for more details regarding collection APIs.

instance.stepLists {Coral.Collection}

Readonly
The set of controlling StepLists. Each StepList must have the coral-wizardview-steplist attribute. See Coral.Collection for more details regarding collection APIs.

Methods

instance.get

Get the value of a property.
Parameters:
Name Type Description
property String The name of the property to fetch the value of.
Returns:
Property value. {*}
Inherited From:

instance.hide

Hide this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.next

Shows the next step. If the WizardView is already in the last step nothing will happen.
Fires:

instance.off

Remove an event listener.
Parameters:
Name Type Optional Description
eventName String No
The event name to stop listening for.
selector String Yes
The selector that was used for event delegation.
func function No
The function that was passed to on().
useCapture Boolean Yes
Only remove listeners with useCapture set to the value passed in.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.on

Add an event listener.
Parameters:
Name Type Optional Default Description
eventName String No
The event name to listen for.
selector String Yes
The selector to use for event delegation.
func function No
The function that will be called when the event is triggered.
useCapture Boolean Yes
false Whether or not to listen during the capturing or bubbling phase.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.previous

Shows the previous step. If the WizardView is already in the first step nothing will happen.
Fires:

instance.remove

Non-destructively remove this element. It can be re-added by simply appending it to the document again. It will be garbage collected if there are no more references to it. This is different from using jQuery's remove(), which is destructive in that it removes data and listeners.
Inherited From:

instance.show

Show this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.trigger

Trigger an event.
Parameters:
Name Type Optional Default Description
eventName String No
The event name to trigger.
props Object Yes
Additional properties to make available to handlers as event.detail.
bubbles Boolean Yes
true Set to false to prevent the event from bubbling.
cancelable Boolean Yes
true Set to false to prevent the event from being cancelable.
Returns:
CustomEvent object {CustomEvent}
Inherited From:

Events

coral-component:attached

Triggered when the component is attached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:detached

Triggered when the component is detached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:ready

Triggerred when the component has been upgraded and is ready for use.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-wizardview:change

Triggered when the selected step list item has changed.
Callback Parameters:
Name Type Description
event Object

Event object.

Name Type Description
event.detail.selection HTMLElement The new selected step list item.
event.detail.oldSelection HTMLElement The prior selected step list item.