Skip to content

Commit 2ad84df

Browse files
Docs (config): added getMaxScrollForTransition.
1 parent c628749 commit 2ad84df

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/api/globalconfig.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ <h2>Configurable options</h2>
100100
<dt><code>defaultPageTransition</code> <em>string</em>, default: 'fade'</dt>
101101
<dd>Set the default transition for page changes that use Ajax. Note: default changed from 'slide' to 'fade' in 1.1. Set to 'none' for no transitions.</dd>
102102

103+
<dt><code>getMaxScrollForTransition</code> <em>integer</em>, default: 3</dt>
104+
<dd>Set a scroll position breakpoint for transitions. If the scroll position is greater than the window height multiplied by the value that has been set, transition "none" will be used.</dd>
105+
103106
<dt><code>gradeA</code> <em>function that returns a boolean</em>, default: a function returning the value of $.support.mediaquery</dt>
104107
<dd>Any support conditions that must be met in order to proceed.</dd>
105108

@@ -130,7 +133,7 @@ <h2>Configurable options</h2>
130133
<p class="ui-body ui-body-e"><strong>Deprecated</strong> in 1.2 - use <code>$.mobile.loader.prototype.options.theme</code> instead. See the <a href="../../docs/pages/loader.html">loader docs</a> for more.</p>
131134
</dd>
132135

133-
<dt><code>maxTransitionWidth</code> <em>string, boolean</em>, default: false</dt>
136+
<dt><code>maxTransitionWidth</code> <em>integer, boolean</em>, default: false</dt>
134137
<dd>Set a max width for transitions. The option accepts any number representing a pixel width and its default value <code>false</code>. If a number value is set, transition "none" will be used if the window is wider than the specified value.</dd>
135138

136139
<dt><code>minScrollBack</code> <em>integer</em>, default: 250</dt>

0 commit comments

Comments
 (0)