Light Dark System

Select

<sc-select> | ScSelect
Since 2.0 stable

Selects allow you to choose items from a menu of predefined options.

Option 1 Option 2 Option 3 Option 4 Option 5 Option 6 
<sc-select>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
  <sc-option value="option-4">Option 4</sc-option>
  <sc-option value="option-5">Option 5</sc-option>
  <sc-option value="option-6">Option 6</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
    <ScOption value="option-4">Option 4</ScOption>
    <ScOption value="option-5">Option 5</ScOption>
    <ScOption value="option-6">Option 6</ScOption>
  </ScSelect>
);

Examples

Labels

Use the label attribute to give the select an accessible label. For labels that contain HTML, use the label slot instead.

Option 1 Option 2 Option 3 
<sc-select label="Select one">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect label="Select one">
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Help Text

Add descriptive help text to a select with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.

Novice Intermediate Advanced 
<sc-select label="Experience" help-text="Please tell us your skill level.">
  <sc-option value="1">Novice</sc-option>
  <sc-option value="2">Intermediate</sc-option>
  <sc-option value="3">Advanced</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect label="Experience" help-text="Please tell us your skill level.">
    <ScOption value="1">Novice</ScOption>
    <ScOption value="2">Intermediate</ScOption>
    <ScOption value="3">Advanced</ScOption>
  </ScSelect>
);

Placeholders

Use the placeholder attribute to add a placeholder.

Option 1 Option 2 Option 3 
<sc-select placeholder="Select one">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect placeholder="Select one">
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Clearable

Use the clearable attribute to make the control clearable. The clear button only appears when an option is selected.

Option 1 Option 2 Option 3 
<sc-select clearable value="option-1">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect placeholder="Clearable" clearable>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Filled Selects

Add the filled attribute to draw a filled select.

Option 1 Option 2 Option 3 
<sc-select filled>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect filled>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Pill

Use the pill attribute to give selects rounded edges.

Option 1 Option 2 Option 3 
<sc-select pill>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect pill>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Disabled

Use the disabled attribute to disable a select.

Option 1 Option 2 Option 3 
<sc-select placeholder="Disabled" disabled>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect placeholder="Disabled" disabled>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Multiple

To allow multiple options to be selected, use the multiple attribute. It’s a good practice to use clearable when this option is enabled. To set multiple values at once, set value to a space-delimited list of values.

Option 1 Option 2 Option 3 Option 4 Option 5 Option 6 
<sc-select label="Select a Few" value="option-1 option-2 option-3" multiple clearable>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
  <sc-option value="option-4">Option 4</sc-option>
  <sc-option value="option-5">Option 5</sc-option>
  <sc-option value="option-6">Option 6</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect label="Select a Few" value={["option-1", "option-2", "option-3"]} multiple clearable>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
    <ScOption value="option-4">Option 4</ScOption>
    <ScOption value="option-5">Option 5</ScOption>
    <ScOption value="option-6">Option 6</ScOption>
  </ScSelect>
);

Setting Initial Values

Use the value attribute to set the initial selection.

When using multiple, the value attribute uses space-delimited values to select more than one option. Because of this, <sc-option> values cannot contain spaces. If you’re accessing the value property through Javascript, it will be an array.

Option 1 Option 2 Option 3 Option 4 
<sc-select value="option-1 option-2" multiple clearable>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
  <sc-option value="option-4">Option 4</sc-option>
</sc-select>

import ScDivider from '@styledc-dev/styledc/dist/react/divider';
import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect value={["option-1", "option-2"]} multiple clearable>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScSelect>
);

Grouping Options

Use <sc-divider> to group listbox items visually. You can also use <small> to provide labels, but they won’t be announced by most assistive devices.

Section 1 Option 1 Option 2 Option 3 Section 2 Option 4 Option 5 Option 6 
<sc-select>
  <small>Section 1</small>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
  <sc-divider></sc-divider>
  <small>Section 2</small>
  <sc-option value="option-4">Option 4</sc-option>
  <sc-option value="option-5">Option 5</sc-option>
  <sc-option value="option-6">Option 6</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect>
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
    <ScOption value="option-4">Option 4</ScOption>
    <ScOption value="option-5">Option 5</ScOption>
    <ScOption value="option-6">Option 6</ScOption>
  </ScSelect>
);

Sizes

Use the size attribute to change a select’s size. Note that size does not apply to listbox options.

Option 1 Option 2 Option 3
Option 1 Option 2 Option 3
Option 1 Option 2 Option 3 
<sc-select placeholder="Small" size="small">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

<br />

<sc-select placeholder="Medium" size="medium">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

<br />

