Select
Allow users to pick one option from a menu. Ideal when presenting four or more choices to keep interfaces uncluttered.
Anchor to propertiesProperties
- Anchor to autocompleteautocompleteAutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | "on" | "off"Default: 'on' for everything else
A hint as to the intended content of the field.
When set to
on(the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.When set to
off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.
- Anchor to disableddisabledbooleanDefault: false
Disables the field, disallowing any interaction.
- Anchor to errorerrorstring
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
- string
A unique identifier for the element.
- Anchor to labellabelstring
Content to use as the field label.
- Anchor to namenamestring
An identifier for the field that is unique within the nearest containing form.
- Anchor to placeholderplaceholderstring
A short hint that describes the expected value of the field.
- Anchor to requiredrequiredbooleanDefault: false
Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the
errorproperty.- Anchor to valuevaluestring
The current value for the field. If omitted, the field will be empty.
AutocompleteSection
The “section” scopes the autocomplete data that should be inserted to a specific area of the page. Commonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.
`section-${string}`AutocompleteGroup
The contact information group the autocomplete data should be sourced from.
"shipping" | "billing"Anchor to eventsEvents
Learn more about registering events.
- Anchor to blurblurCallbackEventListener<typeof tagName>
Callback when the element loses focus.
- Anchor to changechangeCallbackEventListener<typeof tagName>
Callback when the user has finished editing a field, e.g. once they have blurred the field.
- Anchor to focusfocusCallbackEventListener<typeof tagName>
Callback when the element receives focus.
CallbackEventListener
(EventListener & {
(event: CallbackEvent<TTagName, Event> & TData): void;
}) | nullCallbackEvent
TEvent & {
currentTarget: HTMLElementTagNameMap[TTagName];
}Anchor to optionOption
Represents a single option within a select component. Use only as a child of s-select components.
- Anchor to accessibilityLabelaccessibilityLabelstring
A label used for users using assistive technologies like screen readers. When set, any children or
labelsupplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.- Anchor to defaultSelecteddefaultSelectedbooleanDefault: false
Whether the control is active by default.
- Anchor to disableddisabledbooleanDefault: false
Disables the control, disallowing any interaction.
- string
A unique identifier for the element.
- Anchor to selectedselectedbooleanDefault: false
Whether the control is active.
- Anchor to valuevaluestring
The value used in form data when the control is checked.
Code
Examples
Code
Default
<s-select label="Country/region"> <s-option defaultSelected value="CA">Canada</s-option> <s-option value="US">United States</s-option> <s-option value="UK">United Kingdom</s-option> </s-select>
Preview
