Hopiu/jquery-mobile
1
0
Fork 0
mirror of https://github.com/Hopiu/jquery-mobile.git synced 2026-03-17 22:40:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
jquery-mobile/docs/forms/selects/options.html

150 lines
6.9 KiB
HTML
Raw Permalink Normal View History

Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>jQuery Mobile Docs - Select options</title>
Fixed a path issue in the assets for these pages. Needed an extra hop for the CSS files.
2011-07-28 16:29:20 +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>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<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>Select Menus</h1>
Missed fixing the home link path. Added another ../
2011-07-28 16:02:55 +00:00
<a href="../../../" data-icon="home" data-iconpos="notext" data-direction="reverse" class="ui-btn-right jqm-home">Home</a>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
</div><!-- /header -->
<div data-role="content">
<div class="content-primary">
<form action="#" method="get">
<h2>Select menus</h2>
<ul data-role="controlgroup" data-type="horizontal" class="localnav">
<li><a href="index.html" data-role="button" data-transition="fade">Basics</a></li>
<li><a href="options.html" data-role="button" data-transition="fade" class="ui-btn-active">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>
updated options
2011-09-28 18:52:48 +00:00
<p>The select menu plugin has the following options:</p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<dl>
<dt><code>corners</code> <em>boolean</em></dt>
<dd>
Removed quotes around boolean value examples.
2011-07-28 20:43:05 +00:00
<p class="default">default: true</p>
updated options
2011-09-28 18:52:48 +00:00
<p>Applies the theme button border-radius to the select button if set to true. This option is also exposed as a data attribute: <code>data-corners=&quot;false&quot;</code></p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<pre><code>$('select').selectmenu(<strong>{ corners: "false" }</strong>);</code></pre>
updated options
2011-09-28 18:52:48 +00:00
</dd>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<dt><code>icon</code> <em>string</em></dt>
<dd>
<p class="default">default: "arrow-down"</p>
simplified language
2011-09-29 17:04:00 +00:00
<p>Applies an icon from the <a href="../../buttons/buttons-icons.html">icon set</a> to the custom button. This option is also exposed as a data attribute: <code>data-icon=&quot;star&quot;</code></p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<pre><code>$('select').selectmenu(<strong>{ icon: "star" }</strong>);</code></pre>
</dd>
<dt><code>iconpos</code> <em>string</em></dt>
<dd>
<p class="default">default: "right"</p>
<p>Position of the icon in the select button. Possible values: left, right, none, notext. The notext value will display the select as an icon-only button with no text feedback. This option is also exposed as a data attribute: <code>data-iconpos=&quot;left&quot;</code></p>
<pre><code>$('select').selectmenu(<strong>{ iconpos: "left" }</strong>);</code></pre>
</dd>
<dt><code>iconshadow</code> <em>boolean</em></dt>
<dd>
Removed quotes around boolean value examples.
2011-07-28 20:43:05 +00:00
<p class="default">default: true</p>
updated options
2011-09-28 18:52:48 +00:00
<p>Applies the theme shadow to the select button if set to true. This option is also exposed as a data attribute: <code>data-iconshadow=&quot;false&quot;</code></p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<pre><code>$('select').selectmenu(<strong>{ iconshadow: "false" }</strong>);</code></pre>
</dd>
Added initSelector option documentation
2011-07-28 21:00:32 +00:00
<dt><code>initSelector</code> <em>CSS selector string</em></dt>
<dd>
<p class="default">default: "select:not(:jqmData(role='slider'))"</p>
updated options
2011-09-28 18:52:48 +00:00
<p>This is used to define the selectors (element types, data roles, etc.) that will automatically be initialized as select menus. To change which elements are initialized, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
Added initSelector option documentation
2011-07-28 21:00:32 +00:00
<pre><code>$( document ).bind( "mobileinit", function(){
<strong>$.mobile.selectmenu.prototype.options.initSelector = ".myselect";</strong>
});
</code></pre>
</dd>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<dt><code>inline</code> <em>boolean</em></dt>
<dd>
Removed quotes around boolean value examples.
2011-07-28 20:43:05 +00:00
<p class="default">default: null (false)</p>
updated options
2011-09-28 18:52:48 +00:00
<p>If set to true, this will make the select button act like an inline button so the width is determined by the button's text. By default, this is null (false) so the select button is full width, regardless of the feedback content. Possible values: true, false. This option is also exposed as a data attribute: <code>data-inline=&quot;true&quot;</code></p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<pre><code>$('select').selectmenu(<strong>{ inline: "true" }</strong>);</code></pre>
</dd>
<dt><code>nativeMenu</code> <em>boolean</em></dt>
<dd>
Removed quotes around boolean value examples.
2011-07-28 20:43:05 +00:00
<p class="default">default: true</p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<p>When set to true, clicking the custom-styled select menu will open the native select menu which is best for performance. If set to false, the custom select menu style will be used instead of the native menu. This option is also exposed as a data attribute: <code>data-native-menu=&quot;false&quot;</code></p>
<pre><code>$('select').selectmenu(<strong>{ nativeMenu: "false" }</strong>);</code></pre>
</dd>
<dt><code>shadow</code> <em>boolean</em></dt>
<dd>
Removed quotes around boolean value examples.
2011-07-28 20:43:05 +00:00
<p class="default">default: true</p>
simplified language
2011-09-29 17:04:00 +00:00
<p>Applies the drop shadow style to the select button if set to true. This option is also exposed as a data attribute: <code>data-shadow=&quot;false&quot;</code></p>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<pre><code>$('select').selectmenu(<strong>{ shadow: "false" }</strong>);</code></pre>
</dd>
<dt><code>theme</code> <em>string</em></dt>
<dd>
<p class="default">default: null, inherited from parent</p>
updated options
2011-09-28 18:52:48 +00:00
<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>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<pre><code>$('select').selectmenu(<strong>{ theme: "a" }</strong>);</code></pre>
</dd>
</dl>
</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">
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +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>
updated navigation links for the text inputs and slider
2011-09-28 15:01:20 +00:00
<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>
<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>
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
<li data-theme="a"><a href="index.html">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>
removed plugin events and methods page from nav (keeping it in the directory to redirect)
2011-09-29 15:33:32 +00:00
Created a new API docs format for people to help us populate. Started with just the select menu API docs to server as a template for others. Each plugin is now in a folder with a local nav between index (summary), options, methods, and events.
2011-07-28 16:00:36 +00:00
</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>
Reference in a new issue Copy permalink