<sc-select placeholder="Large" size="large">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <>
    <ScSelect placeholder="Small" size="small">
      <ScOption value="option-1">Option 1</ScOption>
      <ScOption value="option-2">Option 2</ScOption>
      <ScOption value="option-3">Option 3</ScOption>
    </ScSelect>

    <br />

    <ScSelect placeholder="Medium" size="medium">
      <ScOption value="option-1">Option 1</ScOption>
      <ScOption value="option-2">Option 2</ScOption>
      <ScOption value="option-3">Option 3</ScOption>
    </ScSelect>

    <br />

    <ScSelect placeholder="Large" size="large">
      <ScOption value="option-1">Option 1</ScOption>
      <ScOption value="option-2">Option 2</ScOption>
      <ScOption value="option-3">Option 3</ScOption>
    </ScSelect>
  </>
);

Placement

The preferred placement of the select’s listbox can be set with the placement attribute. Note that the actual position may vary to ensure the panel remains in the viewport. Valid placements are top and bottom.

Option 1 Option 2 Option 3 
<sc-select placement="top">
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <ScSelect placement="top">
    <ScOption value="option-1">Option 1</ScOption>
    <ScOption value="option-2">Option 2</ScOption>
    <ScOption value="option-3">Option 3</ScOption>
  </ScDropdown>
);

Prefix Icons

Use the prefix slot to prepend an icon to the control.

Option 1 Option 2 Option 3
Option 1 Option 2 Option 3
Option 1 Option 2 Option 3 
<sc-select placeholder="Small" size="small" clearable>
  <sc-icon name="house" slot="prefix"></sc-icon>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>
<br />
<sc-select placeholder="Medium" size="medium" clearable>
  <sc-icon name="house" slot="prefix"></sc-icon>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>
<br />
<sc-select placeholder="Large" size="large" clearable>
  <sc-icon name="house" slot="prefix"></sc-icon>
  <sc-option value="option-1">Option 1</sc-option>
  <sc-option value="option-2">Option 2</sc-option>
  <sc-option value="option-3">Option 3</sc-option>
</sc-select>

import ScIcon from '@styledc-dev/styledc/dist/react/icon';
import ScOption from '@styledc-dev/styledc/dist/react/option';
import ScSelect from '@styledc-dev/styledc/dist/react/select';

const App = () => (
  <>
    <ScSelect placeholder="Small" size="small">
      <ScIcon name="house" slot="prefix"></ScIcon>
      <ScOption value="option-1">Option 1</ScOption>
      <ScOption value="option-2">Option 2</ScOption>
      <ScOption value="option-3">Option 3</ScOption>
    </ScSelect>
    <br />
    <ScSelect placeholder="Medium" size="medium">
      <ScIcon name="house" slot="prefix"></ScIcon>
      <ScOption value="option-1">Option 1</ScOption>
      <ScOption value="option-2">Option 2</ScOption>
      <ScOption value="option-3">Option 3</ScOption>
    </ScSelect>
    <br />
    <ScSelect placeholder="Large" size="large">
      <ScIcon name="house" slot="prefix"></ScIcon>
      <ScOption value="option-1">Option 1</ScOption>
      <ScOption value="option-2">Option 2</ScOption>
      <ScOption value="option-3">Option 3</ScOption>
    </ScSelect>
  </>
);

Custom Tags

When multiple options can be selected, you can provide custom tags by passing a function to the getTag property. Your function can return a string of HTML, a Lit Template, or an HTMLElement. The getTag() function will be called for each option. The first argument is an <sc-option> element and the second argument is the tag’s index (its position in the tag list).

Remember that custom tags are rendered in a shadow root. To style them, you can use the style attribute in your template or you can add your own parts and target them with the ::part() selector.

Email Phone Chat 
<sc-select
  placeholder="Select one"
  value="email phone"
  multiple
  clearable
  class="custom-tag"
>
  <sc-option value="email">
    <sc-icon slot="prefix" name="envelope"></sc-icon>
    Email
  </sc-option>
  <sc-option value="phone">
    <sc-icon slot="prefix" name="telephone"></sc-icon>
    Phone
  </sc-option>
  <sc-option value="chat">
    <sc-icon slot="prefix" name="chat-dots"></sc-icon>
    Chat
  </sc-option>
</sc-select>

<script type="module">
  const select = document.querySelector('.custom-tag');

  select.getTag = (option, index) => {
    // Use the same icon used in the <sc-option>
    const name = option.querySelector('sc-icon[slot="prefix"]').name;

    // You can return a string, a Lit Template, or an HTMLElement here
    return `
      <sc-tag removable>
        <sc-icon name="${name}" style="padding-inline-end: .5rem;"></sc-icon>
        ${option.getTextLabel()}
      </sc-tag>
    `;
  };
</script>

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

Script Import Bundler React

To import this component from the CDN using a script tag: 

<script type="module" src="https://cdn.jsdelivr.net/npm/@styledc-dev/styledc@1.0.0/cdn/components/select/select.js"></script>

To import this component from the CDN using a JavaScript import: 

import 'https://cdn.jsdelivr.net/npm/@styledc-dev/styledc@1.0.0/cdn/components/select/select.js';

