jquery-mobile/docs/forms/slider/index.html

<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>jQuery Mobile Docs - Slider</title>
	<link rel="stylesheet"  href="../../../themes/default/" />
	<link rel="stylesheet" href="../../_assets/css/jqm-docs.css"/>
	<script src="../../../js/jquery.js"></script>
	<script src="../../../experiments/themeswitcher/jquery.mobile.themeswitcher.js"></script>
	<script src="../../_assets/js/jqm-docs.js"></script>
	<script src="../../../js/"></script>
</head>
<body>

	<div data-role="page" class="type-interior">

		<div data-role="header" data-theme="f">
		<h1>Slider</h1>
		<a href="../../../" data-icon="home" data-iconpos="notext" data-direction="reverse" class="ui-btn-right jqm-home">Home</a>
	</div><!-- /header -->

	<div data-role="content">
		<div class="content-primary">

		<form action="#" method="get">
			<h2>Slider</h2>
			
			<ul data-role="controlgroup" data-type="horizontal" class="localnav">
				<li><a href="index.html" data-role="button" data-transition="fade" class="ui-btn-active">Basics</a></li>
				<li><a href="options.html" data-role="button" data-transition="fade">Options</a></li>
				<li><a href="methods.html" data-role="button" data-transition="fade">Methods</a></li>
				<li><a href="events.html" data-role="button" data-transition="fade">Events</a></li>
			</ul>
    
			<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 populated in the text input. Specify <code>min</code> and <code>max</code> attribute values to set the slider's range. The framework will parse these attributes to configure the slider widget. </p>
			
			<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>
			<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>
			
			<p>The framework will find all <code>inputs</code> elements with a <code>type="range"</code> and automatically enhance them into a slider with an accompanying input, no 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>.</p> and wrap them in a <code>div</code> with the <code> data-role="fieldcontain"</code> attribute to group them.</p>
			
<pre><code>
   &lt;label for=&quot;slider-0&quot;&gt;Input slider:&lt;/label&gt;
   &lt;input type=&quot;range&quot; name=&quot;slider&quot; id=&quot;slider-0&quot; value=&quot;25&quot; min=&quot;0&quot; max=&quot;100&quot;  /&gt;
</code></pre>

				<p>The default slider is displayed like this:</p>
					<label for="slider-0">Input slider:</label>
					<input type="range" name="slider-1" id="slider-0" value="25" min="0" max="100"  />
			
				<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.</p>
			

<pre><code>
<strong>&lt;div data-role=&quot;fieldcontain&quot;&gt;
</strong>   &lt;label for=&quot;slider&quot;&gt;Input slider:&lt;/label&gt;
   &lt;input type=&quot;range&quot; name=&quot;slider&quot; id=&quot;slider&quot; value=&quot;25&quot; min=&quot;0&quot; max=&quot;100&quot;  /&gt;
<strong>&lt;/div&gt;
</strong></code></pre>

						<p>The slider is now be is displayed like this:</p>
						<div data-role="fieldcontain">
							<label for="slider-1">Input slider:</label>
							<input type="range" name="slider-1" id="slider-1" value="25" min="0" max="100" />
						</div>

						<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>
						
						
		<h2>Calling the slider plugin</h2>

<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>
<pre><code>
$('input').slider();			
</code></pre>
    

		<h2>Theming the slider</h2>
		<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>
		
		<pre><code>
&lt;div data-role=&quot;fieldcontain&quot;&gt;
	&lt;label for=&quot;slider-2&quot;&gt;Input slider:&lt;/label&gt;
	&lt;input type=&quot;range&quot; name=&quot;slider-2&quot; id=&quot;slider-1&quot; value=&quot;25&quot; min=&quot;0&quot; max=&quot;100&quot; <strong>data-theme=&quot;a&quot; data-track-theme=&quot;b&quot;</strong> /&gt;
