Constructor
JavaScript:
-
new Coral.StepList()
ordocument.createElement('coral-steplist')
HTML Tag:
-
<coral-steplist>
Extends
Mixes In
Static Properties
-
Coral.StepList.interaction {String}
-
- To Do:
-
- support "click only past steps" mode
Properties:
Name Type Value Description ON String on Steps can be clicked to visit them. OFF String off Steps cannot be clicked. -
Coral.StepList.size {String}
-
Properties:
Name Type Value Description SMALL String S A small-sized StepList. LARGE String L A large-sized StepList.
Instance Properties
-
instance.hidden {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- hidden
-
instance.interaction {Coral.StepList.interaction}
Reflected -
- Default Value:
- Coral.StepList.interaction.OFF
- HTML Attribute:
- interaction
-
instance.items {Coral.Collection}
Readonly -
-
instance.selectedItem {HTMLElement}
Readonly -
-
instance.size {Coral.StepList.size}
Reflected -
- Default Value:
- Coral.StepList.size.LARGE
- HTML Attribute:
- size
-
instance.target {HTMLElement | String}
-
- Default Value:
- null
- HTML Attribute:
- target
null
is returned if no element is
selected.
Methods
-
instance.get
-
- Parameters:
-
Name Type Description property String The name of the property to fetch the value of. - Returns:
-
Property value. {*}
- Inherited From:
-
instance.hide
-
- Returns:
-
this, chainable {Coral.Component}
- Inherited From:
-
instance.next
-
- Fires:
-
- Coral.StepList#event:coral-steplist:change
-
instance.off
-
- 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
-
- 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
Whether or not to listen during the capturing or bubbling phase. - Returns:
-
this, chainable. {Coral.Component}
- Inherited From:
-
instance.previous
-
- Fires:
-
- Coral.StepList#event:coral-steplist:change
-
instance.remove
-
- Inherited From:
-
instance.set
-
- Parameters:
-
Name Type Description property String The name of the property to set. value * The value to set the property to. silent Boolean If true, events should not be triggered as a result of this set. - Returns:
-
this, chainable. {Coral.Component}
- Inherited From:
-
instance.show
-
- Returns:
-
this, chainable {Coral.Component}
- Inherited From:
-
instance.trigger
-
- 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
Set to false
to prevent the event from bubbling.cancelable Boolean Yes
Set to false
to prevent the event from being cancelable. - Returns:
-
CustomEvent object {CustomEvent}
- Inherited From:
Events
-
coral-collection:add
-
- Callback Parameters:
-
Name Type Description event Object Event object.
Name Type Description event.detail.item HTMLElement The item that was added.
- Inherited From:
-
coral-collection:remove
-
- Callback Parameters:
-
Name Type Description event Object Event object.
Name Type Description event.detail.item HTMLElement The item that was removed.
- Inherited From:
-
coral-component:attached
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- Inherited From:
- Deprecated:
- since 1.14.0, use
MutationObserver
instead.
- since 1.14.0, use
-
coral-component:detached
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- Inherited From:
- Deprecated:
- since 1.14.0, use
MutationObserver
instead.
- since 1.14.0, use
-
coral-component:ready
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- Inherited From:
- Deprecated:
- since 1.9.0, use
Coral.commons.ready()
instead.
- since 1.9.0, use