Selectmenu Widget

The select menu is based on a native select element, which is hidden from view and replaced with a custom-styled select button that matches the look and feel of the jQuery Mobile framework. The select menu is ARIA-enabled and keyboard accessible on the desktop as well.

By default, the framework leverages the native OS options menu to use with the custom button. When the button is clicked, the native OS menu will open. When a value is selected and the menu closes, the custom button's text is updated to match the selected value. Please note that the framework also offers the possibility of having custom (non-native) select menus.

To add a select menu to your page, start with a standard select element populated with a set of option elements. Set the for attribute of the label to match the id of the select so they are semantically associated. It's possible to accessibly hide the label if it's not desired in the page layout, but we require that it is present in the markup for semantic and accessibility reasons.

The framework will find all select elements and automatically enhance them into select menus, no need to apply a data-role attribute. To prevent the automatic enhancement of a select, add data-role="none" attribute to the select.

• ui-selectmenu: The outermost container for selectmenu.
  • ui-selectmenu-button: Custom styled button for the selectmenu
    • ui-selectmenu-button-icon: Selectmenu button icon
    • ui-selectmenu-button-text: Selectmenu button text
  ui-selectmenu-custom: The outermost container for custom selectmenu.
  • ui-selectmenu-custom-list: List element for custom selectmenu
    • ui-selectmenu-custom-header-close-button: Close button for custom selectmenu
      • ui-selectmenu-custom-header-close-button-icom: Close button icon for custom selectmenu

<label for="select-choice-0" class="select">Shipping method:</label>
<select name="select-choice-0" id="select-choice-0">
  <option value="standard">Standard: 7 day</option>
  <option value="rush">Rush: 3 days</option>
  <option value="express">Express: next day</option>
  <option value="overnight">Overnight</option>
</select>

This will produce a basic select menu. The default styles set the width of the input to 100% of the parent container and stacks the label on a separate line.

Mini version

For a more compact version that is useful in toolbars and tight spaces, add the data-mini="true" attribute to the element to create a mini version.

<label for="select-choice-min" class="select">Shipping method:</label>
<select name="select-choice-min" id="select-choice-min" data-mini="true">
  <option value="standard">Standard: 7 day</option>
  <option value="rush">Rush: 3 days</option>
  <option value="express">Express: next day</option>
  <option value="overnight">Overnight</option>
</select>

This will produce a select that a not as tall as the standard version and has a smaller text size.

Field containers

Optionally wrap the selects in a container with class ui-field-contain to help visually group it in a longer form.

<div class="ui-field-contain">
  <label for="select-choice-1" class="select">Shipping method:</label>
  <select name="select-choice-1" id="select-choice-1">
    <option value="standard">Standard: 7 day</option>
    <option value="rush">Rush: 3 days</option>
    <option value="express">Express: next day</option>
    <option value="overnight">Overnight</option>
  </select>
</div>

The select input is now displayed like this:

An example of a select with a long list of options:

Optgroups

The following example organizes the options into optgroup elements. Support for this feature in mobile selects is a bit spotty, but is improving.

<div class="ui-field-contain">
  <label for="select-choice-nc" class="select">Preferred delivery:</label>
  <select name="select-choice-8" id="select-choice-nc">
      <optgroup label="FedEx">
      <option value="firstOvernight">First Overnight</option>
      <option value="expressSaver">Express Saver</option>
      <option value="ground">Ground</option>
    </optgroup>
    <optgroup label="UPS">
      <option value="firstOvernight">First Overnight</option>
      <option value="expressSaver">Express Saver</option>
      <option value="ground">Ground</option>
    </optgroup>
    <optgroup label="US Mail">
      <option value="standard">Standard: 7 day</option>
      <option value="rush">Rush: 3 days</option>
      <option value="express">Express: next day (disabled)</option>
      <option value="overnight">Overnight</option>
    </optgroup>
  </select>
</div>

Vertically grouped select inputs

To create a grouped set of select inputs, first add select and a corresponding label. Set the for attribute of the label to match the id of the select so they are semantically associated.

Because the label element will be associated with each individual select input and will be hidden for styling purposes, we recommend wrapping the selects in a fieldset element that has a legend which acts as the combined label for the grouped inputs.

Lastly, one needs to wrap the fieldset in a div with data-role="controlgroup" attribute, so it can be styled as a group.

