Hopiu/jquery-mobile
1
0
Fork 0
mirror of https://github.com/Hopiu/jquery-mobile.git synced 2026-04-05 07:01:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Combined settings and global config pages

Browse source
This commit is contained in:
Todd Parker 2010-11-11 14:25:41 -05:00
parent fab9034886
commit db9e9c918e
2 changed files with 45 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
docs/api/global-settings.html
View file

@ -1,69 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>jQuery Mobile Docs - Configurable Default Settings</title>
<link rel="stylesheet" href="../../themes/default" />
<link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
<script type="text/javascript" src="../../js/"></script>
</head>
<body>
<div data-role="page">
<div data-role="header">
<h1>Configurable Default Settings</h1>
</div><!-- /header -->
<div data-role="content" data-theme="c">
<p>The following defaults are configurable via the <code>$.mobile</code> object:</p>
<dl>
<dt>subPageUrlKey (<em>string</em>, default: "ui-page"):</dt>
<dd>The url parameter used for referencing widget-generated sub-pages (such as those generated by nested listviews). Translates to to <em>example.html<strong>&ui-page=</strong>subpageIdentifier</em>. The hash segment before &ui-page= is used by the framework for making an Ajax request to the URL where the sub-page exists.</dd>
<dt>nonHistorySelectors (<em>string</em>, default: "dialog"):</dt>
<dd>Anchor links with a data-rel attribute value, or pages with a data-role value, that match these selectors will not be trackable in history (they won't update the location.hash and won't be bookmarkable).</dd>
<dt>activePageClass (<em>string</em>, default: "ui-page-active"):</dt>
<dd>The class assigned to page currently in view, and during transitions</dd>
<dt>activeBtnClass (<em>string</em>, default: "ui-page-active"):</dt>
<dd>The class used for "active" button state, from CSS framework.</dd>
<dt>ajaxLinksEnabled (<em>boolean</em>, default: true):</dt>
<dd>jQuery Mobile will automatically handle link clicks through Ajax, when possible.</dd>
<dt>ajaxFormsEnabled (<em>boolean</em>, default: true):</dt>
<dd>jQuery Mobile will automatically handle form submissions through Ajax, when possible.</dd>
<dt>transitions (<em>array</em>, default: ['slide', 'slideup', 'slidedown', 'pop', 'flip', 'fade']):</dt>
<dd>Available CSS transitions in the CSS.</dd>
<dt>defaultTransition (<em>string</em>, default: 'slide'):</dt>
<dd>Set the default transition for page changes that use Ajax. Set to 'none' for no transitions by default.</dd>
<dt>loadingMessage (<em>string</em>, default: "loading"):</dt>
<dd>Set the text that appears when a page is loading. If set to false, the message will not appear at all.</dd>
<dt>metaViewportContent (<em>string</em>, default: "width=device-width, minimum-scale=1, maximum-scale=1"):</dt>
<dd>Configure the auto-generated meta viewport tag's content attribute. If false, no meta tag will be appended to the DOM.</dd>
<dt>gradeA (<em>function that returns a boolean</em>, default: a function returning the value of $.support.mediaquery):</dt>
<dd>Any support conditions that must be met in order to proceed.</dd>
</dl>
<p>Visit the <a href="globalconfig.html">Configuring Default Settings</a> page for instructions on configuring these properties.</p>
</div><!-- /content -->
</div><!-- /page -->
</body>
</html>

46
docs/api/globalconfig.html
View file

@ -60,7 +60,51 @@ $(document).live("mobileinit", function(){
</code>
</pre>
<p>Visit the <a href="global-settings.html">Configurable Default Settings</a> page for information on the configurable defaults.</p>
<h2>Configurable options</h2>
<p>The following defaults are configurable via the <code>$.mobile</code> object:</p>
<dl>
<dt>subPageUrlKey (<em>string</em>, default: "ui-page"):</dt>
<dd>The url parameter used for referencing widget-generated sub-pages (such as those generated by nested listviews). Translates to to <em>example.html<strong>&ui-page=</strong>subpageIdentifier</em>. The hash segment before &ui-page= is used by the framework for making an Ajax request to the URL where the sub-page exists.</dd>
<dt>nonHistorySelectors (<em>string</em>, default: "dialog"):</dt>
<dd>Anchor links with a data-rel attribute value, or pages with a data-role value, that match these selectors will not be trackable in history (they won't update the location.hash and won't be bookmarkable).</dd>
<dt>activePageClass (<em>string</em>, default: "ui-page-active"):</dt>
<dd>The class assigned to page currently in view, and during transitions</dd>
<dt>activeBtnClass (<em>string</em>, default: "ui-page-active"):</dt>
<dd>The class used for "active" button state, from CSS framework.</dd>
<dt>ajaxLinksEnabled (<em>boolean</em>, default: true):</dt>
<dd>jQuery Mobile will automatically handle link clicks through Ajax, when possible.</dd>
<dt>ajaxFormsEnabled (<em>boolean</em>, default: true):</dt>
<dd>jQuery Mobile will automatically handle form submissions through Ajax, when possible.</dd>
<dt>transitions (<em>array</em>, default: ['slide', 'slideup', 'slidedown', 'pop', 'flip', 'fade']):</dt>
<dd>Available CSS transitions in the CSS.</dd>
<dt>defaultTransition (<em>string</em>, default: 'slide'):</dt>
<dd>Set the default transition for page changes that use Ajax. Set to 'none' for no transitions by default.</dd>
<dt>loadingMessage (<em>string</em>, default: "loading"):</dt>
<dd>Set the text that appears when a page is loading. If set to false, the message will not appear at all.</dd>
<dt>metaViewportContent (<em>string</em>, default: "width=device-width, minimum-scale=1, maximum-scale=1"):</dt>
<dd>Configure the auto-generated meta viewport tag's content attribute. If false, no meta tag will be appended to the DOM.</dd>
<dt>gradeA (<em>function that returns a boolean</em>, default: a function returning the value of $.support.mediaquery):</dt>
<dd>Any support conditions that must be met in order to proceed.</dd>
</dl>
</div><!-- /content -->
</div><!-- /page -->