A Select List allows the user to select a single option out of a relatively large number of items, or to reduce the visual prominence of an option selection.
<script type="module">
import { html, LitElement } from 'lit';
import { selectStyles } from '@brightspace-ui/core/components/inputs/input-select-styles.js';
class MySelectElem extends LitElement {
static get styles() {
return selectStyles;
}
render() {
return html`
<select class="d2l-input-select">
<option>Option 1</option>
<option>Option 2</option>
</select>
`;
}
}
customElements.define('d2l-my-select-elem', MySelectElem);
</script>
<d2l-my-select-elem></d2l-my-select-elem>
- Use to allow the user to select a single option from a relatively large list of options
- Use to save space / reduce the visual prominence of an exclusive selection option (instead of a choice from 8 radio buttons)
- Use a Select List to tuck away non-critical options, or options where the default selection is likely to be the most desirable.
- Don't use if your options are more than 1-2 words. The cognitive load of comparing options in a Select List is relatively high
- Select Lists show the available options offscreen – be careful if the selections you are asking the user to make are on the critical path – see Dropdowns should be the UI of last resort and be careful about your selection.
- Select Lists are form controls, and should not submit data or have instant actions on page occur without an explicit submit action. Toggling progressive disclosure is OK
- Don't use prompt text in place of a Select List field label – it’s harder to scan and negatively impacts accessibility.
- Don't use for numeric input – a text field with type “number” or a date-picker is much easier to use control
Native <select>
elements can be styled by importing input-select-styles.js
into your LitElement and applying the d2l-input-select
CSS class.
Note: in order for RTL to function correctly, make sure your component uses the RtlMixin
.
<script type="module">
import { css, html, LitElement } from 'lit';
import { RtlMixin } from '@brightspace-ui/core/mixins/rtl/rtl-mixin.js';
import { selectStyles } from '@brightspace-ui/core/components/inputs/input-select-styles.js';
import { SkeletonMixin } from '@brightspace-ui/core/components/skeleton/skeleton-mixin.js';
class TestInputSelect extends SkeletonMixin(RtlMixin(LitElement)) {
static get properties() {
return {
disabled: { type: Boolean },
invalid: { type: Boolean },
overflow: { type: Boolean }
};
}
static get styles() {
return [super.styles, selectStyles,
css`
:host {
display: inline-block;
}
:host([overflow]) select {
max-width: 130px;
}
`
];
}
render() {
const invalid = this.invalid ? 'true' : 'false';
return html`
<div class="d2l-skeletize">
<select
aria-label="Choose a dinosaur:"
aria-invalid="${invalid}"
class="d2l-input-select"
?disabled="${this.disabled}">
<option>Tyrannosaurus</option>
<option>Velociraptor</option>
<option>Deinonychus</option>
</select>
</div>
`;
}
}
customElements.define('d2l-test-input-select', TestInputSelect);
</script>
<d2l-test-input-select></d2l-test-input-select>