Constructor
JavaScript:
-
new Coral.Select()
ordocument.createElement('coral-select')
HTML Tag:
-
<coral-select>
Extends
Sub-components
Static Properties
-
Coral.Select.variant {String}
-
Properties:
Name Type Value Description DEFAULT String default A default, gray Select. QUIET String quiet A Select with no border or background.
Enum for Select variant values.
Instance Properties
-
instance.disabled {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- disabled
-
instance.hidden {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- hidden
-
instance.invalid {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- invalid
-
instance.items {Coral.Collection}
Readonly -
-
instance.labelledBy {String}
-
- Inherited From:
- Default Value:
- null
- HTML Attribute:
- labelledby
-
instance.loading {Boolean}
-
- Default Value:
- false
- HTML Attribute:
- loading
-
instance.multiple {Boolean}
Reflected -
- Default Value:
- false
- HTML Attribute:
- multiple
-
instance.name {String}
Reflected -
- Inherited From:
- Default Value:
- ""
- HTML Attribute:
- name
-
instance.placeholder {String}
Reflected -
- Default Value:
- ""
- HTML Attribute:
- placeholder
-
instance.readOnly {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- readonly
-
instance.required {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- required
-
instance.selectedItem {HTMLElement}
Readonly -
-
instance.selectedItems {Array.<HTMLElement>}
Readonly -
-
instance.value {String}
-
- Inherited From:
- Default Value:
- ""
- HTML Attribute:
- value
-
instance.values {Array.<String>}
-
-
instance.variant {Coral.Select.variant}
-
- Default Value:
- Coral.Select.variant.DEFAULT
- HTML Attribute:
- variant
Whether this field is disabled or not.
Whether this component is hidden or not.
Whether the current value of this field is invalid or not.
The item collection.
See Coral.Collection for more details.
Reference to a space delimited set of ids for the HTML elements that provide a label for the formField.
Implementers should override this method to ensure that the appropriate descendant elements are labelled using the
aria-labelledby
attribute. This will ensure that the component is properly identified for
accessibility purposes. It reflects the aria-labelledby
attribute to the DOM.
Indicates that the Select is currently loading remote data. This will set the wait indicator inside the list.
Indicates whether the select accepts multiple selected values.
Name used to submit the data in a form.
Contains a hint to the user of what can be selected in the component. If no placeholder is provided, the first
option will be displayed in the component.
Whether this field is readOnly or not. Indicating that the user cannot modify the value of the control.
This is ignored for checkbox, radio or fileupload.
Whether this field is required or not.
Returns the first selected item in the Select. The value
null
is returned if no element is
selected.
Returns an Array containing the set selected items.
This field's current value.
The current selected values, as submitted during form submission. When Coral.Select#multiple is
false
, this will be an array of length 1.
The Select's variant.
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
-
change
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- 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 the value has changed. This event is only triggered by user interaction.
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.