5 <meta name="viewport" content="width=device-width, initial-scale=1">
6 <title>jQuery Mobile Docs - Slider</title>
7 <link rel="stylesheet" href="../../../css/themes/default/jquery.mobile.css" />
8 <link rel="stylesheet" href="../../_assets/css/jqm-docs.css"/>
9 <script src="../../../experiments/themeswitcher/jquery.mobile.themeswitcher.js"></script>
10 <script src="../../../js/jquery.js"></script>
11 <script src="../../../docs/_assets/js/jqm-docs.js"></script>
12 <script src="../../../js/"></script>
17 <div data-role="page" class="type-interior">
19 <div data-role="header" data-theme="f">
21 <a href="../../../" data-icon="home" data-iconpos="notext" data-direction="reverse">Home</a>
22 <a href="../../nav.html" data-icon="search" data-iconpos="notext" data-rel="dialog" data-transition="fade">Search</a>
23 </div><!-- /header -->
25 <div data-role="content">
26 <div class="content-primary">
28 <form action="#" method="get">
31 <ul data-role="controlgroup" data-type="horizontal" class="localnav">
32 <li><a href="index.html" data-role="button" data-transition="fade" class="ui-btn-active">Basics</a></li>
33 <li><a href="options.html" data-role="button" data-transition="fade">Options</a></li>
34 <li><a href="methods.html" data-role="button" data-transition="fade">Methods</a></li>
35 <li><a href="events.html" data-role="button" data-transition="fade">Events</a></li>
38 <p>To add a slider widget to your page, use a standard <code>input</code> with the <code>type="range"</code> attribute. The input's <code>value</code> is used to configure the starting position of the handle and the value is populated in the text input. Specify <code>min</code> and <code>max</code> attribute values to set the slider's range. If you want to constrain input to specific increments, add the <code>step</code> attribute. Set the <code>value</code> attribute to define the initial value. The framework will parse these attributes to configure the slider widget. View the <a href="../../api/data-attributes.html">data- attribute reference</a> to see all the possible attributes you can add to sliders.</p>
40 <p>As you drag the slider's handle, the framework will update the native input's value (and vice-versa) so they are always in sync; this ensures that the value is submitted with the form.</p>
41 <p>Set the <code>for</code> attribute of the <code>label</code> to match the ID of the <code>input</code> so they are semantically associated. It's possible to <a href="../docs-forms.html">accessibly hide the label</a> if it's not desired in the page layout, but we require that it is present in the markup for semantic and accessibility reasons.</p>
43 <p>The framework will find all <code>input</code> elements with a <code>type="range"</code> and automatically enhance them into a slider with an accompanying input without any need to apply a <code>data-role</code> attribute. To prevent the automatic enhancement of this input into a slider, add <code>data-role="none"</code> attribute to the <code>input</code> and wrap them in a <code>div</code> with the <code> data-role="fieldcontain"</code> attribute to group them. In this example, the acceptable range is 0-100. </p>
46 <label for="slider-0">Input slider:</label>
47 <input type="range" name="slider" id="slider-0" value="60" min="0" max="100" />
50 <p>The default slider with these settings is displayed like this:</p>
51 <label for="slider-0">Input slider:</label>
52 <input type="range" name="slider-1" id="slider-0" value="60" min="0" max="100" />
54 <h2>Step increment</h2>
56 <p>To force the slider to snap to a specific increment, add the <code>step</code> attribute to the input. By default, the step is 1, but in this example, the step is 50 and the maximum value is 500.</p>
59 <label for="slider-step">Input slider:</label>
60 <input type="range" name="slider" id="slider-step" value="150" min="0" max="500" <strong>step="50"</strong> />
63 <p>This will produce an input that snaps to increments of 50. 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.</p>
64 <label for="slider-step">Input slider:</label>
65 <input type="range" name="slider-1" id="slider-step" value="150" min="0" max="500" step="50" />
68 <h2>Fill highlight</h2>
70 <p>To have a highlight fill on the track up to the slider handle position, add the <code>data-highlight="true"</code> attribute to the input. The fill uses active state swatch. </p>
73 <label for="slider-fill">Input slider:</label>
74 <input type="range" name="slider" id="slider-fill" value="60" min="0" max="100" <strong>data-highlight="true"</strong> />
77 <label for="slider-min">Input slider:</label>
78 <input type="range" name="slider-1" id="slider-min" value="60" min="0" max="100" data-highlight="true" />
83 <p>For a more compact version that is useful in toolbars and tight spaces, add the <code>data-mini="true"</code> attribute to the element to create a <a href="../forms-all-mini.html">mini version</a>. </p>
86 <label for="slider-0">Input slider:</label>
87 <input type="range" name="slider" id="slider-0" value="25" min="0" max="100" data-highlight="true" <strong>data-mini="true"</strong> />
90 <p>This will produce an input that is not as tall as the standard version and has a smaller text size.</p>
91 <label for="slider-min">Input slider:</label>
92 <input type="range" name="slider-1" id="slider-min" value="25" min="0" max="100" data-highlight="true" data-mini="true" />
94 <h2>Field containers</h2>
96 <p>Optionally wrap the slider markup in a container with the <code>data-role="fieldcontain"</code> attribute to help visually group it in a longer form. In this example, the <code>step</code> attribute is omitted to allow any whole number value to be selected.</p>
100 <strong><div data-role="fieldcontain">
101 </strong> <label for="slider">Input slider:</label>
102 <input type="range" name="slider" id="slider" value="25" min="0" max="100" />
104 </strong></code></pre>
106 <p>The slider is now displayed like this:</p>
107 <div data-role="fieldcontain">
108 <label for="slider-1">Input slider:</label>
109 <input type="range" name="slider-1" id="slider-1" value="25" min="0" max="100" />
112 <p>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.</p>
115 <h2>Calling the slider plugin</h2>
117 <p>This plugin will auto initialize on any page that contains a text <code>input</code> with the <code>type="range"</code> attribute. However, if needed you can directly call the <code>slider</code> plugin on any selector, just like any jQuery plugin:</p>
123 <h2>Theming the slider</h2>
124 <p>To set the theme swatch for the slider, add a <code>data-theme</code> attribute to the <code>input</code> which will apply the theme to both the input, handle and track. The track swatch can be set separately by adding the <code>data-track-theme</code> attribute to apply the down state version of the selected button swatch.</p>
127 <div data-role="fieldcontain">
128 <label for="slider-2">Input slider:</label>
129 <input type="range" name="slider-2" id="slider-2" value="25" min="0" max="100" <strong>data-theme="a" data-track-theme="b"</strong> />
133 <p>This will produce a themed slider:</p>
134 <div data-role="fieldcontain">
135 <label for="slider-2">Input slider:</label>
136 <input type="range" name="slider-2" id="slider-2" value="25" min="0" max="100" data-theme="a" data-track-theme="b" />
139 </div><!--/content-primary -->
141 <div class="content-secondary">
143 <div data-role="collapsible" data-collapsed="true" data-theme="b" data-content-theme="d">
145 <h3>More in this section</h3>
147 <ul data-role="listview" data-theme="c" data-dividertheme="d">
149 <li data-role="list-divider">Form elements</li>
150 <li><a href="../docs-forms.html">Form basics</a></li>
151 <li><a href="../forms-all.html">Form element gallery</a></li>
152 <li><a href="../forms-all-mini.html">Mini form element gallery</a></li>
153 <li><a href="../textinputs/index.html">Text inputs</a></li>
154 <li><a href="../search/">Search input</a></li>
155 <li data-theme="a"><a href="index.html">Slider</a></li>
156 <li><a href="../switch/">Flip toggle switch</a></li>
157 <li><a href="../radiobuttons/">Radio buttons</a></li>
158 <li><a href="../checkboxes/">Checkboxes</a></li>
159 <li><a href="../selects/">Select menus</a></li>
160 <li><a href="../forms-themes.html">Theming forms</a></li>
161 <li><a href="../forms-all-native.html">Native form elements</a></li>
162 <li><a href="../forms-sample.html">Submitting forms</a></li>
169 </div><!-- /content -->
171 <div data-role="footer" class="footer-docs" data-theme="c">
172 <p>© 2011-12 The jQuery Foundation</p>