jquery.scrollTo.js 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  1. /*!
  2. * jQuery.ScrollTo
  3. * Copyright (c) 2007-2014 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
  4. * Licensed under MIT
  5. * http://flesler.blogspot.com/2007/10/jqueryscrollto.html
  6. * @projectDescription Easy element scrolling using jQuery.
  7. * @author Ariel Flesler
  8. * @version 1.4.12
  9. */
  10. ;(function(plugin) {
  11. // AMD Support
  12. if (typeof define === 'function' && define.amd) {
  13. define(['jquery'], plugin);
  14. } else {
  15. plugin(jQuery);
  16. }
  17. }(function($) {
  18. var $scrollTo = $.scrollTo = function( target, duration, settings ) {
  19. return $(window).scrollTo( target, duration, settings );
  20. };
  21. $scrollTo.defaults = {
  22. axis:'xy',
  23. duration: parseFloat($.fn.jquery) >= 1.3 ? 0 : 1,
  24. limit:true
  25. };
  26. // Returns the element that needs to be animated to scroll the window.
  27. // Kept for backwards compatibility (specially for localScroll & serialScroll)
  28. $scrollTo.window = function( scope ) {
  29. return $(window)._scrollable();
  30. };
  31. // Hack, hack, hack :)
  32. // Returns the real elements to scroll (supports window/iframes, documents and regular nodes)
  33. $.fn._scrollable = function() {
  34. return this.map(function() {
  35. var elem = this,
  36. isWin = !elem.nodeName || $.inArray( elem.nodeName.toLowerCase(), ['iframe','#document','html','body'] ) != -1;
  37. if (!isWin)
  38. return elem;
  39. var doc = (elem.contentWindow || elem).document || elem.ownerDocument || elem;
  40. return /webkit/i.test(navigator.userAgent) || doc.compatMode == 'BackCompat' ?
  41. doc.body :
  42. doc.documentElement;
  43. });
  44. };
  45. $.fn.scrollTo = function( target, duration, settings ) {
  46. if (typeof duration == 'object') {
  47. settings = duration;
  48. duration = 0;
  49. }
  50. if (typeof settings == 'function')
  51. settings = { onAfter:settings };
  52. if (target == 'max')
  53. target = 9e9;
  54. settings = $.extend( {}, $scrollTo.defaults, settings );
  55. // Speed is still recognized for backwards compatibility
  56. duration = duration || settings.duration;
  57. // Make sure the settings are given right
  58. settings.queue = settings.queue && settings.axis.length > 1;
  59. if (settings.queue)
  60. // Let's keep the overall duration
  61. duration /= 2;
  62. settings.offset = both( settings.offset );
  63. settings.over = both( settings.over );
  64. return this._scrollable().each(function() {
  65. // Null target yields nothing, just like jQuery does
  66. if (target == null) return;
  67. var elem = this,
  68. $elem = $(elem),
  69. targ = target, toff, attr = {},
  70. win = $elem.is('html,body');
  71. switch (typeof targ) {
  72. // A number will pass the regex
  73. case 'number':
  74. case 'string':
  75. if (/^([+-]=?)?\d+(\.\d+)?(px|%)?$/.test(targ)) {
  76. targ = both( targ );
  77. // We are done
  78. break;
  79. }
  80. // Relative/Absolute selector, no break!
  81. targ = win ? $(targ) : $(targ, this);
  82. if (!targ.length) return;
  83. case 'object':
  84. // DOMElement / jQuery
  85. if (targ.is || targ.style)
  86. // Get the real position of the target
  87. toff = (targ = $(targ)).offset();
  88. }
  89. var offset = $.isFunction(settings.offset) && settings.offset(elem, targ) || settings.offset;
  90. $.each( settings.axis.split(''), function( i, axis ) {
  91. var Pos = axis == 'x' ? 'Left' : 'Top',
  92. pos = Pos.toLowerCase(),
  93. key = 'scroll' + Pos,
  94. old = elem[key],
  95. max = $scrollTo.max(elem, axis);
  96. if (toff) {// jQuery / DOMElement
  97. attr[key] = toff[pos] + ( win ? 0 : old - $elem.offset()[pos] );
  98. // If it's a dom element, reduce the margin
  99. if (settings.margin) {
  100. attr[key] -= parseInt(targ.css('margin'+Pos)) || 0;
  101. attr[key] -= parseInt(targ.css('border'+Pos+'Width')) || 0;
  102. }
  103. attr[key] += offset[pos] || 0;
  104. if(settings.over[pos])
  105. // Scroll to a fraction of its width/height
  106. attr[key] += targ[axis=='x'?'width':'height']() * settings.over[pos];
  107. } else {
  108. var val = targ[pos];
  109. // Handle percentage values
  110. attr[key] = val.slice && val.slice(-1) == '%' ?
  111. parseFloat(val) / 100 * max
  112. : val;
  113. }
  114. // Number or 'number'
  115. if (settings.limit && /^\d+$/.test(attr[key]))
  116. // Check the limits
  117. attr[key] = attr[key] <= 0 ? 0 : Math.min( attr[key], max );
  118. // Queueing axes
  119. if (!i && settings.queue) {
  120. // Don't waste time animating, if there's no need.
  121. if (old != attr[key])
  122. // Intermediate animation
  123. animate( settings.onAfterFirst );
  124. // Don't animate this axis again in the next iteration.
  125. delete attr[key];
  126. }
  127. });
  128. animate( settings.onAfter );
  129. function animate( callback ) {
  130. $elem.animate( attr, duration, settings.easing, callback && function() {
  131. callback.call(this, targ, settings);
  132. });
  133. };
  134. }).end();
  135. };
  136. // Max scrolling position, works on quirks mode
  137. // It only fails (not too badly) on IE, quirks mode.
  138. $scrollTo.max = function( elem, axis ) {
  139. var Dim = axis == 'x' ? 'Width' : 'Height',
  140. scroll = 'scroll'+Dim;
  141. if (!$(elem).is('html,body'))
  142. return elem[scroll] - $(elem)[Dim.toLowerCase()]();
  143. var size = 'client' + Dim,
  144. html = elem.ownerDocument.documentElement,
  145. body = elem.ownerDocument.body;
  146. return Math.max( html[scroll], body[scroll] )
  147. - Math.min( html[size] , body[size] );
  148. };
  149. function both( val ) {
  150. return $.isFunction(val) || typeof val == 'object' ? val : { top:val, left:val };
  151. };
  152. // AMD requirement
  153. return $scrollTo;
  154. }));