Skip to content

Commit 453be66

Browse files
author
Gabriel Schulhof
committed
Navigation: Clarify the circumstances of and data associated with pagebeforechange
Fixes gh-355 Closes gh-356
1 parent 57314ba commit 453be66

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

entries/pagebeforechange.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
<longdesc>
66
<p>When received with <code>data.toPage</code> set to a string, the event indicates that navigation is about to commence. The value stored in <code>data.toPage</code> is the URL of the page that will be loaded.</p>
77
<p>When received with <code>data.toPage</code> set to a jQuery object, the event indicates that the destination page has been loaded and navigation will continue.</p>
8-
<p>During the handling of this event the browser's history has not yet changed.</p>
8+
<p>If the page change cycle was initiated programmatically, and, instead of a URL a jQuery object containing a page was given, then the event will be triggered both times with <code>data.toPage</code> set to the jQuery object containing the destination page.</p>
9+
10+
<p>The <placeholder name="name"> event is triggered either by explicit navigation on the part of the user (e.g. by clicking on a link or by running code that results in a call to the pagecontainer <code>change()</code> method), or by implicit navigation caused by the user clicking the browser's "Back" or "Forward" buttons.</p>
11+
<p>Explicit navigation results in both <placeholder name="name"> events being triggered before a new entry is added to the browser's navigation history.</p>
12+
<p>Implicit navigation results in both <placeholder name="name"> events being triggered after the browser's navigation history has been updated.</p>
913
<p>In addition to the <code>event</code> parameter, handlers of this event will receive a second parameter, <code>data</code>. The second parameter is an object containing the following properties:</p>
1014
<ul>
1115
<li><code>toPage</code> (object or string)

0 commit comments

Comments
 (0)