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