Select
<gcds-select>

Also called: dropdown, select menu.

A select provides a large list of options for single selection.

• GitHub
• Figma

On this page

• Coding and accessibility for select
• Examples
• Code builder

Coding and accessibility for select

Apply required attributes

For the select to function properly, always use the following attributes with <gcds-select>:

• name
• label
• select-id

Set the default value

Use the default-value attribute to set the first option in the select list. This avoids pre-selection of an option.

Handle error messages and validation

• Use the required attribute to activate the required validator. Validation will happen by default on the onBlur event. A missing or invalid entry will prompt an inline error message with preset text.

• If you need to change the validation event, use the validate-on attribute. Validation can happen on blur, when the element loses focus, or manually with the validate() method.

• Use the required attribute for fields that must be filled in. This places "required" at the end of the label.

• Use the error-message attribute to include an error message text for all required inputs. Avoid using error messages for optional ones.

• For optional fields, avoid adding the error-message attribute.

• For an optional field that needs validation based on user input (like validating an email address format), opt to add custom validation with a custom error message.

Include a hint text for task success

• Use the hint attribute to add hint text to help a person provide a complete value in the input and avoid an error state.

• Avoid adding hint text in the field (sometimes called placeholder text) where it will disappear once the field is selected or a response starts to be entered.

Hide the select label

• Set the hide-label attribute to true to visually hide the label while maintaining it for assistive technologies.
• Avoid adding hint text when you’re hiding the label or else provide an empty hint string.

In this section

• Essential attributes
• Optional attributes
• Slots

label

The label attribute defines the label for the select.

<gcds-select select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

name

The name attribute identifies the select component within a form. It is used to reference the component after a form is submitted.

<gcds-select select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

select-id

The select-id attribute specifies the unique identifier for the select component.

<gcds-select select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

autocomplete

The autocomplete attribute controls whether the browser can suggest previously entered values for the select.

<gcds-select autocomplete="on" select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

autofocus

The autofocus attribute controls whether the select will be focused automatically when the page loads. By default, it is set to false. When set to true, the select is focused on render.

<gcds-select autofocus select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

default-value

The default-value attribute defines an optional value that gets displayed before the user selects an option.

<gcds-select select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

disabled

The disabled attribute controls whether the radios are disabled or not. By default, it is set to false.

<gcds-select disabled select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

error-message

The error-message attribute defines the error message to display for invalid radios.

<gcds-select error-message="Error message" select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

form

The form attribute specifies the ID of the form that the radios belong to.

<gcds-select form="form-id" select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

hide-label

The hide-legend attribute controls whether the legend is hidden or not.

<gcds-select hide-label select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

hint

The hint attribute defines the hint text displayed under the label or legend.

<gcds-select hint="Hint / Example message." select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

required

The required attribute controls whether the radio fieldset is required or not. When set to true, it adds “required” after the legend, and activates the required validator.

<gcds-select required select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

validate-on

The validate-on attribute defines the validation event for the radios.

<gcds-select validate-on="other" required select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

value

The value attribute contains the value of the currently selected radio button. It updates when the selection changes.

<gcds-select value="2" select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

default

The default slot is for adding options and option groups.

<gcds-select select-id="select-preview" label="Label" name="select-preview" default-value="Select option">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
  <option value="3">Option 3</option>
</gcds-select>

Code builder

Generate an instance of the component you need by selecting its code properties.

1. Explore by choosing different code values to generate the instance you want.

2. Get the code and pull it into your environment.

3. Add any copy you need to the component (like text for a label).

Note: The code builder uses English for all code elements, which follows standard practice.