tree: 868fe4e2dd6b26a6c46a0418d57ad93f0014c85d [path history] [tgz]
  1. snippets/
  2. _selectfield.scss
  3. readme.md
  4. selectfield.js
node_modules/mdl-ext/src/selectfield/readme.md

Selectfield

Selectfield

Introduction

The HTML select (<select>) element represents a control that presents a menu of options. The options within the menu are represented by <option> elements, which can be grouped by <optgroup> elements. Options can be pre-selected for the user.

The Material Design Lite Ext (MDLEXT) select field component is an enhanced version of the standard [HTML <select>] (https://developer.mozilla.org/en/docs/Web/HTML/Element/select) element. A select field consists of a horizontal line indicating where keyboard input can occur and, typically, text that clearly communicates the intended contents of the select field. An icon (at the right hand side) indicates that the select field has user selectable options.

This component relates to the guidelines given in Materials Design spesifications page, Text Fields.

To include a MDLEXT select field component:

 1. Code a <div> element to hold the select field.

<div>
...
</div>

 2. Inside the div, code an <select> element with an id attribute of your choice.

<div>
  <select id="some-id">
  </select>
</div>

 3. Inside the <select> element code a list of user selectable options.

<div>
  <select id="some-id">
    <option value=""></option>
    <option value="option1">option 1</option>
    <option value="option2">option 2</option>
    <option value="option3">option 3</option>
  </select>
</div>

 4. Also inside the div, after the <select> element, code a <label> element with a for attribute whose value matches the select element's id value, and a short string to be used as the field's placeholder text.

<div>
  <select id="some-id">
  ...
  </select>
  <label for="some-id">Options</label>
</div>

 5. Add one or more MDLEXT classes, separated by spaces, to the select field container, select element, label element, and error message using the class attribute.

<div class="mdlext-selectfield mdlext-js-selectfield">
  <select id="some-id" class="mdlext-selectfield__select">
  ...
  </select>
  <label for="some-id" class="mdlext-selectfield__label">Options</label>
  <span class="mdlext-selectfield__error">Someting is wrong</span>
</div>

The select field component is ready for use.

Examples

Select field with a standard label.

<div class="mdlext-selectfield mdlext-js-selectfield">
  <select id="some-id" class="mdlext-selectfield__select">
    <option value=""></option>
    <option value="option1">option 1</option>
    <option value="option2">option 2</option>
    <option value="option3">option 3</option>
  </select>
  <label for="some-id" class="mdlext-selectfield__label">Options</label>
</div>

Select field with a floating label.

<div class="mdlext-selectfield mdlext-js-selectfield mdlext-selectfield--floating-label">
  <select id="some-id" class="mdlext-selectfield__select">
    <option value=""></option>
    <option value="option1">option 1</option>
    <option value="option2">option 2</option>
    <option value="option3">option 3</option>
  </select>
  <label for="some-id" class="mdlext-selectfield__label">Options</label>
</div>

Select field with a standard label and error message.

<div class="mdlext-selectfield mdlext-js-selectfield">
  <select id="some-id" class="mdlext-selectfield__select">
    <option value=""></option>
    <option value="option1">option 1</option>
    <option value="option2">option 2</option>
    <option value="option3">option 3</option>
  </select>
  <label for="some-id" class="mdlext-selectfield__label">Options</label>
  <span class="mdlext-selectfield__error">Something is wrong</span>
</div>

Configuration options

The MDLEXT CSS classes apply various predefined visual and behavioral enhancements to the select field. The table below lists the available classes and their effects.

MDLEXT classEffectRemarks
mdlext-selectfieldDefines container as an MDL componentRequired on "outer" div element
mdlext-js-selectfieldAssigns basic MDL behavior to inputRequired on "outer" div element
mdlext-selectfield__selectDefines element as selectfield selectRequired on select element
mdlext-selectfield__labelDefines element as selectfield labelRequired on label element for select elements
mdlext-selectfield--floating-labelApplies floating label effectOptional; goes on "outer" div element
mdlext-selectfield__errorDefines span as an MDL error messageOptional; goes on span element for MDL select element with pattern
is-invalidDefines the selectfield as invalid on initial load.Optional on mdlext-selectfield element

Note I: Disabled versions of each select field type are provided, and are invoked with the standard HTML boolean attribute disabled. <select class="mdlext-selectfield__select" id="select-id" name="select-id" disabled> This attribute may be added or removed programmatically via scripting.

Note II: The select field can for some browser and OS combinations, e.g. FireFox and OSX, be off by 2 pixels compared to the input field. There is no way to fix this, as far as I know, without setting an explicit height on both field types. Since MDL does not set a specific height of the text field, it can not be done for the select field either. If alignment is required, the user must in his/hers design set a specific height both for textfields and selectfields.

How to use the component programmatically

The tests provides examples on how to use the component programmatically

Credits

The Select component is based on the following sources: