jquery.slimscroll.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  1. /*! Copyright (c) 2011 Piotr Rochala (http://rocha.la)
  2. * Dual licensed under the MIT (http://www.opensource.org/licenses/mit-license.php)
  3. * and GPL (http://www.opensource.org/licenses/gpl-license.php) licenses.
  4. *
  5. * Version: 1.3.0
  6. *
  7. */
  8. (function($) {
  9. jQuery.fn.extend({
  10. slimScroll: function(options) {
  11. var defaults = {
  12. // width in pixels of the visible scroll area
  13. width : 'auto',
  14. // height in pixels of the visible scroll area
  15. height : '250px',
  16. // width in pixels of the scrollbar and rail
  17. size : '7px',
  18. // scrollbar color, accepts any hex/color value
  19. color: '#000',
  20. // scrollbar position - left/right
  21. position : 'right',
  22. // distance in pixels between the side edge and the scrollbar
  23. distance : '1px',
  24. // default scroll position on load - top / bottom / $('selector')
  25. start : 'top',
  26. // sets scrollbar opacity
  27. opacity : .4,
  28. // enables always-on mode for the scrollbar
  29. alwaysVisible : false,
  30. // check if we should hide the scrollbar when user is hovering over
  31. disableFadeOut : false,
  32. // sets visibility of the rail
  33. railVisible : false,
  34. // sets rail color
  35. railColor : '#333',
  36. // sets rail opacity
  37. railOpacity : .2,
  38. // whether we should use jQuery UI Draggable to enable bar dragging
  39. railDraggable : true,
  40. // defautlt CSS class of the slimscroll rail
  41. railClass : 'slimScrollRail',
  42. // defautlt CSS class of the slimscroll bar
  43. barClass : 'slimScrollBar',
  44. // defautlt CSS class of the slimscroll wrapper
  45. wrapperClass : 'slimScrollDiv',
  46. // check if mousewheel should scroll the window if we reach top/bottom
  47. allowPageScroll : false,
  48. // scroll amount applied to each mouse wheel step
  49. wheelStep : 20,
  50. // scroll amount applied when user is using gestures
  51. touchScrollStep : 200,
  52. // sets border radius
  53. borderRadius: '7px',
  54. // sets border radius of the rail
  55. railBorderRadius : '7px'
  56. };
  57. var o = $.extend(defaults, options);
  58. // do it for every element that matches selector
  59. this.each(function(){
  60. var isOverPanel, isOverBar, isDragg, queueHide, touchDif,
  61. barHeight, percentScroll, lastScroll,
  62. divS = '<div></div>',
  63. minBarHeight = 30,
  64. releaseScroll = false;
  65. // used in event handlers and for better minification
  66. var me = $(this);
  67. // ensure we are not binding it again
  68. if (me.parent().hasClass(o.wrapperClass))
  69. {
  70. // start from last bar position
  71. var offset = me.scrollTop();
  72. // find bar and rail
  73. bar = me.parent().find('.' + o.barClass);
  74. rail = me.parent().find('.' + o.railClass);
  75. getBarHeight();
  76. // check if we should scroll existing instance
  77. if ($.isPlainObject(options))
  78. {
  79. // Pass height: auto to an existing slimscroll object to force a resize after contents have changed
  80. if ( 'height' in options && options.height == 'auto' ) {
  81. me.parent().css('height', 'auto');
  82. me.css('height', 'auto');
  83. var height = me.parent().parent().height();
  84. me.parent().css('height', height);
  85. me.css('height', height);
  86. }
  87. if ('scrollTo' in options)
  88. {
  89. // jump to a static point
  90. offset = parseInt(o.scrollTo);
  91. }
  92. else if ('scrollBy' in options)
  93. {
  94. // jump by value pixels
  95. offset += parseInt(o.scrollBy);
  96. }
  97. else if ('destroy' in options)
  98. {
  99. // remove slimscroll elements
  100. bar.remove();
  101. rail.remove();
  102. me.unwrap();
  103. return;
  104. }
  105. // scroll content by the given offset
  106. scrollContent(offset, false, true);
  107. }
  108. return;
  109. }
  110. // optionally set height to the parent's height
  111. o.height = (o.height == 'auto') ? me.parent().height() : o.height;
  112. // wrap content
  113. var wrapper = $(divS)
  114. .addClass(o.wrapperClass)
  115. .css({
  116. position: 'relative',
  117. overflow: 'hidden',
  118. width: o.width,
  119. height: o.height
  120. });
  121. // update style for the div
  122. me.css({
  123. overflow: 'hidden',
  124. width: o.width,
  125. height: o.height
  126. });
  127. // create scrollbar rail
  128. var rail = $(divS)
  129. .addClass(o.railClass)
  130. .css({
  131. width: o.size,
  132. height: '100%',
  133. position: 'absolute',
  134. top: 0,
  135. display: (o.alwaysVisible && o.railVisible) ? 'block' : 'none',
  136. 'border-radius': o.railBorderRadius,
  137. background: o.railColor,
  138. opacity: o.railOpacity,
  139. zIndex: 90
  140. });
  141. // create scrollbar
  142. var bar = $(divS)
  143. .addClass(o.barClass)
  144. .css({
  145. background: o.color,
  146. width: o.size,
  147. position: 'absolute',
  148. top: 0,
  149. opacity: o.opacity,
  150. display: o.alwaysVisible ? 'block' : 'none',
  151. 'border-radius' : o.borderRadius,
  152. BorderRadius: o.borderRadius,
  153. MozBorderRadius: o.borderRadius,
  154. WebkitBorderRadius: o.borderRadius,
  155. zIndex: 99
  156. });
  157. // set position
  158. var posCss = (o.position == 'right') ? { right: o.distance } : { left: o.distance };
  159. rail.css(posCss);
  160. bar.css(posCss);
  161. // wrap it
  162. me.wrap(wrapper);
  163. // append to parent div
  164. me.parent().append(bar);
  165. me.parent().append(rail);
  166. // make it draggable and no longer dependent on the jqueryUI
  167. if (o.railDraggable){
  168. bar.bind("mousedown", function(e) {
  169. var $doc = $(document);
  170. isDragg = true;
  171. t = parseFloat(bar.css('top'));
  172. pageY = e.pageY;
  173. $doc.bind("mousemove.slimscroll", function(e){
  174. currTop = t + e.pageY - pageY;
  175. bar.css('top', currTop);
  176. scrollContent(0, bar.position().top, false);// scroll content
  177. });
  178. $doc.bind("mouseup.slimscroll", function(e) {
  179. isDragg = false;hideBar();
  180. $doc.unbind('.slimscroll');
  181. });
  182. return false;
  183. }).bind("selectstart.slimscroll", function(e){
  184. e.stopPropagation();
  185. e.preventDefault();
  186. return false;
  187. });
  188. }
  189. // on rail over
  190. rail.hover(function(){
  191. showBar();
  192. }, function(){
  193. hideBar();
  194. });
  195. // on bar over
  196. bar.hover(function(){
  197. isOverBar = true;
  198. }, function(){
  199. isOverBar = false;
  200. });
  201. // show on parent mouseover
  202. me.hover(function(){
  203. isOverPanel = true;
  204. showBar();
  205. hideBar();
  206. }, function(){
  207. isOverPanel = false;
  208. hideBar();
  209. });
  210. // support for mobile
  211. me.bind('touchstart', function(e,b){
  212. if (e.originalEvent.touches.length)
  213. {
  214. // record where touch started
  215. touchDif = e.originalEvent.touches[0].pageY;
  216. }
  217. });
  218. me.bind('touchmove', function(e){
  219. // prevent scrolling the page if necessary
  220. if(!releaseScroll)
  221. {
  222. e.originalEvent.preventDefault();
  223. }
  224. if (e.originalEvent.touches.length)
  225. {
  226. // see how far user swiped
  227. var diff = (touchDif - e.originalEvent.touches[0].pageY) / o.touchScrollStep;
  228. // scroll content
  229. scrollContent(diff, true);
  230. touchDif = e.originalEvent.touches[0].pageY;
  231. }
  232. });
  233. // set up initial height
  234. getBarHeight();
  235. // check start position
  236. if (o.start === 'bottom')
  237. {
  238. // scroll content to bottom
  239. bar.css({ top: me.outerHeight() - bar.outerHeight() });
  240. scrollContent(0, true);
  241. }
  242. else if (o.start !== 'top')
  243. {
  244. // assume jQuery selector
  245. scrollContent($(o.start).position().top, null, true);
  246. // make sure bar stays hidden
  247. if (!o.alwaysVisible) { bar.hide(); }
  248. }
  249. // attach scroll events
  250. attachWheel();
  251. function _onWheel(e)
  252. {
  253. // use mouse wheel only when mouse is over
  254. if (!isOverPanel) { return; }
  255. var e = e || window.event;
  256. var delta = 0;
  257. if (e.wheelDelta) { delta = -e.wheelDelta/120; }
  258. if (e.detail) { delta = e.detail / 3; }
  259. var target = e.target || e.srcTarget || e.srcElement;
  260. if ($(target).closest('.' + o.wrapperClass).is(me.parent())) {
  261. // scroll content
  262. scrollContent(delta, true);
  263. }
  264. // stop window scroll
  265. if (e.preventDefault && !releaseScroll) { e.preventDefault(); }
  266. if (!releaseScroll) { e.returnValue = false; }
  267. }
  268. function scrollContent(y, isWheel, isJump)
  269. {
  270. releaseScroll = false;
  271. var delta = y;
  272. var maxTop = me.outerHeight() - bar.outerHeight();
  273. if (isWheel)
  274. {
  275. // move bar with mouse wheel
  276. delta = parseInt(bar.css('top')) + y * parseInt(o.wheelStep) / 100 * bar.outerHeight();
  277. // move bar, make sure it doesn't go out
  278. delta = Math.min(Math.max(delta, 0), maxTop);
  279. // if scrolling down, make sure a fractional change to the
  280. // scroll position isn't rounded away when the scrollbar's CSS is set
  281. // this flooring of delta would happened automatically when
  282. // bar.css is set below, but we floor here for clarity
  283. delta = (y > 0) ? Math.ceil(delta) : Math.floor(delta);
  284. // scroll the scrollbar
  285. bar.css({ top: delta + 'px' });
  286. }
  287. // calculate actual scroll amount
  288. percentScroll = parseInt(bar.css('top')) / (me.outerHeight() - bar.outerHeight());
  289. delta = percentScroll * (me[0].scrollHeight - me.outerHeight());
  290. if (isJump)
  291. {
  292. delta = y;
  293. var offsetTop = delta / me[0].scrollHeight * me.outerHeight();
  294. offsetTop = Math.min(Math.max(offsetTop, 0), maxTop);
  295. bar.css({ top: offsetTop + 'px' });
  296. }
  297. // scroll content
  298. me.scrollTop(delta);
  299. // fire scrolling event
  300. me.trigger('slimscrolling', ~~delta);
  301. // ensure bar is visible
  302. showBar();
  303. // trigger hide when scroll is stopped
  304. hideBar();
  305. }
  306. function attachWheel()
  307. {
  308. if (window.addEventListener)
  309. {
  310. this.addEventListener('DOMMouseScroll', _onWheel, false );
  311. this.addEventListener('mousewheel', _onWheel, false );
  312. this.addEventListener('MozMousePixelScroll', _onWheel, false );
  313. }
  314. else
  315. {
  316. document.attachEvent("onmousewheel", _onWheel)
  317. }
  318. }
  319. function getBarHeight()
  320. {
  321. // calculate scrollbar height and make sure it is not too small
  322. barHeight = Math.max((me.outerHeight() / me[0].scrollHeight) * me.outerHeight(), minBarHeight);
  323. bar.css({ height: barHeight + 'px' });
  324. // hide scrollbar if content is not long enough
  325. var display = barHeight == me.outerHeight() ? 'none' : 'block';
  326. bar.css({ display: display });
  327. }
  328. function showBar()
  329. {
  330. // recalculate bar height
  331. getBarHeight();
  332. clearTimeout(queueHide);
  333. // when bar reached top or bottom
  334. if (percentScroll == ~~percentScroll)
  335. {
  336. //release wheel
  337. releaseScroll = o.allowPageScroll;
  338. // publish approporiate event
  339. if (lastScroll != percentScroll)
  340. {
  341. var msg = (~~percentScroll == 0) ? 'top' : 'bottom';
  342. me.trigger('slimscroll', msg);
  343. }
  344. }
  345. else
  346. {
  347. releaseScroll = false;
  348. }
  349. lastScroll = percentScroll;
  350. // show only when required
  351. if(barHeight >= me.outerHeight()) {
  352. //allow window scroll
  353. releaseScroll = true;
  354. return;
  355. }
  356. bar.stop(true,true).fadeIn('fast');
  357. if (o.railVisible) { rail.stop(true,true).fadeIn('fast'); }
  358. }
  359. function hideBar()
  360. {
  361. // only hide when options allow it
  362. if (!o.alwaysVisible)
  363. {
  364. queueHide = setTimeout(function(){
  365. if (!(o.disableFadeOut && isOverPanel) && !isOverBar && !isDragg)
  366. {
  367. bar.fadeOut('slow');
  368. rail.fadeOut('slow');
  369. }
  370. }, 1000);
  371. }
  372. }
  373. });
  374. // maintain chainability
  375. return this;
  376. }
  377. });
  378. jQuery.fn.extend({
  379. slimscroll: jQuery.fn.slimScroll
  380. });
  381. })(jQuery);