<div class="ui-field-contain">
  <fieldset data-role="controlgroup">
    <legend>Date of Birth:</legend>
 
    <label for="select-choice-month">Month</label>
    <select name="select-choice-month" id="select-choice-month">
      <option>Month</option>
      <option value="jan">January</option>
      <!-- etc. -->
    </select>
 
    <label for="select-choice-day">Day</label>
    <select name="select-choice-day" id="select-choice-day">
      <option>Day</option>
      <option value="1">1</option>
      <!-- etc. -->
    </select>
 
    <label for="select-choice-year">Year</label>
    <select name="select-choice-year" id="select-choice-year">
      <option>Year</option>
      <option value="2011">2011</option>
      <!-- etc. -->
    </select>
  </fieldset>
</div>

Horizontally grouped select inputs

Select inputs can also be used for grouped sets with more than one related selections. To make a horizontal button set, add the data-type="horizontal" to the fieldset. Note that the buttons which trigger the select will resize depending on the currently selected option’s value.

<fieldset data-role="controlgroup" data-type="horizontal">

Theming selects

You can specify any jQuery Mobile button data- attribute on a select element, too. In this example, we're setting the theme, icon and inline properties:

Custom select menus

The framework is capable of building a custom menu based on the select element's list of options. We recommend using a custom menu when multiple selections are required, or when the menu itself must be styled with CSS.

You can optionally use custom-styled select menus instead of the native OS menu. The custom menu supports disabled options and multiple selection (whereas native mobile OS support for both is inconsistent), adds an elegant way to handle placeholder values, and restores missing functionality on certain platforms such as optgroup support on Android (all explained below). In addition, the framework applies the custom button's theme to the menu to better match the look and feel and provide visual consistency across platforms. Lastly, custom menus often look better on desktop browsers because native desktop menus are smaller than their mobile counterparts and tend to look disproportionate.

Keep in mind that there is overhead involved in parsing the native select to build a custom menu. If there are a lot of selects on a page, or a select has a long list of options, this can impact the performance of the page, so we recommend using custom menus sparingly.

To use custom menus on a specific select, just add the data-native-menu="false" attribute. Alternately, this can also programmatically set the select menu's nativeMenu configuration option to false in a callback bound to the mobileinit event to achieve the same effect. This will globally make all selects use the custom menu by default. The following must be included in the page after jQuery is loaded but before jQuery Mobile is loaded.

$(document).on( "mobileinit", function() {
  $.mobile.selectmenu.prototype.options.nativeMenu = false;
});

When the select has a small number of options that will fit on the device's screen, the menu will appear as a small overlay with a pop transition:

When it has too many options to show on the device's screen, the framework will automatically create a new dialog-style "page" populated with a standard listview for the options. This allows us to use the native scrolling included on the device for moving through a long list. The text inside the label is used as the title for this page. Be aware of the page and pagecontainer events that will be fired for this generated page.

Note: The behavior whereby the custom select menu creates a new page when the list of options is long is deprecated as of jQuery Mobile 1.4.0. Starting with 1.5.0, the custom select menu will fall back to utilizing the select menu's native behavior when the list of options is too long.

Disabled options

jQuery Mobile will automatically disable and style option tags with the disabled attribute. In the demo below, the second option "Rush: 3 days" has been set to disabled.

Placeholder options

It's common for developers to include a "null" option in their select element to force a user to choose an option. If a placeholder option is present in your markup, jQuery Mobile will hide them in the overlay menu, showing only valid choices to the user, and display the placeholder text inside the menu as a header. A placeholder option is added when the framework finds:

• An option with no value attribute
• An option with an empty value attribute (value="").

  Note: Indicating that an option should be used as a placeholder by providing the value attribute and setting it to "" is deprecated as of jQuery Mobile 1.4.0 and will be removed in 1.5.0.

• An option with no text node
• An option with a data-placeholder="true" attribute. (This allows you to use an option that has a value and a textnode as a placeholder option).

You can disable this feature through the selectmenu plugin's hidePlaceholderMenuItems option, like this:

$.mobile.selectmenu.prototype.options.hidePlaceholderMenuItems = false;

Examples of various placeholder options:

Multiple selects

If the multiple attribute is present in your markup, jQuery Mobile will enhance the element with a few extra considerations:

• A header element will be created inside the menu and display the placeholder text and a close button.
• Clicking on an item inside the overlay menu will not close the widget.
• A ghosted, unchecked icon will appear adjacent to each unselected item. When the item is selected the icon will change to a checkbox. Neither icon will appear inside a single select box.
• Once 2+ items are selected, a counter element with the total number of selected items will appear inside the button.
• The text of each selected item will appear inside the button as a list. If the button is not wide enough to display the entire list, it is truncated with an ellipses.
• If no items are selected, the button's text will default to the placeholder text.
• If no placeholder element exists, the default button text will be blank and the header will appear with just a close button. Because this isn't a friendly user experience, we recommended that you always specify a placeholder element when using multiple select boxes.
• Currently jQuery Mobile only supports the multiple attribute on a select with nativeMenu set to false.

