Constructor
JavaScript:
-
new Coral.SelectList()
ordocument.createElement('coral-selectlist')
HTML Tag:
-
<coral-selectlist>
Extends
Mixes In
Sub-components
Instance Properties
-
instance.groups {Coral.Collection}
Readonly -
-
instance.hidden {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- hidden
-
instance.items {Coral.Collection}
Readonly -
-
instance.loading {Boolean}
Reflected -
- Default Value:
- false
- HTML Attribute:
- loading
-
instance.multiple {Boolean}
-
- Default Value:
- false
- HTML Attribute:
- multiple
-
instance.selectedItem {HTMLElement}
Readonly -
-
instance.selectedItems {Array.<HTMLElement>}
Readonly -
The Collection Interface that allows interacting with the Coral.SelectList.Group elements that the
SelectList contains. This includes items nested inside groups. To manage items contained within a specific
group, see Coral.SelectList.Group#items.
See Coral.Collection for more details regarding collection APIs.
Whether this component is hidden or not.
The Collection Interface that allows interacting with the items that the component contains. See
Coral.Collection for more details.
Whether items are being loaded for the SelectList. Toggling this merely shows or hides a loading indicator.
Whether multiple items can be selected.
Returns the first selected item in the selectionList. The value
null
is returned if no element is
selected.
Returns an Array containing the set selected items.
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.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.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:
Get the value of a property.
Hide this component.
Remove an event listener.
Add an event listener.
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.
Set a single property.
Show this component.
Trigger an event.
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
Triggered when an item is added to the Collection. Collection events are not synchronous so the DOM may reflect
a different reality although every addition or removal will be reported.
Triggered when an item is removed from a Collection. Collection events are not synchronous so the DOM may reflect
a different reality although every addition or removal will be reported.
Triggered when the component is attached to the DOM.
Triggered when the component is detached to the DOM.
Triggerred when the component has been upgraded and is ready for use.