jquery-mobile/docs/api/methods.html at transitions · jnlin/jquery-mobile · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8" />
	<title>jQuery Mobile Docs - Methods</title>
	<link rel="stylesheet"  href="../../themes/default/" />
	<link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
	<script type="text/javascript" src="../../js/jquery.js"></script>
	<script type="text/javascript" src="../../js/"></script>
</head>
<body>

<div data-role="page">

	<div data-role="header">
		<h1>Methods</h1>
	</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>
						</ul>
						</dd>

					<dd><code>transition</code> (<em>string</em>, examples: "pop", "slide"," "none")</dd>
					<dd><code>reverse</code> (<em>boolean</em>, default: false). True will cause a reverse-direction transition.</dd>
					<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>
<strong>//transition to the "about us" page with a slideup transition</strong>
$.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>

			<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>


			<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>


			<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>
<strong>//add a 400px breakpoint</strong>
$.mobile.addResolutionBreakpoints(400);
<strong>//add 2 more breakpoints</strong>
$.mobile.addResolutionBreakpoints([600,800]);
			</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>