Skip to content

Navigation: Clarify the circumstances of and data associated with pagebeforechange #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Navigation: Clarify the circumstances of and data associated with pagebeforechange #356

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
485fa86
Navigation: Clarify the circumstances of and data associated with pag…
Jan 29, 2015
888c694
Navigation: Touch up blurb
Feb 3, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion entries/pagebeforechange.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
<longdesc>
<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>
<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>
<p>During the handling of this event the browser's history has not yet changed.</p>
<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>

<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>
<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>
<p>Implicit navigation results in both <placeholder name="name"> events being triggered after the browser's navigation history has been updated.</p>
<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>
<ul>
<li><code>toPage</code> (object or string)
Expand Down