/*jslint eqeqeq: true, regexp: true */ /*global document, window, setInterval, clearInterval, handler, jQuery */ /*! jquery scroll - a custom stylable scrollbar Version 0.4 https://github.com/thomd/jquery-scroll Copyright (c) 2011 Thomas Duerr (me-at-thomd-dot-net) Licensed under the MIT license (https://raw.github.com/thomd/jquery-scroll/master/MIT-LICENSE) */ /* Usage Examples: Create a custom scrollbar to an arbitrary container with overflowed content: $('selector').scrollbar(); Create a custom scrollbar without arrows on top/bottom: $('selector').scrollbar({ arrows: false }); Create a custom scrollbar and call a function once the rendering is complete: $('selector').scrollbar(function(){}); Repaint scrollbar to reflect dynamically added content in the hight ans position of the scrollbar $('selector').scrollbar('repaint'); Scroll to a specific item within the container: $('selector').scrollbar('scrollto', $('item')); Scroll to bottom of content $('selector').scrollbar('scrollto', 'bottom'); Dependency: jQuery version 1.4.3+ (older verisons may also work) Support: Firefox 3+ Safari 4+ Chrome 6+ (other browser may also work, these are also the browsers I tested) Changelog: v0.4 new: added plugin methods 'repaint' and 'scrollto'. fix: the content height for plain text nodes is now calculated correctly. v0.3 fix: removed obsolete div while meassuring content height. fix: take care of borders on the container. (thanks bennyschudel) v0.2 fix: fixed bug when setting container height by an option. fix: fixed margin-collapsing related bug in calculation of content height. new: moved initialization code to object creation to make things more object oriented. new: options added to set hight of the scrollbar handle explicitly. v0.1 initial version. */ (function($, document){ // due to possible conflicts in jQuery’s namespace with lots of namespace-polluting methods, we use this method-delegation pattern (well known from jquery-UI): // // Rather than naming methods like this: // // container.scrollbarRepaint(); // // the following method-command should be used: // // container.scrollbar('repaint'); // var methods = { init: function(fn, opts){ // Extend default options var options = $.extend({}, $.fn.scrollbar.defaults, opts); // // append scrollbar to selected overflowed containers and return jquery object for chainability // return this.each(function(){ var container = $(this) // properties , props = { arrows: options.arrows }; // set container height explicitly if given by an option if(options.containerHeight != 'auto'){ container.height(options.containerHeight); } // save container height in properties props.containerHeight = container.height(); // save content height in properties props.contentHeight = $.fn.scrollbar.contentHeight(container); // if the content height is lower than the container height, do nothing and return. if(props.contentHeight <= props.containerHeight){ return true; } // create a new scrollbar object and append to DOM node for later use this.scrollbar = new $.fn.scrollbar.Scrollbar(container, props, options); // build HTML, initialize Handle and append Events this.scrollbar.buildHtml().setHandle().appendEvents(); // callback function after creation of scrollbar if(typeof fn === "function"){ fn(container.find(".scrollbar-pane"), this.scrollbar); } }); }, // repaint the height and position of the scroll handle // // this method must be called in case content is added or reoved from the container. // // usage: // $('selector').scrollbar("repaint"); // repaint: function(){ return this.each(function(){ this.scrollbar.repaint(); }); }, // scroll to a specific item within the container or to a specific distance of the content from top // // usage: // $('selector').scrollbar("scrollto"); // scroll to top of content // $('selector').scrollbar("scrollto", 20); // scroll to content 20px from top // $('selector').scrollbar("scrollto", "top"); // scroll to top of content // $('selector').scrollbar("scrollto", "middle"); // scroll to vertically middle of content // $('selector').scrollbar("scrollto", "bottom"); // scroll to bottom of content // $('selector').scrollbar("scrollto", $('item')); // scroll to first content item identified by selector $('item') // scrollto: function(to){ return this.each(function(){ this.scrollbar.scrollto(to); }); } } $.fn.scrollbar = function(method){ if(methods[method]){ return methods[method].apply(this, Array.prototype.slice.call(arguments, 1)); } else if(typeof method === "function" || method === undefined){ return methods.init.apply(this, arguments); } else if(typeof method === "object"){ return methods.init.apply(this, [null, method]); } else { $.error("method '" + method + "' does not exist for $.fn.scrollbar"); } } // // default options // $.fn.scrollbar.defaults = { containerHeight : 'auto', // height of content container [Number in px || 'auto']. If set to 'auto', the naturally rendered height is used. arrows : true, // render up- and down-arrows [true || false]. handleHeight : 'auto', // height of handle [Number in px || 'auto']. If set to 'auto', the height will be calculated proportionally to the container-content height. handleMinHeight : 30, // minimum height of handle [Number in px]. This property will only be used if handleHeight-option is set to 'auto'. scrollTimeout : 50, // timeout of handle speed while mousedown on arrows [Number in milli sec]. scrollStep : 20, // increment of handle position between two mousedowns on arrows [Number in px]. scrollTimeoutArrows : 40, // timeout of handle speed while mousedown in the handle container [Number in milli sec]. scrollStepArrows : 3 // increment of handle position between two mousedowns in the handle container [px]. }; // // Scrollbar constructor // $.fn.scrollbar.Scrollbar = function(container, props, options){ // set object properties this.container = container; this.props = props; this.opts = options; this.mouse = {}; // disable arrows via class attribute 'no-arrows' on a container this.props.arrows = this.container.hasClass('no-arrows') ? false : this.props.arrows; }; // // Scrollbar methods // $.fn.scrollbar.Scrollbar.prototype = { // // build DOM nodes for pane and scroll-handle based on the following box model: // // +----------------------------------+ // | <----------------------------- content container // | +-----------------+ +------+ | // | | | | <-------------- handle arrow up // | | | | | | // | | | +------+ | // | | | | +--+ | | // | | | | | | | | // | | | | | <-------------- handle // | | | | | | | | // | | | | | | | | // | | | | | | | | // | | | | +--+ | | // | | | | | | // | | | | <-------------- handle container // | | | | | | // | | <----------------------------- pane // | | | | | | // | | | | | | // | | | +------+ | // | | | | | | // | | | | <-------------- handle arrow down // | +-----------------+ +------+ | // | | // +----------------------------------+ // // // // DOM before: // //
--> arbitrary element with a fixed height or a max-height lower that its containing elements // [...content...] //
// // // DOM after applying plugin: // //
--> this.container //
--> this.pane // [...content...] //
//
--> this.handleContainer //
--> this.handle //
//
--> this.handleArrows //
--> this.handleArrows //
// // // If the option moveContainerId is set to true, an id attribute on the container is moved to it's // child node 'pane' which holds the content after applying the plugin. This may be useful when dynamic // content is added via $('#content_container').load(). // // The above class-attribute values can be used for styling the scrollbar with CSS. // // // // TODO: use detach-transform-attach or DOMfragment // buildHtml: function(){ // build new DOM nodes this.container.wrapInner('
'); this.container.append('
'); if(this.props.arrows){ this.container.append('
').append('
'); } // save height of container to re-set it after some DOM manipulations var height = this.container.height(); // set scrollbar-object properties this.pane = this.container.find('.scrollbar-pane'); this.handle = this.container.find('.scrollbar-handle'); this.handleContainer = this.container.find('.scrollbar-handle-container'); this.handleArrows = this.container.find('.scrollbar-handle-up, .scrollbar-handle-down'); this.handleArrowUp = this.container.find('.scrollbar-handle-up'); this.handleArrowDown = this.container.find('.scrollbar-handle-down'); // set some default CSS attributes (may be overwritten by CSS definitions in an external CSS file) this.pane.defaultCss({ 'top': 0, 'left': 0 }); this.handleContainer.defaultCss({ 'right': 0 }); this.handle.defaultCss({ 'top': 0, 'right': 0 }); this.handleArrows.defaultCss({ 'right': 0 }); this.handleArrowUp.defaultCss({ 'top': 0 }); this.handleArrowDown.defaultCss({ 'bottom': 0 }); // set some necessary CSS attributes (can NOT be overwritten by CSS definitions) this.container.css({ 'position': this.container.css('position') === 'absolute' ? 'absolute' : 'relative', 'overflow': 'hidden', 'height': height }); this.pane.css({ 'position': 'absolute', 'overflow': 'visible', 'height': 'auto' }); this.handleContainer.css({ 'position': 'absolute', 'top': this.handleArrowUp.outerHeight(true), 'height': (this.props.containerHeight - this.handleArrowUp.outerHeight(true) - this.handleArrowDown.outerHeight(true)) + 'px' }); this.handle.css({ 'position': 'absolute', 'cursor': 'pointer' }); this.handleArrows.css({ 'position': 'absolute', 'cursor': 'pointer' }); // set initial position of pane to 'top' this.pane.top = 0; return this; }, // // calculate dimensions of handle // setHandle: function(){ this.props.handleContainerHeight = this.handleContainer.height(); this.props.contentHeight = this.pane.height(); // height of handle this.props.handleHeight = this.opts.handleHeight == 'auto' ? Math.max(Math.ceil(this.props.containerHeight * this.props.handleContainerHeight / this.props.contentHeight), this.opts.handleMinHeight) : this.opts.handleHeight; this.handle.height(this.props.handleHeight); // if handle has a border (always be aware of the css box-model), we need to correct the handle height. this.handle.height(2 * this.handle.height() - this.handle.outerHeight(true)); // min- and max-position for handle this.props.handlePosition = { min: 0, max: this.props.handleContainerHeight - this.props.handleHeight }; // ratio of handle-container-height to content-container-height (to calculate position of content related to position of handle) this.props.handleContentRatio = (this.props.contentHeight - this.props.containerHeight) / (this.props.handleContainerHeight - this.props.handleHeight); // set initial position of handle to 'top' // if new content is added into the container, handle.top needs to be recalculated if(this.handle.top == undefined){ this.handle.top = 0; } else { this.handle.top = -1 * this.pane.top / this.props.handleContentRatio; } return this; }, // // append events on handle and handle-container // appendEvents: function(){ // append drag-drop event on scrollbar-handle // the events 'mousemove.handle' and 'mouseup.handle' are dynamically appended in the startOfHandleMove-function this.handle.bind('mousedown.handle', $.proxy(this, 'startOfHandleMove')); // append mousedown event on handle-container this.handleContainer.bind('mousedown.handle', $.proxy(this, 'onHandleContainerMousedown')); // append hover event on handle-container this.handleContainer.bind('mouseenter.container mouseleave.container', $.proxy(this, 'onHandleContainerHover')); // append click event on scrollbar-up- and scrollbar-down-handles this.handleArrows.bind('mousedown.arrows', $.proxy(this, 'onArrowsMousedown')); // append mousewheel event on content container this.container.bind('mousewheel.container', $.proxy(this, 'onMouseWheel')); // append hover event on content container this.container.bind('mouseenter.container mouseleave.container', $.proxy(this, 'onContentHover')); // do not bubble down click events into content container this.handle.bind('click.scrollbar', this.preventClickBubbling); this.handleContainer.bind('click.scrollbar', this.preventClickBubbling); this.handleArrows.bind('click.scrollbar', this.preventClickBubbling); return this; }, // // get mouse position helper // mousePosition: function(ev){ return ev.pageY || (ev.clientY + (document.documentElement.scrollTop || document.body.scrollTop)) || 0; }, // // repaint scrollbar height and position // repaint: function(){ this.setHandle(); this.setHandlePosition(); }, // // scroll to a specific distance from the top // scrollto: function(to){ var distance = 0; if(typeof to == "number"){ distance = (to < 0 ? 0 : to) / this.props.handleContentRatio; } else if(typeof to == "string"){ if(to == "bottom"){ distance = this.props.handlePosition.max; } if(to == "middle"){ distance = Math.ceil(this.props.handlePosition.max / 2); } } else if(typeof to == "object" && !$.isPlainObject(to)) { distance = Math.ceil(to.position().top / this.props.handleContentRatio); } this.handle.top = distance; this.setHandlePosition(); this.setContentPosition(); }, // ---------- event handler --------------------------------------------------------------- // // start moving of handle // startOfHandleMove: function(ev){ ev.preventDefault(); ev.stopPropagation(); // set start position of mouse this.mouse.start = this.mousePosition(ev); // set start position of handle this.handle.start = this.handle.top; // bind mousemove- and mouseout-event on document (binding it to document allows having a mousepointer outside handle while moving) $(document).bind('mousemove.handle', $.proxy(this, 'onHandleMove')).bind('mouseup.handle', $.proxy(this, 'endOfHandleMove')); // add CSS classes for visual change while moving handle this.handle.addClass('move'); this.handleContainer.addClass('move'); }, // // on moving of handle // onHandleMove: function(ev){ ev.preventDefault(); // calculate distance since last fireing of this handler var distance = this.mousePosition(ev) - this.mouse.start; // calculate new handle position this.handle.top = this.handle.start + distance; // update positions this.setHandlePosition(); this.setContentPosition(); }, // // end moving of handle // endOfHandleMove: function(ev){ // remove handle events (which were attached in the startOfHandleMove-method) $(document).unbind('.handle'); // remove class for visual change this.handle.removeClass('move'); this.handleContainer.removeClass('move'); }, // // set position of handle // setHandlePosition: function(){ // stay within range [handlePosition.min, handlePosition.max] this.handle.top = (this.handle.top > this.props.handlePosition.max) ? this.props.handlePosition.max : this.handle.top; this.handle.top = (this.handle.top < this.props.handlePosition.min) ? this.props.handlePosition.min : this.handle.top; this.handle[0].style.top = this.handle.top + 'px'; }, // // set position of content // setContentPosition: function(){ // derive position of content from position of handle this.pane.top = -1 * this.props.handleContentRatio * this.handle.top; this.pane[0].style.top = this.pane.top + 'px'; }, // // mouse wheel movement // onMouseWheel: function(ev, delta){ // calculate new handle position this.handle.top -= delta; this.setHandlePosition(); this.setContentPosition(); // prevent default scrolling of the entire document if handle is within [min, max]-range if(this.handle.top > this.props.handlePosition.min && this.handle.top < this.props.handlePosition.max){ ev.preventDefault(); } }, // // append click handler on handle-container (outside of handle itself) to click up and down the handle // onHandleContainerMousedown: function(ev){ ev.preventDefault(); // do nothing if clicked on handle if(!$(ev.target).hasClass('scrollbar-handle-container')){ return false; } // determine direction for handle movement (clicked above or below the handler?) this.handle.direction = (this.handle.offset().top < this.mousePosition(ev)) ? 1 : -1; // set incremental step of handle this.handle.step = this.opts.scrollStep; // stop handle movement on mouseup var that = this; $(document).bind('mouseup.handlecontainer', function(){ clearInterval(timer); that.handle.unbind('mouseenter.handlecontainer'); $(document).unbind('mouseup.handlecontainer'); }); // stop handle movement when mouse is over handle // // TODO: this event is fired by Firefox only. Damn! // Right now, I do not know any workaround for this. Mayby I should solve this by collision-calculation of mousepointer and handle this.handle.bind('mouseenter.handlecontainer', function(){ clearInterval(timer); }); // repeat handle movement while mousedown var timer = setInterval($.proxy(this.moveHandle, this), this.opts.scrollTimeout); }, // // append mousedown handler on handle-arrows // onArrowsMousedown: function(ev){ ev.preventDefault(); // determine direction for handle movement this.handle.direction = $(ev.target).hasClass('scrollbar-handle-up') ? -1 : 1; // set incremental step of handle this.handle.step = this.opts.scrollStepArrows; // add class for visual change while moving handle $(ev.target).addClass('move'); // repeat handle movement while mousedown var timer = setInterval($.proxy(this.moveHandle, this), this.opts.scrollTimeoutArrows); // stop handle movement on mouseup $(document).one('mouseup.arrows', function(){ clearInterval(timer); $(ev.target).removeClass('move'); }); }, // // move handle by a distinct step while click on arrows or handle-container // moveHandle: function(){ this.handle.top = (this.handle.direction === 1) ? Math.min(this.handle.top + this.handle.step, this.props.handlePosition.max) : Math.max(this.handle.top - this.handle.step, this.props.handlePosition.min); this.handle[0].style.top = this.handle.top + 'px'; this.setContentPosition(); }, // // add class attribute on content while interacting with content // onContentHover: function(ev){ if(ev.type === 'mouseenter'){ this.container.addClass('hover'); this.handleContainer.addClass('hover'); } else { this.container.removeClass('hover'); this.handleContainer.removeClass('hover'); } }, // // add class attribute on handle-container while hovering it // onHandleContainerHover: function(ev){ if(ev.type === 'mouseenter'){ this.handleArrows.addClass('hover'); } else { this.handleArrows.removeClass('hover'); } }, // // do not bubble down to avoid triggering click events attached within the container // preventClickBubbling: function(ev){ ev.stopPropagation(); } }; // ----- helpers ------------------------------------------------------------------------------ // // determine content height // $.fn.scrollbar.contentHeight = function(container){ // inner-wrap content temporarily and meassure content height. // wrapper container need to have an overflow set to 'hidden' to respect margin collapsing var wrapper = container.wrapInner('
').find(':first'); var height = wrapper.css({overflow:'hidden'}).height(); wrapper.replaceWith(wrapper.contents()); return height; }; // // ----- default css --------------------------------------------------------------------- // $.fn.defaultCss = function(styles){ // 'not-defined'-values var notdef = { 'right': 'auto', 'left': 'auto', 'top': 'auto', 'bottom': 'auto', 'position': 'static' }; // loop through all style definitions and check for a definition already set by css. // if no definition is found, apply the default css definition return this.each(function(){ var elem = $(this); for(var style in styles){ if(elem.css(style) === notdef[style]){ elem.css(style, styles[style]); } } }); }; // // ----- mousewheel event --------------------------------------------------------------------- // based on jquery.mousewheel.js from Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net) // $.event.special.mousewheel = { setup: function(){ if (this.addEventListener){ this.addEventListener('mousewheel', $.fn.scrollbar.mouseWheelHandler, false); this.addEventListener('DOMMouseScroll', $.fn.scrollbar.mouseWheelHandler, false); } else { this.onmousewheel = $.fn.scrollbar.mouseWheelHandler; } }, teardown: function(){ if (this.removeEventListener){ this.removeEventListener('mousewheel', $.fn.scrollbar.mouseWheelHandler, false); this.removeEventListener('DOMMouseScroll', $.fn.scrollbar.mouseWheelHandler, false); } else { this.onmousewheel = null; } } }; $.fn.extend({ mousewheel: function(fn){ return fn ? this.bind("mousewheel", fn) : this.trigger("mousewheel"); }, unmousewheel: function(fn){ return this.unbind("mousewheel", fn); } }); $.fn.scrollbar.mouseWheelHandler = function(event) { var orgEvent = event || window.event, args = [].slice.call(arguments, 1), delta = 0, returnValue = true, deltaX = 0, deltaY = 0; event = $.event.fix(orgEvent); event.type = "mousewheel"; // Old school scrollwheel delta if(event.wheelDelta){ delta = event.wheelDelta / 120; } if(event.detail){ delta = -event.detail / 3; } // Gecko if(orgEvent.axis !== undefined && orgEvent.axis === orgEvent.HORIZONTAL_AXIS){ deltaY = 0; deltaX = -1 * delta; } // Webkit if(orgEvent.wheelDeltaY !== undefined){ deltaY = orgEvent.wheelDeltaY / 120; } if(orgEvent.wheelDeltaX !== undefined){ deltaX = -1 * orgEvent.wheelDeltaX / 120; } // Add event and delta to the front of the arguments args.unshift(event, delta, deltaX, deltaY); return $.event.handle.apply(this, args); }; })(jQuery, document); // inject global jQuery object