Rangeslider Widget

Range Slider

The rangeslider widget can be considered as a double handle slider. To add a rangeslider widget to your page, use two standard inputs with the type="range" attribute, and put them inside a <div> container. The input values are used to configure the starting position of the handles and the values are populated in the corresponding text inputs (the first one at the beginning of the rangeslider, and the second one at the end). Specify min and max attribute values to set the rangeslider's range. If you want to constrain inputs to specific increments, add the step attribute. Set the value attribute on each input to define their initial value. The framework will parse these attributes to configure the rangeslider widget.

As you drag the rangeslider's handles, the framework will update the native input values (and vice-versa) so they are always in sync; this ensures that the values are submitted with the form.

Set the for attribute of the labels to match the ids of the inputs so they are semantically associated. It's possible to accessibly hide the labels if they're not desired in the page layout, but we require that they are present in the markup for semantic and accessibility reasons.

The framework will find all input elements with a type="range" and automatically enhance them into a slider with an accompanying input without any need to apply a data-role attribute. To prevent the automatic enhancement of this input into a slider, add the data-role="none" attribute to the inputs.

• ui-rangeslider: The outermost container for rangeslider.
  • ui-slider-popup: Tooltip popup element in case data-popup-enabled is true
  • ui-slider-first: Opening range input element of rangeslider
  • ui-slider-last: Closing range input element of rangeslider
  • ui-rangeslider-sliders: Sliders for rangeslider

In this example, the acceptable range is 0-100.

<div data-role="rangeslider">
  <label for="range-1a">Rangeslider:</label>
  <input name="range-1a" id="range-1a" min="0" max="100" value="0" type="range" />
  <label for="range-1b">Rangeslider:</label>
  <input name="range-1b" id="range-1b" min="0" max="100" value="100" type="range" />
</div>

The default rangeslider with these settings is displayed like this:

Step increment

To force the range to snap to a specific increment, add the step attribute to the input. By default, the step is 1, but in this example, the step is 0.1 and the maximum value is 10.

In this example, the acceptable range is 0-100.

<div data-role="rangeslider">
  <label for="range-10a">Rangeslider:</label>
  <input name="range-10a" id="range-10a" min="0" max="10" step=".1" value="0" type="range" />
  <label for="range-10b">Rangeslider:</label>
  <input name="range-10b" id="range-10b" min="0" max="10" step=".1" value="10" type="range" />
</div>

This will produce an input that snaps to increments of 0.1. If a value is added to the input that isn't valid with the step increment, the value will be reset on blur to the closest step.

Fill highlight

By default, there is a highlight fill on the track between the two slider handles. To remove it, add the data-highlight="false" attribute to the input. The fill uses the active state swatch.

<div data-role="rangeslider" data-highlight="false">
  <label for="range-2a">Rangeslider (default is "true"):</label>
  <input name="range-2a" id="range-2a" min="0" max="100" value="0" type="range" />
  <label for="range-2b">Rangeslider:</label>
  <input name="range-2b" id="range-2b" min="0" max="100" value="100" type="range" />
</div>

Theming the slider

To set the theme swatch for the rangeslider, add a data-theme attribute to the inputs which will apply the theme to the inputs, handles and track. The track swatch can be set separately by adding the data-track-theme attribute to apply the down state version of the selected button swatch.

<div data-role="rangeslider" data-track-theme="a" data-theme="b">
  <label for="range-3a">Rangeslider:</label>
  <input name="range-3a" id="range-3a" min="0" max="100" value="0" type="range" />
  <label for="range-3b">Rangeslider:</label>
  <input name="range-3b" id="range-3b" min="0" max="100" value="100" type="range" />
</div>

This will produce a themed rangeslider:

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.

<div data-role="rangeslider" data-mini="true">
  <label for="range-4a">Rangeslider:</label>
  <input name="range-4a" id="range-4a" min="0" max="100" value="0" type="range" />
  <label for="range-4b">Rangeslider:</label>
  <input name="range-4b" id="range-4b" min="0" max="100" value="100" type="range" />
</div>

This will produce a rangeslider and its corresponding inputs that are not as tall as the standard version. The inputs also have a smaller text size.

Field containers

Optionally wrap the rangeslider markup in a container with class ui-field-contain to help visually group it in a longer form. In this example, the step attribute is omitted to allow any whole number value to be selected.

<div class="ui-field-contain">
  <div data-role="rangeslider">
    <label for="range-7a">Rangeslider:</label>
    <input name="range-7a" id="range-7a" min="0" max="100" value="0" type="range" />
    <label for="range-7b">Rangeslider:</label>
    <input name="range-7b" id="range-7b" min="0" max="100" value="100" type="range" />
  </div>
</div>

The rangeslider is now displayed like this:

Sliders also respond to key commands. Right Arrow, Up Arrow and Page Up keys increase the value; Left Arrow, Down Arrow and Page Down keys decrease it. To move the slider to its minimum or maximum value, use the Home or End key, respectively.

Calling the rangeslider plugin

This plugin will auto initialize on any page that contains a div with the data-role="rangeslider" attribute. However, if needed you can directly call the rangeslider plugin on any selector, just like any jQuery plugin:

$( "div#range-slider" ).rangeslider();