Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #3809 from jakeboone02/collapsible-api-docs

Collapsible and Collapsible Set API docs
  • Loading branch information...
commit d640e387e8edceb6d44b9eec77b41f8cfe5bb52e 2 parents 59b1f20 + 7a73533
@gseguin gseguin authored
View
109 docs/content/content-collapsible-events.html
@@ -0,0 +1,109 @@
+<!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 content</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 content</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible.html" data-role="button" data-transition="fade">Basics</a></li>
+ <li><a href="content-collapsible-options.html" data-role="button" data-transition="fade">Options</a></li>
+ <li><a href="content-collapsible-methods.html" data-role="button" data-transition="fade">Methods</a></li>
+ <li><a href="content-collapsible-events.html" data-role="button" data-transition="fade" class="ui-btn-active">Events</a></li>
+ </ul>
+
+ <p>Bind events directly to the 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( "collapse", function(event, ui) {
+ ...
+});
+</code></pre>
+
+ <p>The collapsible plugin has the following custom events:</p>
+
+ <dl>
+
+ <dt><code>create</code> triggered when a collapsible is created</dt>
+ <dd>
+
+ <pre><code>
+$( ".selector" ).collapsible({
+ create: function(event, ui) { ... }
+});
+ </code></pre>
+ </dd>
+
+ <dt><code>collapse</code> triggered when a collapsible is collapsed</dt>
+ <dd>
+
+ <pre><code>
+$( ".selector" ).collapsible({
+ collapse: function(event, ui) { ... }
+});
+ </code></pre>
+ </dd>
+
+ <dt><code>expand</code> triggered when a collapsible is expanded</dt>
+ <dd>
+
+ <pre><code>
+$( ".selector" ).collapsible({
+ expand: 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 data-theme="a"><a href="content-collapsible.html">Collapsible content blocks</a></li>
+ <li><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>
View
67 docs/content/content-collapsible-methods.html
@@ -0,0 +1,67 @@
+<!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 content</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 content</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible.html" data-role="button" data-transition="fade">Basics</a></li>
+ <li><a href="content-collapsible-options.html" data-role="button" data-transition="fade">Options</a></li>
+ <li><a href="content-collapsible-methods.html" data-role="button" data-transition="fade" class="ui-btn-active">Methods</a></li>
+ <li><a href="content-collapsible-events.html" data-role="button" data-transition="fade">Events</a></li>
+ </ul>
+
+ <p>The collapsible plugin has no public methods.</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">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 data-theme="a"><a href="content-collapsible.html">Collapsible content blocks</a></li>
+ <li><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>
View
178 docs/content/content-collapsible-options.html
@@ -0,0 +1,178 @@
+<!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 content</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 content</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible.html" data-role="button" data-transition="fade">Basics</a></li>
+ <li><a href="content-collapsible-options.html" data-role="button" data-transition="fade" class="ui-btn-active">Options</a></li>
+ <li><a href="content-collapsible-methods.html" data-role="button" data-transition="fade">Methods</a></li>
+ <li><a href="content-collapsible-events.html" data-role="button" data-transition="fade">Events</a></li>
+ </ul>
+
+ <p>The collapsible plugin has the following options:</p>
+
+ <dl>
+ <dt><code>collapsed</code> <em>boolean</em></dt>
+ <dd>
+ <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 = false;</strong>
+});
+</code></pre>
+ <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>
+ <dd>
+ <p class="default">default: " click to collapse contents"</p>
+ <p>This text is used to provide audible feedback for users with screen reader software. 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.collapseCueText = " collapse with a click";</strong>
+});
+</code></pre>
+ </dd>
+
+ <dt><code>contentTheme</code> <em>string</em></dt>
+ <dd>
+ <p class="default">default: null, inherited from parent</p>
+ <p>Sets the color scheme (swatch) for the collapsible content block. 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.collapsible.prototype.options.contentTheme = "a";</strong>
+});
+</code></pre>
+ <p>This option is also exposed as a data attribute: <code>data-content-theme=&quot;a&quot;</code>.</p>
+ </dd>
+
+ <dt><code>expandCueText</code> <em>string</em></dt>
+ <dd>
+ <p class="default">default: " click to expand contents"</p>
+ <p>This text is used to provide audible feedback for users with screen reader software. 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.expandCueText = " expand with a click";</strong>
+});
+</code></pre>
+ </dd>
+
+ <dt><code>heading</code> <em>string</em></dt>
+ <dd>
+ <p class="default">default: "h1,h2,h3,h4,h5,h6,legend"</p>
+ <p>Within the collapsible container, the first immediate child element that matches this selector will be used as the header for the collapsible. To change the selector, 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.heading = ".mycollapsibleheading";</strong>
+});
+</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>
+ <p class="default">default: "d"</p>
+ <p>Sets the color scheme (swatch) for the collapsible header icon. 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.collapsible.prototype.options.iconTheme = "a";</strong>
+});
+</code></pre>
+ <p>This option is also exposed as a data attribute: <code>data-icon-theme=&quot;a&quot;</code>.</p>
+ </dd>
+-->
+
+ <dt><code>initSelector</code> <em>CSS selector string</em></dt>
+ <dd>
+ <p class="default">default: ":jqmData(role='collapsible')"</p>
+ <p>This is used to define the selectors (element types, data roles, etc.) that will automatically be initialized as collapsibles. 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.collapsible.prototype.options.initSelector = ".mycollapsible";</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>. 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>
+});
+</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. 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.collapsible.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 data-theme="a"><a href="content-collapsible.html">Collapsible content blocks</a></li>
+ <li><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>
View
89 docs/content/content-collapsible-set-events.html
@@ -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>
View
80 docs/content/content-collapsible-set-methods.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>
View
112 docs/content/content-collapsible-set-options.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>
View
11 docs/content/content-collapsible-set.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>
View
33 docs/content/content-collapsible.html
@@ -17,22 +17,29 @@
<div data-role="page" class="type-interior">
<div data-role="header" data-theme="f">
- <h1>Collapsible content</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 -->
+ <h1>Collapsible content</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 content</h2>
+
+ <ul data-role="controlgroup" data-type="horizontal" class="localnav">
+ <li><a href="content-collapsible.html" data-role="button" data-transition="fade" class="ui-btn-active">Basics</a></li>
+ <li><a href="content-collapsible-options.html" data-role="button" data-transition="fade">Options</a></li>
+ <li><a href="content-collapsible-methods.html" data-role="button" data-transition="fade">Methods</a></li>
+ <li><a href="content-collapsible-events.html" data-role="button" data-transition="fade">Events</a></li>
+ </ul>
- <div data-role="content">
- <div class="content-primary">
-
- <h2>Collapsible content markup</h2>
- <p>To create a collapsible block of content, create a container and add the <code> data-role="collapsible"</code> attribute. Using <code>data-content-theme</code> attribute allows you to set a theme for the content of the collapsible. View the <a href="../api/data-attributes.html">data- attribute reference</a> to see all the possible attributes you can add to collapsibles.</p>
+ <p>To create a collapsible block of content, create a container and add the <code> data-role="collapsible"</code> attribute. Using <code>data-content-theme</code> attribute allows you to set a theme for the content of the collapsible. View the <a href="../api/data-attributes.html">data- attribute reference</a> to see all the possible attributes you can add to collapsibles.</p>
- <p>Directly inside this container, add any header element (H1-H6). The framework will style the header to look like a clickable button and add a "+" icon to the left to indicate it's expandable.</p>
-
- <p>After the header, add any HTML markup you want to be collapsible. The framework will wrap this markup in a container that will be hidden/shown when the heading is clicked.</p>
+ <p>Directly inside this container, add any header element (H1-H6). The framework will style the header to look like a clickable button and add a "+" icon to the left to indicate it's expandable.</p>
- <p>By default, the content will be collapsed.</p>
+ <p>After the header, add any HTML markup you want to be collapsible. The framework will wrap this markup in a container that will be hidden/shown when the heading is clicked.</p>
+
+ <p>By default, the content will be collapsed.</p>
<pre><code>
&lt;div <strong>data-role=&quot;collapsible&quot;</strong>&gt;
&lt;h3&gt;I&#x27;m a header&lt;/h3&gt;
Please sign in to comment.
Something went wrong with that request. Please try again.