libs/js/jquery-mobile-1.1.0/docs/forms/textinputs/options.html

   1 <!DOCTYPE html>
   2 <html>
   3         <head>
   4         <meta charset="utf-8">
   5         <meta name="viewport" content="width=device-width, initial-scale=1">
   6         <title>jQuery Mobile Docs - Text Input options</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>
  13
  14 </head>
  15 <body>
  16
  17         <div data-role="page" class="type-interior">
  18
  19                 <div data-role="header" data-theme="f">
  20                 <h1>Text inputs</h1>
  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 -->
  24
  25         <div data-role="content">
  26                 <div class="content-primary">
  27
  28                 <form action="#" method="get">
  29
  30                         <h2>Text inputs</h2>
  31
  32                         <ul data-role="controlgroup" data-type="horizontal" class="localnav">
  33                                 <li><a href="index.html" data-role="button" data-transition="fade">Basics</a></li>
  34                                 <li><a href="options.html" data-role="button" data-transition="fade" class="ui-btn-active">Options</a></li>
  35                                 <li><a href="methods.html" data-role="button" data-transition="fade">Methods</a></li>
  36                                 <li><a href="events.html" data-role="button" data-transition="fade">Events</a></li>
  37                         </ul>
  38
  39                         <p>The text input plugin has the following options:</p>
  40
  41                 <dl>
  42                         <dt><code>initSelector</code> <em>CSS selector string</em></dt>
  43                         <dd>
  44                                 <p class="default">default: "input[type='text'], input[type='search'], :jqmData(type='search'), input[type='number'], :jqmData(type='number'), input[type='password'], input[type='email'], input[type='url'], input[type='tel'], textarea, input:not([type])"</p>
  45                                 <p>This is used to define the selectors (element types, data roles, etc.) that will automatically be initialized as textinputs. To change which elements are initialized, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
  46 <pre><code>$( document ).bind( "mobileinit", function(){
  47    <strong>$.mobile.textinput.prototype.options.initSelector = ".myInputs";</strong>
  48 });
  49 </code></pre>
  50                         </dd>
  51
  52                         <dt><code>mini</code> <em>boolean</em></dt>
  53                         <dd>
  54                                 <p class="default">default: false</p>
  55                                 <p>Sets the size of the element to a more compact, <a href="../forms-all-mini.html">mini version</a>. This option is also exposed as a data attribute: <code>data-mini=&quot;true&quot;</code></p>
  56                                 <pre><code>$('.selector').textinput(<strong>{ mini: "true" }</strong>);</code></pre>
  57                         </dd>
  58
  59                         <dt><code>preventFocusZoom</code> <em>boolean</em></dt>
  60                         <dd>
  61                                 <p class="default">default: true on iOS platforms</p>
  62                                 <p>This option disables page zoom temporarily when a custom input is focused, which prevents iOS devices from zooming the page into the input. By default, iOS often zooms into form controls, and the behavior is often unnecessary and intrusive in mobile-optimized layouts. This option is also exposed as a data attribute: <code>data-prevent-focus-zoom=&quot;true&quot;</code></p>
  63                                 <pre><code>$('input').textinput(<strong>{ preventFocusZoom: true }</strong>);</code></pre>
  64                         </dd>
  65
  66
  67                         <dt><code>theme</code> <em>string</em></dt>
  68                         <dd>
  69                                 <p class="default">default: null, inherited from parent</p>
  70                                 <p>Sets the color scheme (swatch) for all instances of this widget. It accepts a single letter from a-z that maps to the swatches included in your theme. By default, it will inherit the same swatch color as it's parent container if not explicitly set. This option is also exposed as a data attribute: <code>data-theme=&quot;a&quot;</code></p>
  71                                 <pre><code>$('.selector').textinput(<strong>{ theme: "a" }</strong>);</code></pre>
  72                         </dd>
  73
  74                 </dl>
  75
  76         </form>
  77         </div><!--/content-primary -->
  78
  79         <div class="content-secondary">
  80
  81                 <div data-role="collapsible" data-collapsed="true" data-theme="b" data-content-theme="d">
  82
  83                                 <h3>More in this section</h3>
  84
  85                                 <ul data-role="listview" data-theme="c" data-dividertheme="d">
  86
  87                                         <li data-role="list-divider">Form elements</li>
  88                                         <li><a href="../docs-forms.html">Form basics</a></li>
  89                                         <li><a href="../forms-all.html">Form element gallery</a></li>
  90                                         <li><a href="../forms-all-mini.html">Mini form element gallery</a></li>
  91                                         <li data-theme="a"><a href="index.html">Text inputs</a></li>
  92                                         <li><a href="../search/">Search input</a></li>
  93                                         <li><a href="../slider/">Slider</a></li>
  94                                         <li><a href="../switch/">Flip toggle switch</a></li>
  95                                         <li><a href="../radiobuttons/">Radio buttons</a></li>
  96                                         <li><a href="../checkboxes/">Checkboxes</a></li>
  97                                         <li><a href="../selects/">Select menus</a></li>
  98                                         <li><a href="../forms-themes.html">Theming forms</a></li>
  99                                         <li><a href="../forms-all-native.html">Native form elements</a></li>
 100                                         <li><a href="../forms-sample.html">Submitting forms</a></li>
 101
 102
 103                                 </ul>
 104                 </div>
 105         </div>
 106
 107 </div><!-- /content -->
 108
 109 <div data-role="footer" class="footer-docs" data-theme="c">
 110                 <p>&copy; 2011-12 The jQuery Foundation</p>
 111 </div>
 112
 113 </div><!-- /page -->
 114
 115 </body>
 116 </html>
 117