root / snf-cyclades-app / synnefo / ui / new_ui / ui / javascripts / jquery.scrollTo.js @ fc78f5b5
History | View | Annotate | Download (7.6 kB)
1 | 6f4b6de9 | Olga Brani | /*!
|
---|---|---|---|
2 | 6f4b6de9 | Olga Brani | * jQuery.ScrollTo
|
3 | 6f4b6de9 | Olga Brani | * Copyright (c) 2007-2013 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
|
4 | 6f4b6de9 | Olga Brani | * Dual licensed under MIT and GPL.
|
5 | 6f4b6de9 | Olga Brani | *
|
6 | 6f4b6de9 | Olga Brani | * @projectDescription Easy element scrolling using jQuery.
|
7 | 6f4b6de9 | Olga Brani | * http://flesler.blogspot.com/2007/10/jqueryscrollto.html
|
8 | 6f4b6de9 | Olga Brani | * @author Ariel Flesler
|
9 | 6f4b6de9 | Olga Brani | * @version 1.4.6
|
10 | 6f4b6de9 | Olga Brani | *
|
11 | 6f4b6de9 | Olga Brani | * @id jQuery.scrollTo
|
12 | 6f4b6de9 | Olga Brani | * @id jQuery.fn.scrollTo
|
13 | 6f4b6de9 | Olga Brani | * @param {String, Number, DOMElement, jQuery, Object} target Where to scroll the matched elements.
|
14 | 6f4b6de9 | Olga Brani | * The different options for target are:
|
15 | 6f4b6de9 | Olga Brani | * - A number position (will be applied to all axes).
|
16 | 6f4b6de9 | Olga Brani | * - A string position ('44', '100px', '+=90', etc ) will be applied to all axes
|
17 | 6f4b6de9 | Olga Brani | * - A jQuery/DOM element ( logically, child of the element to scroll )
|
18 | 6f4b6de9 | Olga Brani | * - A string selector, that will be relative to the element to scroll ( 'li:eq(2)', etc )
|
19 | 6f4b6de9 | Olga Brani | * - A hash { top:x, left:y }, x and y can be any kind of number/string like above.
|
20 | 6f4b6de9 | Olga Brani | * - A percentage of the container's dimension/s, for example: 50% to go to the middle.
|
21 | 6f4b6de9 | Olga Brani | * - The string 'max' for go-to-end.
|
22 | 6f4b6de9 | Olga Brani | * @param {Number, Function} duration The OVERALL length of the animation, this argument can be the settings object instead.
|
23 | 6f4b6de9 | Olga Brani | * @param {Object,Function} settings Optional set of settings or the onAfter callback.
|
24 | 6f4b6de9 | Olga Brani | * @option {String} axis Which axis must be scrolled, use 'x', 'y', 'xy' or 'yx'.
|
25 | 6f4b6de9 | Olga Brani | * @option {Number, Function} duration The OVERALL length of the animation.
|
26 | 6f4b6de9 | Olga Brani | * @option {String} easing The easing method for the animation.
|
27 | 6f4b6de9 | Olga Brani | * @option {Boolean} margin If true, the margin of the target element will be deducted from the final position.
|
28 | 6f4b6de9 | Olga Brani | * @option {Object, Number} offset Add/deduct from the end position. One number for both axes or { top:x, left:y }.
|
29 | 6f4b6de9 | Olga Brani | * @option {Object, Number} over Add/deduct the height/width multiplied by 'over', can be { top:x, left:y } when using both axes.
|
30 | 6f4b6de9 | Olga Brani | * @option {Boolean} queue If true, and both axis are given, the 2nd axis will only be animated after the first one ends.
|
31 | 6f4b6de9 | Olga Brani | * @option {Function} onAfter Function to be called after the scrolling ends.
|
32 | 6f4b6de9 | Olga Brani | * @option {Function} onAfterFirst If queuing is activated, this function will be called after the first scrolling ends.
|
33 | 6f4b6de9 | Olga Brani | * @return {jQuery} Returns the same jQuery object, for chaining.
|
34 | 6f4b6de9 | Olga Brani | *
|
35 | 6f4b6de9 | Olga Brani | * @desc Scroll to a fixed position
|
36 | 6f4b6de9 | Olga Brani | * @example $('div').scrollTo( 340 );
|
37 | 6f4b6de9 | Olga Brani | *
|
38 | 6f4b6de9 | Olga Brani | * @desc Scroll relatively to the actual position
|
39 | 6f4b6de9 | Olga Brani | * @example $('div').scrollTo( '+=340px', { axis:'y' } );
|
40 | 6f4b6de9 | Olga Brani | *
|
41 | 6f4b6de9 | Olga Brani | * @desc Scroll using a selector (relative to the scrolled element)
|
42 | 6f4b6de9 | Olga Brani | * @example $('div').scrollTo( 'p.paragraph:eq(2)', 500, { easing:'swing', queue:true, axis:'xy' } );
|
43 | 6f4b6de9 | Olga Brani | *
|
44 | 6f4b6de9 | Olga Brani | * @desc Scroll to a DOM element (same for jQuery object)
|
45 | 6f4b6de9 | Olga Brani | * @example var second_child = document.getElementById('container').firstChild.nextSibling;
|
46 | 6f4b6de9 | Olga Brani | * $('#container').scrollTo( second_child, { duration:500, axis:'x', onAfter:function(){
|
47 | 6f4b6de9 | Olga Brani | * alert('scrolled!!');
|
48 | 6f4b6de9 | Olga Brani | * }});
|
49 | 6f4b6de9 | Olga Brani | *
|
50 | 6f4b6de9 | Olga Brani | * @desc Scroll on both axes, to different values
|
51 | 6f4b6de9 | Olga Brani | * @example $('div').scrollTo( { top: 300, left:'+=200' }, { axis:'xy', offset:-20 } );
|
52 | 6f4b6de9 | Olga Brani | */
|
53 | 6f4b6de9 | Olga Brani | |
54 | 6f4b6de9 | Olga Brani | ;(function( $ ){ |
55 | 6f4b6de9 | Olga Brani | |
56 | 6f4b6de9 | Olga Brani | var $scrollTo = $.scrollTo = function( target, duration, settings ){ |
57 | 6f4b6de9 | Olga Brani | $(window).scrollTo( target, duration, settings );
|
58 | 6f4b6de9 | Olga Brani | }; |
59 | 6f4b6de9 | Olga Brani | |
60 | 6f4b6de9 | Olga Brani | $scrollTo.defaults = {
|
61 | 6f4b6de9 | Olga Brani | axis:'xy', |
62 | 6f4b6de9 | Olga Brani | duration: parseFloat($.fn.jquery) >= 1.3 ? 0 : 1, |
63 | 6f4b6de9 | Olga Brani | limit:true |
64 | 6f4b6de9 | Olga Brani | }; |
65 | 6f4b6de9 | Olga Brani | |
66 | 6f4b6de9 | Olga Brani | // Returns the element that needs to be animated to scroll the window.
|
67 | 6f4b6de9 | Olga Brani | // Kept for backwards compatibility (specially for localScroll & serialScroll)
|
68 | 6f4b6de9 | Olga Brani | $scrollTo.window = function( scope ){ |
69 | 6f4b6de9 | Olga Brani | return $(window)._scrollable(); |
70 | 6f4b6de9 | Olga Brani | }; |
71 | 6f4b6de9 | Olga Brani | |
72 | 6f4b6de9 | Olga Brani | // Hack, hack, hack :)
|
73 | 6f4b6de9 | Olga Brani | // Returns the real elements to scroll (supports window/iframes, documents and regular nodes)
|
74 | 6f4b6de9 | Olga Brani | $.fn._scrollable = function(){ |
75 | 6f4b6de9 | Olga Brani | return this.map(function(){ |
76 | 6f4b6de9 | Olga Brani | var elem = this, |
77 | 6f4b6de9 | Olga Brani | isWin = !elem.nodeName || $.inArray( elem.nodeName.toLowerCase(), ['iframe','#document','html','body'] ) != -1; |
78 | 6f4b6de9 | Olga Brani | |
79 | 6f4b6de9 | Olga Brani | if( !isWin )
|
80 | 6f4b6de9 | Olga Brani | return elem;
|
81 | 6f4b6de9 | Olga Brani | |
82 | 6f4b6de9 | Olga Brani | var doc = (elem.contentWindow || elem).document || elem.ownerDocument || elem;
|
83 | 6f4b6de9 | Olga Brani | |
84 | 6f4b6de9 | Olga Brani | return /webkit/i.test(navigator.userAgent) || doc.compatMode == 'BackCompat' ? |
85 | 6f4b6de9 | Olga Brani | doc.body : |
86 | 6f4b6de9 | Olga Brani | doc.documentElement; |
87 | 6f4b6de9 | Olga Brani | }); |
88 | 6f4b6de9 | Olga Brani | }; |
89 | 6f4b6de9 | Olga Brani | |
90 | 6f4b6de9 | Olga Brani | $.fn.scrollTo = function( target, duration, settings ){ |
91 | 6f4b6de9 | Olga Brani | if( typeof duration == 'object' ){ |
92 | 6f4b6de9 | Olga Brani | settings = duration; |
93 | 6f4b6de9 | Olga Brani | duration = 0;
|
94 | 6f4b6de9 | Olga Brani | } |
95 | 6f4b6de9 | Olga Brani | if( typeof settings == 'function' ) |
96 | 6f4b6de9 | Olga Brani | settings = { onAfter:settings };
|
97 | 6f4b6de9 | Olga Brani | |
98 | 6f4b6de9 | Olga Brani | if( target == 'max' ) |
99 | 6f4b6de9 | Olga Brani | target = 9e9;
|
100 | 6f4b6de9 | Olga Brani | |
101 | 6f4b6de9 | Olga Brani | settings = $.extend( {}, $scrollTo.defaults, settings ); |
102 | 6f4b6de9 | Olga Brani | // Speed is still recognized for backwards compatibility
|
103 | 6f4b6de9 | Olga Brani | duration = duration || settings.duration; |
104 | 6f4b6de9 | Olga Brani | // Make sure the settings are given right
|
105 | 6f4b6de9 | Olga Brani | settings.queue = settings.queue && settings.axis.length > 1;
|
106 | 6f4b6de9 | Olga Brani | |
107 | 6f4b6de9 | Olga Brani | if( settings.queue )
|
108 | 6f4b6de9 | Olga Brani | // Let's keep the overall duration
|
109 | 6f4b6de9 | Olga Brani | duration /= 2;
|
110 | 6f4b6de9 | Olga Brani | settings.offset = both( settings.offset ); |
111 | 6f4b6de9 | Olga Brani | settings.over = both( settings.over ); |
112 | 6f4b6de9 | Olga Brani | |
113 | 6f4b6de9 | Olga Brani | return this._scrollable().each(function(){ |
114 | 6f4b6de9 | Olga Brani | // Null target yields nothing, just like jQuery does
|
115 | 6f4b6de9 | Olga Brani | if (target == null) return; |
116 | 6f4b6de9 | Olga Brani | |
117 | 6f4b6de9 | Olga Brani | var elem = this, |
118 | 6f4b6de9 | Olga Brani | $elem = $(elem), |
119 | 6f4b6de9 | Olga Brani | targ = target, toff, attr = {}, |
120 | 6f4b6de9 | Olga Brani | win = $elem.is('html,body'); |
121 | 6f4b6de9 | Olga Brani | |
122 | 6f4b6de9 | Olga Brani | switch( typeof targ ){ |
123 | 6f4b6de9 | Olga Brani | // A number will pass the regex
|
124 | 6f4b6de9 | Olga Brani | case 'number': |
125 | 6f4b6de9 | Olga Brani | case 'string': |
126 | 6f4b6de9 | Olga Brani | if( /^([+-]=?)?\d+(\.\d+)?(px|%)?$/.test(targ) ){ |
127 | 6f4b6de9 | Olga Brani | targ = both( targ ); |
128 | 6f4b6de9 | Olga Brani | // We are done
|
129 | 6f4b6de9 | Olga Brani | break;
|
130 | 6f4b6de9 | Olga Brani | } |
131 | 6f4b6de9 | Olga Brani | // Relative selector, no break!
|
132 | 6f4b6de9 | Olga Brani | targ = $(targ,this); |
133 | 6f4b6de9 | Olga Brani | if (!targ.length) return; |
134 | 6f4b6de9 | Olga Brani | case 'object': |
135 | 6f4b6de9 | Olga Brani | // DOMElement / jQuery
|
136 | 6f4b6de9 | Olga Brani | if( targ.is || targ.style )
|
137 | 6f4b6de9 | Olga Brani | // Get the real position of the target
|
138 | 6f4b6de9 | Olga Brani | toff = (targ = $(targ)).offset();
|
139 | 6f4b6de9 | Olga Brani | } |
140 | 6f4b6de9 | Olga Brani | $.each( settings.axis.split(''), function( i, axis ){ |
141 | 6f4b6de9 | Olga Brani | var Pos = axis == 'x' ? 'Left' : 'Top', |
142 | 6f4b6de9 | Olga Brani | pos = Pos.toLowerCase(), |
143 | 6f4b6de9 | Olga Brani | key = 'scroll' + Pos,
|
144 | 6f4b6de9 | Olga Brani | old = elem[key], |
145 | 6f4b6de9 | Olga Brani | max = $scrollTo.max(elem, axis);
|
146 | 6f4b6de9 | Olga Brani | |
147 | 6f4b6de9 | Olga Brani | if( toff ){// jQuery / DOMElement |
148 | 6f4b6de9 | Olga Brani | attr[key] = toff[pos] + ( win ? 0 : old - $elem.offset()[pos] ); |
149 | 6f4b6de9 | Olga Brani | |
150 | 6f4b6de9 | Olga Brani | // If it's a dom element, reduce the margin
|
151 | 6f4b6de9 | Olga Brani | if( settings.margin ){
|
152 | 6f4b6de9 | Olga Brani | attr[key] -= parseInt(targ.css('margin'+Pos)) || 0; |
153 | 6f4b6de9 | Olga Brani | attr[key] -= parseInt(targ.css('border'+Pos+'Width')) || 0; |
154 | 6f4b6de9 | Olga Brani | } |
155 | 6f4b6de9 | Olga Brani | |
156 | 6f4b6de9 | Olga Brani | attr[key] += settings.offset[pos] || 0;
|
157 | 6f4b6de9 | Olga Brani | |
158 | 6f4b6de9 | Olga Brani | if( settings.over[pos] )
|
159 | 6f4b6de9 | Olga Brani | // Scroll to a fraction of its width/height
|
160 | 6f4b6de9 | Olga Brani | attr[key] += targ[axis=='x'?'width':'height']() * settings.over[pos]; |
161 | 6f4b6de9 | Olga Brani | }else{
|
162 | 6f4b6de9 | Olga Brani | var val = targ[pos];
|
163 | 6f4b6de9 | Olga Brani | // Handle percentage values
|
164 | 6f4b6de9 | Olga Brani | attr[key] = val.slice && val.slice(-1) == '%' ? |
165 | 6f4b6de9 | Olga Brani | parseFloat(val) / 100 * max
|
166 | 6f4b6de9 | Olga Brani | : val; |
167 | 6f4b6de9 | Olga Brani | } |
168 | 6f4b6de9 | Olga Brani | |
169 | 6f4b6de9 | Olga Brani | // Number or 'number'
|
170 | 6f4b6de9 | Olga Brani | if( settings.limit && /^\d+$/.test(attr[key]) ) |
171 | 6f4b6de9 | Olga Brani | // Check the limits
|
172 | 6f4b6de9 | Olga Brani | attr[key] = attr[key] <= 0 ? 0 : Math.min( attr[key], max ); |
173 | 6f4b6de9 | Olga Brani | |
174 | 6f4b6de9 | Olga Brani | // Queueing axes
|
175 | 6f4b6de9 | Olga Brani | if( !i && settings.queue ){
|
176 | 6f4b6de9 | Olga Brani | // Don't waste time animating, if there's no need.
|
177 | 6f4b6de9 | Olga Brani | if( old != attr[key] )
|
178 | 6f4b6de9 | Olga Brani | // Intermediate animation
|
179 | 6f4b6de9 | Olga Brani | animate( settings.onAfterFirst ); |
180 | 6f4b6de9 | Olga Brani | // Don't animate this axis again in the next iteration.
|
181 | 6f4b6de9 | Olga Brani | delete attr[key];
|
182 | 6f4b6de9 | Olga Brani | } |
183 | 6f4b6de9 | Olga Brani | }); |
184 | 6f4b6de9 | Olga Brani | |
185 | 6f4b6de9 | Olga Brani | animate( settings.onAfter ); |
186 | 6f4b6de9 | Olga Brani | |
187 | 6f4b6de9 | Olga Brani | function animate( callback ){ |
188 | 6f4b6de9 | Olga Brani | $elem.animate( attr, duration, settings.easing, callback && function(){ |
189 | 6f4b6de9 | Olga Brani | callback.call(this, targ, settings);
|
190 | 6f4b6de9 | Olga Brani | }); |
191 | 6f4b6de9 | Olga Brani | }; |
192 | 6f4b6de9 | Olga Brani | |
193 | 6f4b6de9 | Olga Brani | }).end(); |
194 | 6f4b6de9 | Olga Brani | }; |
195 | 6f4b6de9 | Olga Brani | |
196 | 6f4b6de9 | Olga Brani | // Max scrolling position, works on quirks mode
|
197 | 6f4b6de9 | Olga Brani | // It only fails (not too badly) on IE, quirks mode.
|
198 | 6f4b6de9 | Olga Brani | $scrollTo.max = function( elem, axis ){ |
199 | 6f4b6de9 | Olga Brani | var Dim = axis == 'x' ? 'Width' : 'Height', |
200 | 6f4b6de9 | Olga Brani | scroll = 'scroll'+Dim;
|
201 | 6f4b6de9 | Olga Brani | |
202 | 6f4b6de9 | Olga Brani | if( !$(elem).is('html,body') ) |
203 | 6f4b6de9 | Olga Brani | return elem[scroll] - $(elem)[Dim.toLowerCase()](); |
204 | 6f4b6de9 | Olga Brani | |
205 | 6f4b6de9 | Olga Brani | var size = 'client' + Dim, |
206 | 6f4b6de9 | Olga Brani | html = elem.ownerDocument.documentElement, |
207 | 6f4b6de9 | Olga Brani | body = elem.ownerDocument.body; |
208 | 6f4b6de9 | Olga Brani | |
209 | 6f4b6de9 | Olga Brani | return Math.max( html[scroll], body[scroll] )
|
210 | 6f4b6de9 | Olga Brani | - Math.min( html[size] , body[size] ); |
211 | 6f4b6de9 | Olga Brani | }; |
212 | 6f4b6de9 | Olga Brani | |
213 | 6f4b6de9 | Olga Brani | function both( val ){ |
214 | 6f4b6de9 | Olga Brani | return typeof val == 'object' ? val : { top:val, left:val }; |
215 | 6f4b6de9 | Olga Brani | }; |
216 | 6f4b6de9 | Olga Brani | |
217 | 6f4b6de9 | Olga Brani | })( jQuery ); |