mirror of
https://github.com/Hopiu/jquery-mobile.git
synced 2026-03-17 06:20:26 +00:00
194 lines
9.4 KiB
HTML
Executable file
194 lines
9.4 KiB
HTML
Executable file
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>jQuery Mobile Docs - Forms</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>Forms</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">
|
||
<p>jQuery Mobile provides a complete set of finger-friendly form elements that are based on native HTML form elements.</p>
|
||
|
||
<h2>Form structure</h2>
|
||
|
||
<p>All forms should be wrapped in a <code>form</code> tag that has an <code>action</code> and <code>method</code> that will handle the form data processing on the server.</p>
|
||
|
||
<code>
|
||
<form action="form.php" method="post">
|
||
...
|
||
</form>
|
||
</code>
|
||
|
||
|
||
<h2>Markup conventions</h2>
|
||
<p>When constructing forms to be used in jQuery Mobile, most of the standard guidelines used to create forms that submit via normal HTTP post or get still apply. However, one thing to keep in mind is that the <code>id</code> attributes of form controls need to be not only unique on a given page, but also unique across the pages in a site. This is because jQuery Mobile's single-page navigation model allows many different "pages" to be present in the DOM at the same time, so you must be careful to use unique <code>id</code> attributes so there will be only one of each in the DOM (and of course, be sure to pair them properly with <code>label</code> elements via the <code>for</code> attribute).</p>
|
||
|
||
<h2>Hiding labels accessibly</h2>
|
||
<p>For the sake of accessibility, jQuery Mobile requires that all form elements be paired with a meaningful <code>label</code>. To hide labels in a way that leaves them visible to assistive technologies—for example, when letting an element’s <code>placeholder</code> attribute serve as a label—apply the helper class <code>ui-hidden-accessible</code> to the label itself:</p>
|
||
<code>
|
||
<pre>
|
||
<label for="username" <strong>class="ui-hidden-accessible"</strong>>Username:</label>
|
||
<input type="text" name="username" id="username" value="" placeholder="Username"/>
|
||
</pre>
|
||
</code>
|
||
|
||
<p>To hide labels within a field container and adjust the layout accordingly, add the class <code>ui-hide-label</code> to the field container as in the following:</p>
|
||
|
||
<code>
|
||
<pre>
|
||
<div data-role="fieldcontain" <strong>class="ui-hide-label"</strong>>
|
||
<label for="username">Username:</label>
|
||
<input type="text" name="username" id="username" value="" placeholder="Username"/>
|
||
</div>
|
||
</pre>
|
||
</code>
|
||
|
||
<p>Both of the above examples will render as:</p>
|
||
<div data-role="fieldcontain" class="ui-hide-label">
|
||
<label for="username">Username:</label>
|
||
<input type="text" name="username" id="username" value="" placeholder="Username" />
|
||
</div>
|
||
|
||
<p>While the label will no longer be visible, it will be available to assisitive technologies such as screen readers.</p>
|
||
|
||
<h2>Auto-initialization of form elements</h2>
|
||
<p>By default, jQuery Mobile will automatically enhance certain native form controls into rich touch-friendly components. This is handled internally by finding form elements by tag name and running a plugin method on them, so for instance, a <code>select</code> element will be found and initialized with the "selectmenu" plugin, while an <code>input</code> element with a <code>type="checkbox"</code> will be enhanced with the "checkboxradio" plugin. Once initialized, you can address these enhanced components programmatically through their jQuery UI widget API methods (see documentation on available methods here: <a href="plugin-eventsmethods.html">Form Plugin Methods</a>). </p>
|
||
|
||
<h2>Initializing groups of dynamically-injected form elements</h2>
|
||
<p>If you should generate new markup client-side or load in content via AJAX and inject it into a page, you can trigger the <code>create</code> event to handle the auto-initialization for all the plugins contained within the new markup. This can be triggered on any element (even the page div itself), saving you the task of manually initializing each plugin (see below).</p>
|
||
|
||
<p>For example, if a block of HTML markup (say a login form) was loaded in through Ajax, trigger the create event to automatically transform all the widgets it contains (inputs and buttons in this case) into the enhanced versions. The code for this scenario would be:</p>
|
||
|
||
<code>
|
||
$( ...new markup that contains widgets... ).appendTo( ".ui-page" ).trigger( "create" );
|
||
</code>
|
||
|
||
<h2>Initializing individual form elements</h2>
|
||
|
||
<p>Every form control -- where applicable -- has a refresh method. Here are some examples:</p>
|
||
<p>Checkboxes:</p>
|
||
|
||
<code>
|
||
$("input[type='checkbox']").attr("checked",true).checkboxradio("refresh");
|
||
</code>
|
||
|
||
<p>Radios:</p>
|
||
<code>
|
||
$("input[type='radio']").attr("checked",true).checkboxradio("refresh");
|
||
</code>
|
||
|
||
<p>Selects:</p>
|
||
<code><pre>
|
||
var myselect = $("select#foo");
|
||
myselect[0].selectedIndex = 3;
|
||
myselect.selectmenu("refresh");
|
||
</pre></code>
|
||
|
||
<p>Sliders:</p>
|
||
<code>
|
||
$("input[type=range]").val(60).slider("refresh");
|
||
</code>
|
||
|
||
<p>Flip switches (they use slider):</p>
|
||
|
||
<code><pre>
|
||
var myswitch = $("select#bar");
|
||
myswitch[0].selectedIndex = 1;
|
||
myswitch.slider("refresh");
|
||
</pre></code>
|
||
|
||
<h2>Preventing auto-initialization of form elements</h2>
|
||
<p>If you'd prefer that a particular form control be left untouched by jQuery Mobile, simply give that element the attribute <code> data-role="none"</code>. For example:</p>
|
||
<pre><code>
|
||
<label for="foo">
|
||
<select name="foo" id="foo" <strong> data-role="none"</strong>>
|
||
<option value="a" >A</option>
|
||
<option value="b" >B</option>
|
||
<option value="c" >C</option>
|
||
</select>
|
||
</code></pre>
|
||
|
||
|
||
<p>Or, if you'd like to prevent auto-initialization without adding attributes to your markup, you can customize the selector that is used for preventing auto-initialization by setting the page plugin's <code>keepNative</code> option (which defaults to <code>[data-role="none"]</code>. Be sure to configure this option inside an event handler bound to the <code>mobileinit</code> event, so that it applies to the first page as well as subsequent pages that are loaded.</p>
|
||
<pre><code>
|
||
$(document).bind('mobileinit',function(){
|
||
<strong>$.mobile.page.prototype.options.keepNative = "select, input.foo, textarea.bar";</strong>
|
||
});
|
||
</pre></code>
|
||
|
||
<p>One special case is that of selects. The above sample will prevent any and all augmentation from taking place on select elements in the page if <code>select</code> is included. If you wish to retain the native performance, look/feel of the menu itself and benefit from the visual augmentation of the select button by jQuery Mobile you can set $.mobile.nativeSelectMenu to true in a <code>mobileinit</code> callback as a global setting or use <code>data-native="true"</code> on a case by case basis.</p>
|
||
|
||
<h2>Field containers</h2>
|
||
<p>To improve the styling to labels and form elements on wider screens, we recommend wrapping a <code>div</code> or <code>fieldset </code>with the <code> data-role="fieldcontain"</code> attribute around each label/form element. This framework aligns the input and associated label side-by-side, and breaks to stacked block-level elements below ~480px. The framework will also add a thin bottom border to act as a field seperator.</p>
|
||
|
||
<p>For example:</p>
|
||
<pre><code>
|
||
<div data-role="fieldcontain">
|
||
<label for="name">Text Input:</label>
|
||
<input type="text" name="name" id="name" value="" />
|
||
</div>
|
||
</code></pre>
|
||
|
||
<p>Will render as:</p>
|
||
|
||
<div data-role="fieldcontain">
|
||
<label for="name">Text Input:</label>
|
||
<input type="text" name="name" id="name" value="" />
|
||
</div>
|
||
|
||
<p>For additional examples, see the <a href="forms-all.html">form elements gallery</a></p>
|
||
|
||
</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 data-theme="a"><a href="docs-forms.html">Form basics</a></li>
|
||
<li><a href="forms-all.html">Form element gallery</a></li>
|
||
<li><a href="textinputs/">Text inputs</a></li>
|
||
<li><a href="search/">Search inputs</a></li>
|
||
<li><a href="slider/">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>© 2011 The jQuery Project</p>
|
||
</div>
|
||
|
||
</div><!-- /page -->
|
||
|
||
</body>
|
||
</html>
|