Skip to content

Commit be238d9

Browse files
author
Gabriel Schulhof
committed
Global: Improve getMaxScrollForTransition definition and usage docs
Fixes gh-274
1 parent 4f0225f commit be238d9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pages/global-config.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ <h2>Configurable options</h2>
131131
<dt id="focusClass"><code>focusClass</code> <em>string</em>, default: "ui-focus"</dt>
132132
<dd>The CSS class used for "active" button state.<div style="padding: 0.5em 1em; margin: 1em; background: #FFF3A5;"><strong>Deprecated</strong> in 1.4 and will be removed in 1.5. The class "ui-focus" will continue to be applied to elements as before.</div></dd>
133133
<br />
134-
<dt id="getMaxScrollForTransition"><code>getMaxScrollForTransition</code> <em>integer</em>, default: 3</dt>
135-
<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>
134+
<dt id="getMaxScrollForTransition"><code>getMaxScrollForTransition</code> <em>function</em></dt>
135+
<dd>Set a scroll position breakpoint for transitions. If the scroll position is greater than the value returned by this function, transition "none" will be used. The default function returns three times the window height.</dd>
136136
<br />
137137
<dt id="gradeA"><code>gradeA</code> <em>function that returns a boolean</em>, default: a function returning the value of $.support.mediaquery</dt>
138138
<dd>Any support conditions that must be met in order to proceed.</dd>

0 commit comments

Comments
 (0)