Package Exports

@material/select
@material/select/constants
@material/select/dist/mdc.select
@material/select/dist/mdc.select.css
@material/select/dist/mdc.select.js
@material/select/foundation
@material/select/foundation.js
@material/select/index
@material/select/index.js
@material/select/mdc-select.scss

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@material/select) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Important - Default Style Deprecation Notice

The existing default select style will be changed in an upcoming release. The Material spec indicates that the default style will be the filled variant (currently referred to as the box variant). This will become the
default style. Continuing to add the mdc-select--box class to the select will result in no change.

Select Menus

MDC Select provides Material Design single-option select menus. It functions as a wrapper around the browser's native <select> element. It is fully accessible, and fully RTL-aware.

Design & API Documentation

Installation

npm install @material/select

Basic Usage

HTML Structure

<div class="mdc-select">
  <select class="mdc-select__native-control">
    <option value="" disabled selected></option>
    <option value="grains">
      Bread, Cereal, Rice, and Pasta
    </option>
    <option value="vegetables">
      Vegetables
    </option>
    <option value="fruit">
      Fruit
    </option>
  </select>
  <label class="mdc-floating-label">Pick a Food Group</label>
  <div class="mdc-line-ripple"></div>
</div>

Styles

@import "@material/select/mdc-select";

JavaScript Instantiation

const select = new mdc.select.MDCSelect(document.querySelector('.mdc-select'));
select.listen('change', () => {
  alert(`Selected option at index ${select.selectedIndex} with value "${select.value}"`);
});

See Importing the JS component for more information on how to import JavaScript.

Variants

Select Box

The Select Box variant uses the same markup as the standard variant, with the addition of the mdc-select--box modifier class on the root element.

<div class="mdc-select mdc-select--box">
  <select class="mdc-select__native-control">
    ...
  </select>
  <label class="mdc-floating-label">Pick a Food Group</label>
  <div class="mdc-line-ripple"></div>
</div>

Additional Information

Select with pre-selected option

When dealing with a select component that has a pre-selected value, include the mdc-floating-label--float-above modifier class on the mdc-floating-label element, and add the selected attribute to the selected option. This will ensure that the label moves out of the way of the select's value and prevents a Flash Of Unstyled Content (FOUC).

<div class="mdc-select">
  <select class="mdc-select__native-control">
    <option value="vegetables">
      Vegetables
    </option>
    <option value="fruit">
      Fruit
    </option>
    <option value="dairy" selected>
      Milk, Yogurt, and Cheese
    </option>
  </select>
  <label class="mdc-floating-label mdc-floating-label--float-above">Pick a Food Group</label>
  <div class="mdc-line-ripple"></div>
</div>

Using the floating label as the placeholder

By default, <select> elements will select their first enabled option. In order to initially display a placeholder instead, add an initial <option> element with the disabled and selected attributes set, and with value set to "".

<option value="" disabled selected></option>

Disabled select

Add the mdc-select--disabled class to the mdc-select element, and add the disabled attribute to the <select> element.

<div class="mdc-select mdc-select--disabled">
  <select class="mdc-select__native-control" disabled>
    ...
  </select>
  <label class="mdc-floating-label">Pick a Food Group</label>
  <div class="mdc-line-ripple"></div>
</div>

Disabled options

Since MDC Select uses native <select> and <option> elements, simply add the disabled attribute to individual options to disable them.

<div class="mdc-select">
  <select class="mdc-select__native-control">
    <option value="grains">
      Bread, Cereal, Rice, and Pasta
    </option>
    <option value="vegetables" disabled>
      Vegetables
    </option>
    <option value="fruit">
      Fruit
    </option>
  </select>
  <label class="mdc-floating-label">Pick a Food Group</label>
  <div class="mdc-line-ripple"></div>
</div>

Style Customization

CSS Classes

Class	Description
`mdc-select`	Mandatory.
`mdc-select--box`	Styles the select as a box select.
`mdc-select--disabled`	Styles the select as disabled. This class should be applied to the root element when the `disabled` attribute is applied to the `<select>` element.
`mdc-select__native-control`	Mandatory. The native `<select>` element.

Sass Mixins

Mixins should be included in the context of a custom class applied to the component's root element, e.g. .my-select.

Mixin	Description
`mdc-select-ink-color($color)`	Customizes the color of the selected item displayed in the select.
`mdc-select-container-fill-color($color)`	Customizes the background color of the select.
`mdc-select-label-color($color)`	Customizes the label color of the select in the unfocused state.
`mdc-select-focused-label-color($color)`	Customizes the label color of the select when focused.
`mdc-select-bottom-line-color($color)`	Customizes the color of the default bottom line of the select.
`mdc-select-focused-bottom-line-color($color)`	Customizes the color of the bottom line of the select when focused.
`mdc-select-hover-bottom-line-color($color)`	Customizes the color of the bottom line when select is hovered.

NOTE: To further customize the floating label, please see the floating label documentation.

`MDCSelect` API

The MDCSelect component API is modeled after a subset of the HTMLSelectElement functionality.

Property	Type	Description
`value`	`string`	The `value` of the currently selected option.
`selectedIndex`	`number`	The index of the currently selected option. Set to -1 if no option is currently selected. Changing this property will update the select element.
`disabled`	`boolean`	Whether or not the component is disabled. Settings this sets the disabled state on the component.

Events

The MDC Select JS component emits a change event when the selected option changes as the result of a user action.

Usage within Web Frameworks

If you are using a JavaScript framework, such as React or Angular, you can create a Select for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.

`MDCSelectAdapter`

Method Signature	Description
`addClass(className: string) => void`	Adds a class to the root element.
`removeClass(className: string) => void`	Removes a class from the root element.
`floatLabel(value: boolean) => void`	Floats or defloats label.
`activateBottomLine() => void`	Activates the bottom line component.
`deactivateBottomLine() => void`	Deactivates the bottom line component.
`setDisabled(disabled: boolean) => void`	Sets the `disabled` property of the `<select>` element.
`registerInteractionHandler(type: string, handler: EventListener) => void`	Adds an event listener `handler` for event type `type` on the `<select>` element.
`deregisterInteractionHandler(type: string, handler: EventListener) => void`	Removes an event listener `handler` for event type `type` on the `<select>` element.
`getSelectedIndex() => number`	Returns the selected index of the `<select>` element.
`setSelectedIndex(index: number) => void`	Sets the selected index of the `<select>` element.
`getValue() => string`	Returns the value selected on the `<select>` element.
`setValue(value: string) => void`	Sets the value of the `<select>` element.

`MDCSelectFoundation`

Method Signature	Description
`setValue(value: string) => void`	Sets the value of the component.
`setDisabled(disabled: boolean) => void`	Adds/removes disabled class, and sets disabled attribute on the component.
`setSelectedIndex(selectedIndex: number) => void`	Sets the selected index of the component.

@material/select