Permalink
Browse files

Added documentation on collapsible set plugin API

  • Loading branch information...
jakeboone02 committed Mar 14, 2012
1 parent c754dec commit 7a735337da0870607dcf4da3453eb741d6d2cff7
@@ -38,13 +38,13 @@ <h2>Collapsible content</h2>
<dl>
<dt><code>collapsed</code> <em>boolean</em></dt>
<dd>
- <p class="default">default: false</p>
- <p>When true, the container is initially collapsed with a plus icon. To set the value for all instances of this widget, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
+ <p class="default">default: true</p>
+ <p>When false, the container is initially expanded with a minus icon in the header. To set the value for all instances of this widget, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
<pre><code>$( document ).bind( "mobileinit", function(){
- <strong>$.mobile.collapsible.prototype.options.collapsed = true;</strong>
+ <strong>$.mobile.collapsible.prototype.options.collapsed = false;</strong>
});
</code></pre>
- <p>This option is also exposed as a data attribute: <code>data-collapsed=&quot;true&quot;</code>.</p>
+ <p>This option is also exposed as a data attribute: <code>data-collapsed=&quot;false&quot;</code>.</p>
</dd>
<dt><code>collapseCueText</code> <em>string</em></dt>
@@ -88,6 +88,17 @@ <h2>Collapsible content</h2>
</code></pre>
</dd>
+ <dt><code>iconpos</code> <em>string</em></dt>
+ <dd>
+ <p class="default">default: "left"</p>
+ <p>Positions the icon in the collapsible header. Possible values: left, right, top, bottom, none, notext.</p>
+<pre><code>$( document ).bind( "mobileinit", function(){
+ <strong>$.mobile.collapsible.prototype.options.iconpos = "right";</strong>
+});
+</code></pre>
+ <p>This option is also exposed as a data attribute: <code>data-iconpos=&quot;right&quot;</code>.</p>
+ </dd>
+
<!--
<dt><code>iconTheme</code> <em>string</em></dt>
<dd>
@@ -114,7 +125,7 @@ <h2>Collapsible content</h2>
<dt><code>mini</code> <em>boolean</em></dt>
<dd>
<p class="default">default: false</p>
- <p>Sets the size of the element to a more compact, <a href="../forms/forms-all-mini.html">mini version</a>. To set the value for all instances of this widget, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
+ <p>Sets the size of the element to a more compact, <a href="../forms/forms-all-mini.html">mini version</a>. If the value is false for an individual collapsible container, but that container is part of a collapsible set, then the value is inherited from the parent collapsible set. To set the value for all instances of this widget, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
<pre><code>$( document ).bind( "mobileinit", function(){
<strong>$.mobile.collapsible.prototype.options.mini = true;</strong>
});
@@ -0,0 +1,89 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>jQuery Mobile Docs - Collapsible Content</title>
+ <link rel="stylesheet" href="../../css/themes/default/jquery.mobile.css" />
+ <link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
+
+ <script src="../../js/jquery.js"></script>
+ <script src="../../docs/_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>Collapsible sets (accordions)</h1>
+ <a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse">Home</a>
+ <a href="../nav.html" data-icon="search" data-iconpos="notext" data-rel="dialog" data-transition="fade">Search</a>
+ </div><!-- /header -->
+
+ <div data-role="content">
+ <div class="content-primary">
+ <h2>Collapsible sets</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible-set.html" data-role="button" data-transition="fade">Basics</a></li>
+ <li><a href="content-collapsible-set-options.html" data-role="button" data-transition="fade">Options</a></li>
+ <li><a href="content-collapsible-set-methods.html" data-role="button" data-transition="fade">Methods</a></li>
+ <li><a href="content-collapsible-set-events.html" data-role="button" data-transition="fade" class="ui-btn-active">Events</a></li>
+ </ul>
+
+ <p>Bind events directly to the set container, typically a <code>div</code> element. Use jQuery Mobile's <a href="../api/events.html">virtual events</a>, or bind standard JavaScript events, like change, focus, blur, etc.:</p>
+ <pre><code>
+$( ".selector" ).bind( "create", function(event, ui) {
+ ...
+});
+</code></pre>
+
+ <p>The collapsible set plugin has the following custom event:</p>
+
+ <dl>
+
+ <dt><code>create</code> triggered when a collapsible set is created</dt>
+ <dd>
+
+ <pre><code>
+$( ".selector" ).collapsibleset({
+ create: function(event, ui) { ... }
+});
+ </code></pre>
+ </dd>
+
+ </dl>
+
+ </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">Content Formatting</li>
+ <li><a href="content-html.html">Basic HTML styles</a></li>
+ <li><a href="content-grids.html">Layout grids (columns)</a></li>
+ <li><a href="content-collapsible.html">Collapsible content blocks</a></li>
+ <li data-theme="a"><a href="content-collapsible-set.html">Collapsible sets (accordions)</a></li>
+ <li><a href="content-themes.html">Theming content</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+</div><!-- /content -->
+
+<div data-role="footer" class="footer-docs" data-theme="c">
+ <p>&copy; 2011-12 The jQuery Project</p>
+</div>
+
+</div><!-- /page -->
+
+</body>
+</html>
@@ -0,0 +1,80 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>jQuery Mobile Docs - Collapsible Sets</title>
+ <link rel="stylesheet" href="../../css/themes/default/jquery.mobile.css" />
+ <link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
+
+ <script src="../../js/jquery.js"></script>
+ <script src="../../docs/_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>Collapsible sets (accordions)</h1>
+ <a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse">Home</a>
+ <a href="../nav.html" data-icon="search" data-iconpos="notext" data-rel="dialog" data-transition="fade">Search</a>
+ </div><!-- /header -->
+
+ <div data-role="content">
+ <div class="content-primary">
+ <h2>Collapsible sets</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible-set.html" data-role="button" data-transition="fade">Basics</a></li>
+ <li><a href="content-collapsible-set-options.html" data-role="button" data-transition="fade">Options</a></li>
+ <li><a href="content-collapsible-set-methods.html" data-role="button" data-transition="fade" class="ui-btn-active">Methods</a></li>
+ <li><a href="content-collapsible-set-events.html" data-role="button" data-transition="fade">Events</a></li>
+ </ul>
+
+ <p>The collapsible set plugin has the following method:</p>
+
+ <dl>
+ <dt><code>refresh</code> update the collapsible set</dt>
+ <dd>
+ <p>If you manipulate a collapsible set via JavaScript (e.g. add new collapsible containers), you must call the refresh method on it to update the visual styling.</p>
+
+ <pre><code>
+$('.selector').collapsibleset('refresh');
+ </code></pre>
+ </dd>
+
+ </dl>
+
+ </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">Content Formatting</li>
+ <li><a href="content-html.html">Basic HTML styles</a></li>
+ <li><a href="content-grids.html">Layout grids (columns)</a></li>
+ <li><a href="content-collapsible.html">Collapsible content blocks</a></li>
+ <li data-theme="a"><a href="content-collapsible-set.html">Collapsible sets (accordions)</a></li>
+ <li><a href="content-themes.html">Theming content</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+</div><!-- /content -->
+
+<div data-role="footer" class="footer-docs" data-theme="c">
+ <p>&copy; 2011-12 The jQuery Project</p>
+</div>
+
+</div><!-- /page -->
+
+</body>
+</html>
@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>jQuery Mobile Docs - Collapsible Sets</title>
+ <link rel="stylesheet" href="../../css/themes/default/jquery.mobile.css" />
+ <link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
+
+ <script src="../../js/jquery.js"></script>
+ <script src="../../docs/_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>Collapsible sets (accordions)</h1>
+ <a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse">Home</a>
+ <a href="../nav.html" data-icon="search" data-iconpos="notext" data-rel="dialog" data-transition="fade">Search</a>
+ </div><!-- /header -->
+
+ <div data-role="content">
+ <div class="content-primary">
+ <h2>Collapsible sets</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible-set.html" data-role="button" data-transition="fade">Basics</a></li>
+ <li><a href="content-collapsible-set-options.html" data-role="button" data-transition="fade" class="ui-btn-active">Options</a></li>
+ <li><a href="content-collapsible-set-methods.html" data-role="button" data-transition="fade">Methods</a></li>
+ <li><a href="content-collapsible-set-events.html" data-role="button" data-transition="fade">Events</a></li>
+ </ul>
+
+ <p>The collapsible plugin has the following options:</p>
+
+ <dl>
+ <dt><code>iconpos</code> <em>string</em></dt>
+ <dd>
+ <p class="default">default: "left"</p>
+ <p>Positions the icons in the collapsible headers. Possible values: left, right, top, bottom, none, notext.</p>
+<pre><code>$( document ).bind( "mobileinit", function(){
+ <strong>$.mobile.collapsibleset.prototype.options.iconpos = "right";</strong>
+});
+</code></pre>
+ <p>This option is also exposed as a data attribute: <code>data-iconpos=&quot;right&quot;</code>.</p>
+ </dd>
+
+ <dt><code>initSelector</code> <em>CSS selector string</em></dt>
+ <dd>
+ <p class="default">default: ":jqmData(role='collapsible-set')"</p>
+ <p>This is used to define the selectors (element types, data roles, etc.) that will automatically be initialized as collapsible sets. To change which elements are initialized, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
+<pre><code>$( document ).bind( "mobileinit", function(){
+ <strong>$.mobile.collapsibleset.prototype.options.initSelector = ".mycollapsibleset";</strong>
+});
+</code></pre>
+ </dd>
+
+ <dt><code>mini</code> <em>boolean</em></dt>
+ <dd>
+ <p class="default">default: false</p>
+ <p>Sets the size of the element to a more compact, <a href="../forms/forms-all-mini.html">mini version</a>. To set the value for all instances of this widget, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
+<pre><code>$( document ).bind( "mobileinit", function(){
+ <strong>$.mobile.collapsibleset.prototype.options.mini = true;</strong>
+});
+</code></pre>
+ <p>This option is also exposed as a data attribute: <code>data-mini=&quot;true&quot;</code>.</p>
+ </dd>
+ <dt><code>theme</code> <em>string</em></dt>
+ <dd>
+ <p class="default">default: null, inherited from parent</p>
+ <p>Sets the color scheme (swatch) for the collapsible set. It accepts a single letter from a-z that maps to the swatches included in your theme. To set the value for all instances of this widget, bind this option to the <a href="../../api/globalconfig.html">mobileinit event</a>:</p>
+<pre><code>$( document ).bind( "mobileinit", function(){
+ <strong>$.mobile.collapsibleset.prototype.options.theme = "a";</strong>
+});
+</code></pre>
+ <p>This option is also exposed as a data attribute: <code>data-theme=&quot;a&quot;</code>.</p>
+ </dd>
+
+ </dl>
+ </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">Content Formatting</li>
+ <li><a href="content-html.html">Basic HTML styles</a></li>
+ <li><a href="content-grids.html">Layout grids (columns)</a></li>
+ <li><a href="content-collapsible.html">Collapsible content blocks</a></li>
+ <li data-theme="a"><a href="content-collapsible-set.html">Collapsible sets (accordions)</a></li>
+ <li><a href="content-themes.html">Theming content</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+</div><!-- /content -->
+
+<div data-role="footer" class="footer-docs" data-theme="c">
+ <p>&copy; 2011-12 The jQuery Project</p>
+</div>
+
+</div><!-- /page -->
+
+</body>
+</html>
@@ -17,15 +17,22 @@
<div data-role="page" class="type-interior">
<div data-role="header" data-theme="f">
- <h1>Collapsible sets (Accordions)</h1>
+ <h1>Collapsible sets (accordions)</h1>
<a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse">Home</a>
<a href="../nav.html" data-icon="search" data-iconpos="notext" data-rel="dialog" data-transition="fade">Search</a>
</div><!-- /header -->
<div data-role="content">
<div class="content-primary">
-
<h2>Collapsible set markup</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible-set.html" data-role="button" data-transition="fade" class="ui-btn-active">Basics</a></li>
+ <li><a href="content-collapsible-set-options.html" data-role="button" data-transition="fade">Options</a></li>
+ <li><a href="content-collapsible-set-methods.html" data-role="button" data-transition="fade">Methods</a></li>
+ <li><a href="content-collapsible-set-events.html" data-role="button" data-transition="fade">Events</a></li>
+ </ul>
+
<p>Collapsible sets start with the exact same markup as <a href="content-collapsible.html">individual collapsibles</a>. By adding a parent wrapper with a <code> data-role="collapsible-set"</code> attribute around a number of collapsibles, the framework will style these to looks like a visually grouped widget and make it behave like an accordion so only one section can be open at a time. View the <a href="../api/data-attributes.html">data- attribute reference</a> to see all the possible attributes you can add to collapsible sets.</p>
<p>By default, all the sections will be collapsed. To set a section to be open when the page loads, add the <code> data-collapsed="false"</code> attribute to the heading of the section you want expanded.</p>

0 comments on commit 7a73533

Please sign in to comment.