When a select is large enough to where the menu will open in a new page, the placeholder text is displayed in the button when no items are selected, and the label text is displayed in the menu's header. This differs from smaller overlay menus where the placeholder text is displayed in both the button and the header, and from full-page single selects where the placeholder text is not used at all.

Optgroup support

If a select menu contains optgroup elements, jQuery Mobile will create a divider & group items based on the label attribute's text:

Theming selects

You can specify any jQuery Mobile button data- attribute on a select element, too. In this example, we're setting the theme, icon and inline properties:

The data-overlay-theme attribute can be added to a select element to set the color of the overlay layer for the dialog-based custom select menus and the outer border of the smaller custom menus. By default, the content block colors for swatch "a" will be used for the overlays.

Note: Custom selects use the popup widget for the menu. Because the popup container is elsewhere on the page it can't inherit the theme swatch from the parent of the select, and inherits from the page instead.

Calling the select menu plugin

The select menu plugin will auto initialize on any page that contains a select menu, without any need for a data-role attribute in the markup. However, you can directly call the select menu plugin on any selector, just like any normal jQuery plugin:

$( "select" ).selectmenu();

ID generation

The selectmenu widget adds an ID to the elements it generates. If it doesn't itself have an ID, it will use a prefix consisting of select- and a unique number for the elements. If it does have an ID, it will use its ID as the prefix. The ID for the various elements generated by the selectmenu widget is then constructed as follows:

button

<prefix>-button

popup

<prefix>-listbox

This id is only assigned to an element when the selectmenu widget is constructed with the option nativeMenu set to false.

Since the menu is implemented as a popup it will assign IDs to its generated elements. See the popup widget's id generation for details.

listview

<prefix>-menu

This id is only assigned to an element when the selectmenu widget is constructed with the option nativeMenu set to false.

For example, creating a non-native selectmenu with

<select id="choose-city" data-native-menu="false">
  <option>Caracas</option>
  <option>Warszawa</option>
  <option>Yekaterinburg</option>
  <option>Pretoria</option>
</select>

will result in the following markup:

<div class="ui-select">
  <a id="choose-city-button" href="#" role="button" aria-haspopup="true" class="ui-btn ui-icon-carat-d ui-btn-icon-right ui-corner-all ui-shadow" data-rel="popup">
    <span>Caracas</span>
  </a>
  <select id="choose-city" data-native-menu="false" tabindex="-1">
    <option>Caracas</option>
    <option>Warszawa</option>
    <option>Yekaterinburg</option>
    <option>Pretoria</option>
  </select>
  <div id="choose-city-listbox-placeholder" style="display: hidden;"></div>
</div>
<div id="choose-city-listbox-screen" class="ui-popup-screen ui-screen-hidden ui-overlay-inherit"></div>
<div id="choose-city-listbox-popup" class="ui-popup-container ui-popup-hidden ui-popup-truncate">
  <div id="choose-city-listbox" class="ui-selectmenu ui-popup ui-body-inherit ui-overlay-shadow ui-corner-all">
    <div class="ui-header" ui-bar-inherit ui-screen-hidden">
      <h1 class="ui-title"></h1>
    </div>
    <ul id="choose-city-menu" class="ui-selectmenu-list ui-listview" role="listbox" aria-labelledby="choose-city-button">
      <li data-option-index="0" data-icon="false" class="ui-first-child" role="option" aria-selected="true">
        <a href="#" tabindex="-1" class="ui-btn ui-btn-active">Caracas</a>
      </li>
      <li data-option-index="0" data-icon="false" role="option" aria-selected="false">
        <a href="#" tabindex="-1" class="ui-btn ui-btn-active">Warszawa</a>
      </li>
      <li data-option-index="0" data-icon="false" role="option" aria-selected="false">
        <a href="#" tabindex="-1" class="ui-btn ui-btn-active">Yekaterinburg</a>
      </li>
      <li data-option-index="0" data-icon="false" class="ui-last-child" role="option" aria-selected="false">
        <a href="#" tabindex="-1" class="ui-btn ui-btn-active">Pretoria</a>
      </li>
    </ul>
  </div>
</div>