Hopiu/jquery-mobile
1
0
Fork 0
mirror of https://github.com/Hopiu/jquery-mobile.git synced 2026-03-17 14:30:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
jquery-mobile/docs/api/methods.html

172 lines
6.2 KiB
HTML
Raw Normal View History

added methods documentation
2010-11-11 21:12:14 +00:00
<!DOCTYPE html>
<html>
<head>
Added viewport meta elements to the markup of every template and removed the metaViewportContent option from code and docs. IE does not support generated viewport tags.
2011-02-18 20:00:18 +00:00
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, minimum-scale=1, maximum-scale=1">
added methods documentation
2010-11-11 21:12:14 +00:00
<title>jQuery Mobile Docs - Methods</title>
Sweep through all files to add a trailing slash to <link> tags that include thems/default. This should fix Opera Mobile Issue 763.
2011-01-06 00:19:24 +00:00
<link rel="stylesheet" href="../../themes/default/" />
added methods documentation
2010-11-11 21:12:14 +00:00
<link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
Removed jquery.js from js/index.php and updated all html doc/experiments/test files that incuded "js/" so that they also include jquery.js manually. This makes our include model match the include model on the CDN, and allows devs to make use of mobileinit for debugging some of the samples since that must be set up after jquery.js, but before jquery-mobile.
2011-01-20 19:26:12 +00:00
<script type="text/javascript" src="../../js/jquery.js"></script>
added methods documentation
2010-11-11 21:12:14 +00:00
<script type="text/javascript" src="../../js/"></script>
</head>
<body>
Added a home link to all pages and changed the header bar theme swatch to b globally
2011-02-03 22:29:48 +00:00
<div data-role="page" data-theme="b">
added methods documentation
2010-11-11 21:12:14 +00:00
<div data-role="header">
<h1>Methods</h1>
home button fixes
2011-02-03 23:34:35 +00:00
<a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse" class="ui-btn-right jqm-home">Home</a>
added methods documentation
2010-11-11 21:12:14 +00:00
</div><!-- /header -->
<div data-role="content">
<p>jQuery Mobile exposes several methods and properties on the $.mobile object for use in your applications.</p>
<dl>
<dt><code>$.mobile.changePage</code> (<em>method</em>)</dt>
<dd>Programmatically change from one page to another. This method is used internally for transitions that occur as a result of clicking a link or submitting a form, when those features are enabled.</dd>
<dd>
<dl>
<dt>Arguments</dt>
<dd><code>to</code>
<ul>
<li>String, url to transition to (<code>"about/us.html"</code>)</li>
<li>jQuery object (<code>$("#about")</code>)</li>
<li>Array specifying two page references [from,to] for transitioning from a known page. From is otherwise assumed to be the current page in view (or $.mobile.activePage ).</li>
<li>Object for sending form data. (<code>{to: url, data: serialized form data, type: "get" or "post"}</code></li>
close the ul
2010-11-11 21:13:30 +00:00
</ul>
added methods documentation
2010-11-11 21:12:14 +00:00
</dd>
<dd><code>transition</code> (<em>string</em>, examples: "pop", "slide"," "none")</dd>
Refactored urlStack and updated dialog and page plugins to match. jQuery Mobile's internal history now attempts to follow the history menu when urls change from hashchange, even for changes that go multiple steps forward or back. The internal history stack is now pruned based on whether a user goes back and then changes direction, whereas before a back-button click would result in a pop off the history. Instead we now maintain an active index number in the history stack, which allows us to maintain references to transitions that are saved on pages reached through clicking the forward button as well. This fixes #636. In the process, some other small changes should be noted: urlStack is now urlHistory, a hash of methods and properties used for history stack management (stack, activeIndex, getActive, getPrev, getNext, addNew, clearForward, and listening Enabled). All these are documented inline and exposed on $.mobile.urlHistory (I'm not sure these will be publicly documented, but just exposed internally for plugins for now). $.changePage has two argument changes: the "back" argument is now called "reverse"; this results in no change from an end-user standpoint, but reflects the fact that it only reverses the direction of a transition without affecting the internal history stack, and second, a new argument at the end defines whether changePage was called from a hashChange which makes that url open to history menu guessing.
2011-01-23 22:33:36 +00:00
<dd><code>reverse</code> (<em>boolean</em>, default: false). True will cause a reverse-direction transition.</dd>
added methods documentation
2010-11-11 21:12:14 +00:00
<dd><code>changeHash</code> (<em>boolean</em>, default: true). Update the hash to the to page's URL when page change is complete.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
typo
2010-11-11 21:16:05 +00:00
<strong>//transition to the "about us" page with a slideup transition</strong>
added methods documentation
2010-11-11 21:12:14 +00:00
$.mobile.changePage("about/us.html", "slideup");
<strong>//transition to the "search results" page, using data from a form with an ID of "search"" </strong>
$.mobile.changePage({
url: "searchresults.php",
type: "get",
data: $("form#search").serialize()
});
<strong>//transition to the "confirm" page with a "pop" transition without tracking it in history </strong>
$.mobile.changePage("../alerts/confirm.html", "pop", false, false);
</code>
</pre>
</dd>
documented the new jqmData method and :jqmData selector.
2011-03-26 13:11:42 +00:00
major simplification of jqmData method, while adding new methods for jqmRemoveData, and also their $-namepaced utility methods, including $.jqmHasData. Commit includes 20 new unit tests included to test compatibility with jQuery core's data methods, and docs are updated as well.
2011-03-26 18:14:02 +00:00
<dt><code>jqmData(), jqmRemoveData(), and jqmHasData()</code> (<em>method</em>)</dt>
<dd>When working with jQuery Mobile, <code>jqmData</code> and <code>jqmRemoveData</code> should be used in place of jQuery core's <code>data</code> and <code>removeData</code> methods (note that this includes $.fn.data, $.fn.removeData, and the $.data, $.removeData, and $.hasData utilities), as they automatically incorporate getting and setting of namespaced data attributes (even if no namespace is currently in use).</dd>
documented the new jqmData method and :jqmData selector.
2011-03-26 13:11:42 +00:00
<dd>
<dl>
<dt>Arguments:</dt>
major simplification of jqmData method, while adding new methods for jqmRemoveData, and also their $-namepaced utility methods, including $.jqmHasData. Commit includes 20 new unit tests included to test compatibility with jQuery core's data methods, and docs are updated as well.
2011-03-26 18:14:02 +00:00
<dd>See jQuery's <a href="http://api.jquery.com/jQuery.data/">data</a> and <a href="http://api.jquery.com/jQuery.removeData/">removeData</a> methods</dd>
documented the new jqmData method and :jqmData selector.
2011-03-26 13:11:42 +00:00
<dt>Also:</dt>
<dd>When finding elements by their jQuery Mobile data attribute, please use the custom selector <code>:jqmData()</code>, as it automatically incorporates namespaced data attributes into the lookup when they are in use. For example, instead of calling <code>$("div[data-role='page']")</code>, you should use <code>$("div:jqmData(role='page')")</code>, which internally maps to <code>$("div[data-"+ $.mobile.ns +"role='page']")</code> without forcing you to concatenate a namespace into your selectors manually.</dd>
</dl>
</dd>
added methods documentation
2010-11-11 21:12:14 +00:00
<dt><code>$.mobile.pageLoading</code> (<em>method</em>)</dt>
<dd>Show or hide the page loading message, which is configurable via $.mobile.loadingMessage.</dd>
<dd>
<dl>
<dt>Arguments:</dt>
<dd><code>Done</code> (<em>boolean</em>, defaults to false, meaning loading has started). True will hide the loading message.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>//cue the page loader</strong>
$.mobile.pageLoading();
<strong>//hide the page loader</strong>
$.mobile.pageLoading( true );
</code>
</pre>
</dd>
Overhauled path object and exposed it and the base object via $.mobile. Form and Link handlers now use the path methods internally. Unit tests adjusted, but more are needed to fully cover the path and base propeties and methods. Fixes #566.
2011-01-22 22:42:07 +00:00
<dt><code>$.mobile.path</code> (<em>methods, properties</em>)</dt>
<dd>Utilities for getting, setting, and manipulating url paths. TODO: document as public API is finalized.</dd>
<dt><code>$.mobile.base</code> (<em>methods, properties</em>)</dt>
<dd>Utilities for working with generated base element. TODO: document as public API is finalized.</dd>
added methods documentation
2010-11-11 21:12:14 +00:00
<dt><code>$.mobile.silentScroll</code> (<em>method</em>)</dt>
<dd>Scroll to a particular Y position without triggering scroll event listeners.</dd>
<dd>
<dl>
<dt>Arguments:</dt>
<dd><code>yPos</code> (<em>number</em>, defaults to 0). Pass any number to scroll to that Y location.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>//scroll to Y 100px</strong>
$.mobile.silentScroll(100);
</code>
</pre>
</dd>
<dt><code>$.mobile.addResolutionBreakpoints</code> (<em>method</em>)</dt>
<dd>Add width breakpoints to the min/max width classes that are added to the HTML element.</dd>
<dd>
<dl>
<dt>Arguments:</dt>
<dd><code>values</code> (<em>number or array</em>). Pass any number or array of numbers to add to the resolution classes. Read more about this feature here: <a href="mediahelpers.html">Orientation &amp; resolution targeting</a>.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
fixed a docs typo
2010-11-19 03:56:40 +00:00
<strong>//add a 400px breakpoint</strong>
$.mobile.addResolutionBreakpoints(400);
<strong>//add 2 more breakpoints</strong>
$.mobile.addResolutionBreakpoints([600,800]);
added methods documentation
2010-11-11 21:12:14 +00:00
</code>
</pre>
</dd>
<dt><code>$.mobile.activePage</code> (<em>property</em>)</dt>
<dd>Reference to the page currently in view.</dd>
</dl>
</div><!-- /content -->
</div><!-- /page -->
</body>
</html>
Reference in a new issue Copy permalink