To import this component using a bundler:

import '@styledc-dev/styledc/dist/components/select/select.js';

To import this component as a React component:

import ScSelect from '@styledc-dev/styledc/dist/react/select';

Slots

Name Description
(default) The listbox options. Must be <sc-option> elements. You can use <sc-divider> to group items visually.
label The input’s label. Alternatively, you can use the label attribute.
prefix Used to prepend a presentational icon or similar element to the combobox.
clear-icon An icon to use in lieu of the default clear icon.
expand-icon The icon to show when the control is expanded and collapsed. Rotates on open and close.
help-text Text that describes how to use the input. Alternatively, you can use the help-text attribute.

Learn more about using slots.

Properties

Name Description Reflects Type Default
name The name of the select, submitted as a name/value pair with form data. string ''
value The current value of the select, submitted as a name/value pair with form data. When multiple is enabled, the value attribute will be a space-delimited list of values based on the options selected, and the value property will be an array. For this reason, values must not contain spaces. string | string[] ''
defaultValue The default value of the form control. Primarily used for resetting the form control. string | string[] ''
size The select’s size. 'small' | 'medium' | 'large' 'medium'
placeholder Placeholder text to show as a hint when the select is empty. string ''
multiple Allows more than one option to be selected. boolean false
maxOptionsVisible
max-options-visible 		The maximum number of selected options to show when multiple is true. After the maximum, ”+n” will be shown to indicate the number of additional items that are selected. Set to 0 to remove the limit. number 3
disabled Disables the select control. boolean false
clearable Adds a clear button when the select is not empty. boolean false
open Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can use the show() and hide() methods and this attribute will reflect the select’s open state. boolean false
hoist Enable this option to prevent the listbox from being clipped when the component is placed inside a container with overflow: auto|scroll. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios. boolean false
filled Draws a filled select. boolean false
pill Draws a pill-style select with rounded edges. boolean false
label The select’s label. If you need to display HTML, use the label slot instead. string ''
placement The preferred placement of the select’s menu. Note that the actual placement may vary as needed to keep the listbox inside of the viewport. 'top' | 'bottom' 'bottom'
helpText
help-text 		The select’s help text. If you need to display HTML, use the help-text slot instead. string ''
form By default, form controls are associated with the nearest containing <form> element. This attribute allows you to place the form control outside of a form and associate it with the form that has this id. The form must be in the same document or shadow root for this to work. string ''
required The select’s required attribute. boolean false
getTag A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second is the current tag’s index. The function should return either a Lit TemplateResult or a string containing trusted HTML of the symbol to render at the specified value. (option: ScOption, index: number) => TemplateResult | string | HTMLElement -
validity Gets the validity state object - -
validationMessage Gets the validation message - -
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Events

Name React Event Description Event Detail
sc-change onScChange Emitted when the control’s value changes. -
sc-clear onScClear Emitted when the control’s value is cleared. -
sc-input onScInput Emitted when the control receives input. -
sc-focus onScFocus Emitted when the control gains focus. -
sc-blur onScBlur Emitted when the control loses focus. -
sc-show onScShow Emitted when the select’s menu opens. -
sc-after-show onScAfterShow Emitted after the select’s menu opens and all animations are complete. -
sc-hide onScHide Emitted when the select’s menu closes. -
sc-after-hide onScAfterHide Emitted after the select’s menu closes and all animations are complete. -
sc-invalid onScInvalid Emitted when the form control has been checked for validity and its constraints aren’t satisfied. -

Learn more about events.

Methods

Name Description Arguments
show() Shows the listbox. -
hide() Hides the listbox. -
checkValidity() Checks for validity but does not show a validation message. Returns true when valid and false when invalid. -
getForm() Gets the associated form, if one exists. -
reportValidity() Checks for validity and shows the browser’s validation message if the control is invalid. -
setCustomValidity() Sets a custom validation message. Pass an empty string to restore validity. message: string
focus() Sets focus on the control. options: FocusOptions
blur() Removes focus from the control. -

Learn more about methods.

Parts

Name Description
form-control The form control that wraps the label, input, and help text.
form-control-label The label’s wrapper.
form-control-input The select’s wrapper.
form-control-help-text The help text’s wrapper.
combobox The container the wraps the prefix, combobox, clear icon, and expand button.
prefix The container that wraps the prefix slot.
display-input The element that displays the selected option’s label, an <input> element.
listbox The listbox container where options are slotted.
tags The container that houses option tags when multiselect is used.
tag The individual tags that represent each multiselect option.
tag__base The tag’s base part.
tag__content The tag’s content part.
tag__remove-button The tag’s remove button.
tag__remove-button__base The tag’s remove button base part.
clear-button The clear button.
expand-icon The container that wraps the expand icon.

Learn more about customizing CSS parts.

Dependencies

This component automatically imports the following dependencies.

  • <sc-icon>
  • <sc-icon-button>
  • <sc-popup>
  • <sc-tag>