&lt;/div&gt;
		</code></pre>
		
		<p>This will produce a themed slider:</p>
		<div data-role="fieldcontain">
			<label for="slider-2">Input slider:</label>
			<input type="range" name="slider-2" id="slider-1" value="25" min="0" max="100" data-theme="a" data-track-theme="b" />
		</div>
		</form>
	</div><!--/content-primary -->		
	
	<div class="content-secondary">
		
		<div data-role="collapsible" data-collapsed="true" data-theme="b" data-content-theme="d">
			
				<h3>More in this section</h3>
				
				<ul data-role="listview" data-theme="c" data-dividertheme="d">
				
					<li data-role="list-divider">Form elements</li>
					<li><a href="../docs-forms.html">Form basics</a></li>
					<li><a href="../forms-all.html">Form element gallery</a></li>
					<li><a href="../textinputs/index.html">Text inputs</a></li>
					<li><a href="../search/">Search input</a></li>
					<li data-theme="a"><a href="index.html">Slider</a></li>
					<li><a href="../switch/">Flip toggle switch</a></li>
					<li><a href="../radiobuttons/">Radio buttons</a></li>
					<li><a href="../checkboxes/">Checkboxes</a></li>
					<li><a href="../selects/">Select menus</a></li>
					<li><a href="../forms-themes.html">Theming forms</a></li>
					<li><a href="../forms-all-native.html">Native form elements</a></li>
					<li><a href="../forms-sample.html">Submitting forms</a></li>
					
	
				</ul>
		</div>
	</div>		

</div><!-- /content -->

<div data-role="footer" class="footer-docs" data-theme="c">
		<p>&copy; 2011 The jQuery Project</p>
</div>
	
</div><!-- /page -->

</body>
</html>
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`<!DOCTYPE html>`
			`<html>`
			`<head>`
			`<meta charset="utf-8">`
			`<meta name="viewport" content="width=device-width, initial-scale=1">`
updated form section nav 2011-09-28 20:02:56 +00:00			`<title>jQuery Mobile Docs - Slider</title>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`<link rel="stylesheet" href="../../../themes/default/" />`
			`<link rel="stylesheet" href="../../_assets/css/jqm-docs.css"/>`
			`<script src="../../../js/jquery.js"></script>`
			`<script src="../../../experiments/themeswitcher/jquery.mobile.themeswitcher.js"></script>`
			`<script src="../../_assets/js/jqm-docs.js"></script>`
			`<script src="../../../js/"></script>`
			`</head>`
			`<body>`

			`<div data-role="page" class="type-interior">`

			`<div data-role="header" data-theme="f">`
			`<h1>Slider</h1>`
			`<a href="../../../" data-icon="home" data-iconpos="notext" data-direction="reverse" class="ui-btn-right jqm-home">Home</a>`
			`</div><!-- /header -->`

			`<div data-role="content">`
			`<div class="content-primary">`

			`<form action="#" method="get">`
			`<h2>Slider</h2>`

			`<ul data-role="controlgroup" data-type="horizontal" class="localnav">`
			`<li><a href="index.html" data-role="button" data-transition="fade" class="ui-btn-active">Basics</a></li>`
			`<li><a href="options.html" data-role="button" data-transition="fade">Options</a></li>`
			`<li><a href="methods.html" data-role="button" data-transition="fade">Methods</a></li>`
			`<li><a href="events.html" data-role="button" data-transition="fade">Events</a></li>`
			`</ul>`

			`<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 populated in the text input. Specify <code>min</code> and <code>max</code> attribute values to set the slider's range. The framework will parse these attributes to configure the slider widget. </p>`

			`<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>`
Re-vamped form docs to add in full width examples and clean up demos 2011-10-14 19:59:55 +00:00			`<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>`

			`<p>The framework will find all <code>inputs</code> elements with a <code>type="range"</code> and automatically enhance them into a slider with an accompanying input, no 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>.</p> and wrap them in a <code>div</code> with the <code> data-role="fieldcontain"</code> attribute to group them.</p>`

			`<pre><code>`
			`<label for="slider-0">Input slider:</label>`
			`<input type="range" name="slider" id="slider-0" value="25" min="0" max="100" />`
			`</code></pre>`

			`<p>The default slider is displayed like this:</p>`
			`<label for="slider-0">Input slider:</label>`
			`<input type="range" name="slider-1" id="slider-0" value="25" min="0" max="100" />`

			`<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.</p>`

changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00
			`<pre><code>`
Re-vamped form docs to add in full width examples and clean up demos 2011-10-14 19:59:55 +00:00			`<strong><div data-role="fieldcontain">`
			`</strong> <label for="slider">Input slider:</label>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`<input type="range" name="slider" id="slider" value="25" min="0" max="100" />`
Re-vamped form docs to add in full width examples and clean up demos 2011-10-14 19:59:55 +00:00			`<strong></div>`
			`</strong></code></pre>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00
Re-vamped form docs to add in full width examples and clean up demos 2011-10-14 19:59:55 +00:00			`<p>The slider is now be is displayed like this:</p>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`<div data-role="fieldcontain">`
			`<label for="slider-1">Input slider:</label>`
Re-vamped form docs to add in full width examples and clean up demos 2011-10-14 19:59:55 +00:00			`<input type="range" name="slider-1" id="slider-1" value="25" min="0" max="100" />`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`</div>`

			`<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>`
added 'calling plugin' section 2011-09-28 18:52:27 +00:00

			`<h2>Calling the slider plugin</h2>`

updated form section nav 2011-09-28 20:02:56 +00:00			`<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>`
added 'calling plugin' section 2011-09-28 18:52:27 +00:00			`<pre><code>`
			`$('input').slider();`
			`</code></pre>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00
Re-vamped form docs to add in full width examples and clean up demos 2011-10-14 19:59:55 +00:00
			`<h2>Theming the slider</h2>`
			`<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>`

			`<pre><code>`
			`<div data-role="fieldcontain">`
			`<label for="slider-2">Input slider:</label>`
			`<input type="range" name="slider-2" id="slider-1" value="25" min="0" max="100" <strong>data-theme="a" data-track-theme="b"</strong> />`
			`</div>`
			`</code></pre>`

			`<p>This will produce a themed slider:</p>`
			`<div data-role="fieldcontain">`
			`<label for="slider-2">Input slider:</label>`
			`<input type="range" name="slider-2" id="slider-1" value="25" min="0" max="100" data-theme="a" data-track-theme="b" />`
			`</div>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`</form>`
			`</div><!--/content-primary -->`

			`<div class="content-secondary">`

adjusted the presentation of the left nav and footer for the docs 2011-09-29 20:35:31 +00:00			`<div data-role="collapsible" data-collapsed="true" data-theme="b" data-content-theme="d">`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00
			`<h3>More in this section</h3>`

			`<ul data-role="listview" data-theme="c" data-dividertheme="d">`

			`<li data-role="list-divider">Form elements</li>`
			`<li><a href="../docs-forms.html">Form basics</a></li>`
			`<li><a href="../forms-all.html">Form element gallery</a></li>`
			`<li><a href="../textinputs/index.html">Text inputs</a></li>`
updated forms nav links 2011-09-29 14:52:58 +00:00			`<li><a href="../search/">Search input</a></li>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`<li data-theme="a"><a href="index.html">Slider</a></li>`
updated forms nav links 2011-09-29 14:52:58 +00:00			`<li><a href="../switch/">Flip toggle switch</a></li>`
			`<li><a href="../radiobuttons/">Radio buttons</a></li>`
			`<li><a href="../checkboxes/">Checkboxes</a></li>`
			`<li><a href="../selects/">Select menus</a></li>`
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00			`<li><a href="../forms-themes.html">Theming forms</a></li>`
			`<li><a href="../forms-all-native.html">Native form elements</a></li>`
			`<li><a href="../forms-sample.html">Submitting forms</a></li>`
removed plugin events and methods page from nav (keeping it in the directory to redirect) 2011-09-29 15:33:32 +00:00
changed the folder name from 'sliders' to slider 2011-09-28 15:00:37 +00:00
			`</ul>`
			`</div>`
			`</div>`

			`</div><!-- /content -->`

			`<div data-role="footer" class="footer-docs" data-theme="c">`
			`<p>© 2011 The jQuery Project</p>`
			`</div>`

			`</div><!-- /page -->`

			`</body>`
			`</html>`