@rmwc/select

Select Menus

Menus display a list of choices on a transient sheet of material.

• Module @rmwc/select
• Import styles:
  • import '@material/select/dist/mdc.select.css';
  • import '@material/floating-label/dist/mdc.floating-label.css';
  • import '@material/notched-outline/dist/mdc.notched-outline.css';
  • import '@material/line-ripple/dist/mdc.line-ripple.css';
• MDC Docs: https://material.io/develop/web/components/input-controls/select-menus/

Select Styles

Selects come in three different styles: standard, box, and outlined.

import { Select, SelectHelperText } from '@rmwc/select';

<Select
  label="Standard"  
  options={['Cookies', 'Pizza', 'Icecream']}
/>

<Select
  label="Outlined"
  outlined
  options={['Cookies', 'Pizza', 'Icecream']}
/>

<Select
  label="Enhanced"
  enhanced
  options={['Cookies', 'Pizza', 'Icecream']}
/>

<div>
  <Select
    label="With Icon"
    defaultChecked="Pizza"
    withLeadingIcon="favorite"
    options={['Cookies', 'Pizza', 'Icecream']}
  />
  <SelectHelperText>Choose your favorite snack...</SelectHelperText>
</div>

Data Driven Selects

To fit common use cases, RMWC Select provides a data driven method for rendering select menus. There are multiple formats you can pass data in, use the one that best fits your requirements. To make your label not float by default and to have an unselected blank value, set the placeholder prop to a blank string.

import { Select } from '@rmwc/select';

{/*
  A controlled select
  Using a formatted array of options
  [
    {label: string, value: string, ...props},
    {label: string, value: string, ...props}
  ]
*/}

<Select
  value={this.state.value}
  onChange={evt => this.setState({value: evt.target.value})}
  label="Array"
  options={[
    {
      label: 'Cookies',
      value: '1'
    },
    {
      label: 'Pizza',
      value: '2',

      /** Any additional items will be passed to the
       child ListItem as props */

      'aria-disabled': true,
      'tabIndex': -1
    },
    {
      label: 'Icecream',
      value: '3'
    }
  ]}
/>

{/*  
  An uncontrolled select
  A simple value => label map */
}
<Select
  label="Object map"
  options={{'1': 'Cookies', '2': 'Pizza', '3': 'Icecream'}}
/>

{/* a simple array of options with box styling, value will be the same as label */}
<Select
  label="Simple Array"
  placeholder="-- Select One --"
  options={['Cookies', 'Pizza', 'Icecream']}
/>

Manually building the list

If you want full control over the child ListItems, you can manually build the list yourself.

import { Select } from '@rmwc/select';

<Select
  label="Manual"
  defaultValue="Cookies"
>
  <option value="Cookies">
    Cookies
  </option>
  <option value="Pizza">
    Pizza
  </option>
  <option value="Icecream">
    Icecream
  </option>
</Select>

Option Groups

Both native and enhanced Selects can contain option groups. Just nest additional options arrays in your data.

import { Select } from '@rmwc/select';

<Select
  label="Formatted"
  enhanced
  options={[
    {
      label: 'Dinner',
      options: [
        {
          label: 'Pizza',
          value: '2',
        }
      ]
    },
    {
      label: 'Dessert',
      options: [
        {
          label: 'Cookies',
          value: '1'
        },

        {
          label: 'Icecream',
          value: '3'
        }
      ]
    }
  ]}
/>

<Select
  label="Manually Built"
>
  <optgroup label="Dinner">
    <option value="Pizza">
      Pizza
    </option>
  </optgroup>
  <optgroup label="Dessert">
    <option value="Cookies">
      Cookies
    </option>
    <option value="Icecream">
      Icecream
    </option>
  </optgroup>
</Select>

import { DocumentComponent } from '@rmwc/base/utils/document-component';
import * as docs from './docgen.json';

<DocumentComponent docs={docs} displayName="Select" />

Changelog

4.0.1 (2018-11-28)

Bug Fixes

• Typescript: Corrects issue with proptypes import (6f8041bb)