This website uses cookies to personalise ads and to analyse traffic ok
web design

jQuery custom content scroller

jQuery custom content scroller

Highly customizable custom scrollbar jQuery plugin. Features include vertical and/or horizontal scrollbar(s), adjustable scrolling momentum, mouse-wheel (via jQuery mousewheel plugin), keyboard and touch support, ready-to-use themes and customization via CSS, RTL direction support, option parameters for full control of scrollbar functionality, methods for triggering actions like scroll-to, update, destroy etc., user-defined callbacks and more.

Current version 3.1.5 (Changelog)
Upgrading from version 2

When upgrading from version 2.x to 3.x it’s important to use version 3 CSS and .png files. Version 3 is backwards compatible but it’s also a huge overhaul. One significant change is that you don’t need to call the update method manually (the script does it automatically). For more info see changelog.

Version 2 is still maintained and updated here.


How to use it

Get started by downloading the archive which contains the plugin files (and a large amount of HTML demos and examples). Extract and upload jquery.mCustomScrollbar.concat.min.js, jquery.mCustomScrollbar.css and mCSB_buttons.png to your web server (alternatively you can load plugin files from a CDN).

Instead of hosting the plugin files on your web server, you can load them directly from a CDN like jsdelivr, Github etc.

  • jsdelivr versioned/minified
    • //cdn.jsdelivr.net/jquery.mcustomscrollbar/3.0.6/jquery.mCustomScrollbar.concat.min.js
    • //cdn.jsdelivr.net/jquery.mcustomscrollbar/3.0.6/jquery.mCustomScrollbar.min.css
    • //cdn.jsdelivr.net/jquery.mcustomscrollbar/3.0.6/mCSB_buttons.png
  • Github latest/minified
    • //malihu.github.io/custom-scrollbar/jquery.mCustomScrollbar.concat.min.js
    • //malihu.github.io/custom-scrollbar/jquery.mCustomScrollbar.min.css
    • //malihu.github.io/custom-scrollbar/mCSB_buttons.png


HTML

Include jquery.mCustomScrollbar.css in the head tag your HTML document (more info)

jquery.mCustomScrollbar.css contains the styling of the custom scrollbar and themes. It should normally be included in the head tag of your html (typically before any script tags). If you wish to reduce http requests and/or have all your website stylesheet in a single file, you should move/copy scrollbars styling in your main CSS document.

mCSB_buttons.png contains all the button arrows (up, down, left and right) as image sprites for all scrollbar themes. The plugin archive contains the PSD source (source-files/mCSB_buttons.psd) so you can change them or add your own. This file should be in the same directory with plugin stylesheet.


<link rel="stylesheet" href="/path/to/jquery.mCustomScrollbar.css" />

Include jQuery library (if your project doesn’t use it already) and jquery.mCustomScrollbar.concat.min.js in the head tag or at the very bottom of your document, just before the closing body tag

Some frameworks and CMS include jQuery library in the head tag to make sure it’s loaded when other scripts request it. Usually, including .js files on the bottom of the HTML document (just before the closing body tag) is recommended for better performance. In any case, jQuery must be included first, before plugin scripts.


<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="/path/to/jquery.mCustomScrollbar.concat.min.js"></script>

CSS

The element(s) you want to add scrollbar(s) should have the typical CSS properties of an overflowed block which are a height (or max-height) value, an overflow value of auto (or hidden) and content long enough to require scrolling. For horizontal scrollbar, the element should have a width (or max-width) value set.

If you prefer to set your element’s height/width via javascript, you can use the setHeight/setWidth option parameters.

Initialization

Initialize via javascript

After files inclusion, call mCustomScrollbar function on the element selector you want to add the scrollbar(s)

<script>
    (function($){
        $(window).on("load",function(){
            $(".content").mCustomScrollbar();
        });
    })(jQuery);
</script>

more info

The code is wrapped in (function($){ ... })(jQuery);. This ensures no conflict between jQuery and other libraries using $ shortcut (see Avoiding Conflicts with Other Libraries for more info). The plugin function is called in $(window).on("load") so it executes after all page elements (like images) are loaded.

You can change the function selector ".content" to any selector you want (an element id, class name, js variable etc.). For instance, if you want custom scrollbars to apply on the element with id content-1, you simply do:

$("#content-1").mCustomScrollbar();

You may also have multiple selectors by inserting comma separated values

$(".content,#content-1").mCustomScrollbar();

The above code adds custom scrollbars to a)every element with class name content and b)the element with id content-1.

Additionally, you may want to call mCustomScrollbar multiple times within a page in order to set different options (configuration and option parameters explained below) for each selector

<script>
  (function($){
    $(window).on("load",function(){
      $("#vertical-content").mCustomScrollbar({
        theme:"light-3",
        scrollButtons:{
          enable:true
        }
      });
      $("#horizontal-content").mCustomScrollbar({
        axis:"x",
        theme:"3d"
      });
    });
  })(jQuery);
</script>

Initialize via HTML

Add the class mCustomScrollbar to any element you want to add custom scrollbar(s) with default options. Optionally, set its axis via the HTML data attribute data-mcs-axis (e.g. "x" for horizontal and "y" for vertical) and its theme via data-mcs-theme. For example:

<div class="mCustomScrollbar" data-mcs-theme="dark">
  <!-- your content -->
</div>

Basic configuration & option parameters

axis

By default, the script applies a vertical scrollbar. To add a horizontal or 2-axis scrollbars, invoke mCustomScrollbar function with the axis option set to "x" or "yx" respectively

$(".content").mCustomScrollbar({
    axis:"x" // horizontal scrollbar
});
$(".content").mCustomScrollbar({
    axis:"yx" // vertical and horizontal scrollbar
});

theme

To quickly change the appearance of the scrollbar, set the theme option parameter to any of the ready-to-use themes available in jquery.mCustomScrollbar.css, for example:

$(".content").mCustomScrollbar({
    theme:"dark"
});

Configuration

You can configure your scrollbar(s) using the following option parameters on mCustomScrollbar function
Usage $(selector).mCustomScrollbar({ option: value });

setWidth: false
Set the width of your content (overwrites CSS width), value in pixels (integer) or percentage (string).
setHeight: false
Set the height of your content (overwrites CSS height), value in pixels (integer) or percentage (string).
setTop: 0
Set the initial css top property of content, accepts string values (css top position).
Example: setTop: "-100px".
setLeft: 0
Set the initial css left property of content, accepts string values (css left position).
Example: setLeft: "-100px".
axis: "string"
Define content’s scrolling axis (the type of scrollbars added to the element: vertical and/of horizontal).
Available values: "y", "x", "yx".

  • axis: "y" – vertical scrollbar (default)
  • axis: "x" – horizontal scrollbar
  • axis: "yx" – vertical and horizontal scrollbars
scrollbarPosition: "string"
Set the position of scrollbar in relation to content.
Available values: "inside", "outside".
Setting scrollbarPosition: "inside" (default) makes scrollbar appear inside the element. Setting scrollbarPosition: "outside" makes scrollbar appear outside the element. Note that setting the value to "outside" requires your element (or parent elements) to have CSS position: relative (otherwise the scrollbar will be positioned in relation to document’s root element).
scrollInertia: integer
Set the amount of scrolling momentum as animation duration in milliseconds.
Higher value equals greater scrolling momentum which translates to smoother/more progressive animation. Set to 0 to disable.
autoDraggerLength: boolean
Enable or disable auto-adjusting scrollbar dragger length in relation to scrolling amount (same bahavior with browser’s native scrollbar).
Set autoDraggerLength: false when you want your scrollbar to (always) have a fixed size.
autoHideScrollbar: boolean
Enable or disable auto-hiding the scrollbar when inactive.
Setting autoHideScrollbar: true will hide the scrollbar(s) when scrolling is idle and/or cursor is out of the scrolling area.
Please note that some special themes like “minimal” overwrite this option.
autoExpandScrollbar: boolean
Enable or disable auto-expanding the scrollbar when cursor is over or dragging the scrollbar.
alwaysShowScrollbar: integer
Always keep scrollbar(s) visible, even when there’s nothing to scroll.

  • alwaysShowScrollbar: 0 – disable (default)
  • alwaysShowScrollbar: 1 – keep dragger rail visible
  • alwaysShowScrollbar: 2 – keep all scrollbar components (dragger, rail, buttons etc.) visible
snapAmount: integer
Make scrolling snap to a multiple of a fixed number of pixels. Useful in cases like scrolling tabular data, image thumbnails or slides and you need to prevent scrolling from stopping half-way your elements. Note that your elements must be of equal width or height in order for this to work properly.
To set different values for vertical and horizontal scrolling, use an array: [y,x]
snapOffset: integer
Set an offset (in pixels) for the snapAmount option. Useful when for example you need to offset the snap amount of table rows by the table header.
mouseWheel:{ enable: boolean }
Enable or disable content scrolling via mouse-wheel.
mouseWheel:{ scrollAmount: integer }
Set the mouse-wheel scrolling amount (in pixels). The default value "auto" adjusts scrolling amount according to scrollable content length.
mouseWheel:{ axis: "string" }
Define the mouse-wheel scrolling axis when both vertical and horizontal scrollbars are present.
Set axis: "y" (default) for vertical or axis: "x" for horizontal scrolling.
mouseWheel:{ preventDefault: boolean }
Prevent the default behaviour which automatically scrolls the parent element when end or beginning of scrolling is reached (same bahavior with browser’s native scrollbar).
mouseWheel:{ deltaFactor: integer }
Set the number of pixels one wheel notch scrolls. The default value “auto” uses the OS/browser value.
mouseWheel:{ normalizeDelta: boolean }
Enable or disable mouse-wheel (delta) acceleration. Setting normalizeDelta: true translates mouse-wheel delta value to -1 or 1.
mouseWheel:{ invert: boolean }
Invert mouse-wheel scrolling direction. Set to true to scroll down or right when mouse-wheel is turned upwards.
mouseWheel:{ disableOver: [array] }
Set the tags that disable mouse-wheel when cursor is over them.
Default value:
["select","option","keygen","datalist","textarea"]
scrollButtons:{ enable: boolean }
Enable or disable scrollbar buttons.
scrollButtons:{ scrollAmount: integer }
Set the buttons scrolling amount (in pixels). The default value "auto" adjusts scrolling amount according to scrollable content length.
scrollButtons:{ scrollType: "string" }
Define the buttons scrolling type/behavior.

  • scrollType: "stepless" – continuously scroll content while pressing the button (default)
  • scrollType: "stepped" – each button click scrolls content by a certain amount (defined in scrollAmount option above)
scrollButtons:{ tabindex: integer }
Set a tabindex value for the buttons.
keyboard:{ enable: boolean }
Enable or disable content scrolling via the keyboard.
The plugin supports the directional arrows (top, left, right and down), page-up (PgUp), page-down (PgDn), Home and End keys.
keyboard:{ scrollAmount: integer }
Set the keyboard arrows scrolling amount (in pixels). The default value "auto" adjusts scrolling amount according to scrollable content length.
keyboard:{ scrollType: "string" }
Define the keyboard arrows scrolling type/behavior.

  • scrollType: "stepless" – continuously scroll content while pressing the arrow key (default)
  • scrollType: "stepped" – each key release scrolls content by a certain amount (defined in scrollAmount option above)
contentTouchScroll: integer
Enable or disable content touch-swipe scrolling for touch-enabled devices.
To completely disable, set contentTouchScroll: false.
Integer values define the axis-specific minimum amount required for scrolling momentum (default: 25).
documentTouchScroll: boolean
Enable or disable document touch-swipe scrolling for touch-enabled devices.
advanced:{ autoExpandHorizontalScroll: boolean }
Auto-expand content horizontally (for "x" or "yx" axis).
If set to true, content will expand horizontally to accommodate any floated/inline-block elements.
Setting its value to 2 (integer) forces the non scrollHeight/scrollWidth method. A value of 3 forces the scrollHeight/scrollWidth method.
advanced:{ autoScrollOnFocus: "string" }
Set the list of elements/selectors that will auto-scroll content to their position when focused.
For example, when pressing TAB key to focus input fields, if the field is out of the viewable area the content will scroll to its top/left position (same bahavior with browser’s native scrollbar).
To completely disable this functionality, set autoScrollOnFocus: false.
Default:
"input,textarea,select,button,datalist,keygen,a[tabindex],area,object,[contenteditable='true']"
advanced:{ updateOnContentResize: boolean }
Update scrollbar(s) automatically on content, element or viewport resize.
The value should be true (default) for fluid layouts/elements, adding/removing content dynamically, hiding/showing elements etc.
advanced:{ updateOnImageLoad: boolean }
Update scrollbar(s) automatically each time an image inside the element is fully loaded.
Default value is auto which triggers the function only on "x" and "yx" axis (if needed).
The value should be true when your content contains images and you need the function to trigger on any axis.
advanced:{ updateOnSelectorChange: "string" }
Update scrollbar(s) automatically when the amount and size of specific selectors changes.
Useful when you need to update the scrollbar(s) automatically, each time a type of element is added, removed or changes its size.
For example, setting updateOnSelectorChange: "ul li" will update scrollbars each time list-items inside the element are changed.
Setting the value to true, will update scrollbars each time any element is changed.
To disable (default) set to false.
advanced:{ extraDraggableSelectors: "string" }
Add extra selector(s) that’ll release scrollbar dragging upon mouseup, pointerup, touchend etc.
Example: extraDraggableSelectors: ".myClass, #myID"
advanced:{ releaseDraggableSelectors: "string" }
Add extra selector(s) that’ll allow scrollbar dragging upon mousemove/up, pointermove/up, touchend etc.
Example: releaseDraggableSelectors: ".myClass, #myID"
advanced:{ autoUpdateTimeout: integer }
Set the auto-update timeout in milliseconds.
Default timeout: 60
theme: "string"
Set the scrollbar theme.
View all ready-to-use themes
All themes are contained in plugin’s CSS file (jquery.mCustomScrollbar.css).
Default theme: "light"
callbacks:{
      onCreate: function(){}
}
A function to call when plugin markup is created.
Example:
callbacks:{
    onCreate:function(){
      console.log("Plugin markup generated");
    }
}
callbacks:{
      onInit: function(){}
}
A function to call when scrollbars have initialized (demo).
Example:
callbacks:{
    onInit:function(){
      console.log("Scrollbars initialized");
    }
}
callbacks:{
      onScrollStart: function(){}
}
A function to call when scrolling starts (demo).
Example:
callbacks:{
    onScrollStart:function(){
      console.log("Scrolling started...");
    }
}
callbacks:{
      onScroll: function(){}
}
A function to call when scrolling is completed (demo).
Example:
callbacks:{
    onScroll:function(){
      console.log("Content scrolled...");
    }
}
callbacks:{
      whileScrolling: function(){}
}
A function to call while scrolling is active (demo).
Example:
callbacks:{
    whileScrolling:function(){
      console.log("Scrolling...");
    }
}
callbacks:{
      onTotalScroll: function(){}
}
A function to call when scrolling is completed and content is scrolled all the way to the end (bottom/right) (demo).
Example:
callbacks:{
    onTotalScroll:function(){
      console.log("Scrolled to end of content.");
    }
}
callbacks:{
      onTotalScrollBack: function(){}
}
A function to call when scrolling is completed and content is scrolled back to the beginning (top/left) (demo).
Example:
callbacks:{
    onTotalScrollBack:function(){
      console.log("Scrolled back to the beginning of content.");
    }
}
callbacks:{
      onTotalScrollOffset: integer
}
Set an offset for the onTotalScroll option.
For example, setting onTotalScrollOffset: 100 will trigger the onTotalScroll callback 100 pixels before the end of scrolling is reached.
callbacks:{
      onTotalScrollBackOffset: integer
}
Set an offset for the onTotalScrollBack option.
For example, setting onTotalScrollBackOffset: 100 will trigger the onTotalScrollBack callback 100 pixels before the beginning of scrolling is reached.
callbacks:{
      alwaysTriggerOffsets: boolean
}
Set the behavior of calling onTotalScroll and onTotalScrollBack offsets.
By default, callback offsets will trigger repeatedly while content is scrolling within the offsets.
Set alwaysTriggerOffsets: false when you need to trigger onTotalScroll and onTotalScrollBack callbacks once, each time scroll end or beginning is reached.
callbacks:{
      onOverflowY: function(){}
}
A function to call when content becomes long enough and vertical scrollbar is added.
Example:
callbacks:{
    onOverflowY:function(){
      console.log("Vertical scrolling required");
    }
}
callbacks:{
      onOverflowX: function(){}
}
A function to call when content becomes wide enough and horizontal scrollbar is added.
Example:
callbacks:{
    onOverflowX:function(){
      console.log("Horizontal scrolling required");
    }
}
callbacks:{
      onOverflowYNone: function(){}
}
A function to call when content becomes short enough and vertical scrollbar is removed.
Example:
callbacks:{
    onOverflowYNone:function(){
      console.log("Vertical scrolling is not required");
    }
}
callbacks:{
      onOverflowXNone: function(){}
}
A function to call when content becomes narrow enough and horizontal scrollbar is removed.
Example:
callbacks:{
    onOverflowXNone:function(){
      console.log("Horizontal scrolling is not required");
    }
}
callbacks:{
      onBeforeUpdate: function(){}
}
A function to call right before scrollbar(s) are updated.
Example:
callbacks:{
    onBeforeUpdate:function(){
      console.log("Scrollbars will update");
    }
}
callbacks:{
      onUpdate: function(){}
}
A function to call when scrollbar(s) are updated.
Example:
callbacks:{
    onUpdate:function(){
      console.log("Scrollbars updated");
    }
}
callbacks:{
      onImageLoad: function(){}
}
A function to call each time an image inside the element is fully loaded and scrollbar(s) are updated.
Example:
callbacks:{
    onImageLoad:function(){
      console.log("Image loaded");
    }
}
callbacks:{
      onSelectorChange: function(){}
}
A function to call each time a type of element is added, removed or changes its size and scrollbar(s) are updated.
Example:
callbacks:{
    onSelectorChange:function(){
      console.log("Scrollbars updated");
    }
}
live: "string"
Enable or disable applying scrollbar(s) on all elements matching the current selector, now and in the future.
Set live: true when you need to add scrollbar(s) on elements that do not yet exist in the page. These could be elements added by other scripts or plugins after some action by the user takes place (e.g. lightbox markup may not exist untill the user clicks a link).
If you need at any time to disable or enable the live option, set live: "off" and "on" respectively.
You can also tell the script to disable live option after the first invocation by setting live: "once".
liveSelector: "string"
Set the matching set of elements (instead of the current selector) to add scrollbar(s), now and in the future.

Plugin methods

Ways to execute various plugin actions programmatically from within your script(s).

update

Usage $(selector).mCustomScrollbar("update");

Call the update method to manually update existing scrollbars to accommodate new content or resized element(s). This method is by default called automatically by the script (via updateOnContentResize option) when the element itself, its content or scrollbar size changes.

view examples

/* initialize plugin with auto-update options disabled */
$(selector).mCustomScrollbar({
  advanced:{
    updateOnContentResize: false,
    updateOnImageLoad: false
  }
});

/* at some point in your js script/code update scrollbar manually */
$(selector).mCustomScrollbar("update");

scrollTo

Usage $(selector).mCustomScrollbar("scrollTo",position,options);

Call the scrollTo method to programmatically scroll the content to the position parameter (demo).

position parameter

Position parameter can be:

  • "string"
    • e.g. element selector: "#element-id"
    • e.g. special pre-defined position: "bottom"
    • e.g. number of pixels less/more: "-=100"/"+=100"
  • integer
    • e.g. number of pixels: 100
  • [array]
    • e.g. different y/x position: [100,50]
  • object/function
    • e.g. jQuery object: $("#element-id")
    • e.g. js object: document.getelementbyid("element-id")
    • e.g. function: function(){ return 100; }

Pre-defined position strings:

  • "bottom" – scroll to bottom
  • "top" – scroll to top
  • "right" – scroll to right
  • "left" – scroll to left
  • "first" – scroll to the position of the first element within content
  • "last" – scroll to the position of the last element within content

view examples

Scroll to element with id “#el-1″

$(selector).mCustomScrollbar("scrollTo","#el-1");

Scroll to top

$(selector).mCustomScrollbar("scrollTo","top");

Scroll by 100 pixels down or right

var val=100;
$(selector).mCustomScrollbar("scrollTo","-="+val);

Scroll by 100 pixels up or left

$(selector).mCustomScrollbar("scrollTo","+=100");

Scroll by 100 pixels down and by 50 pixels right

$(selector).mCustomScrollbar("scrollTo",["-=100","-=50"]);

Scroll to the fifth paragraph

$(selector).mCustomScrollbar("scrollTo",$("p:eq(4)"));

Scroll to the last element within your content

$(selector).mCustomScrollbar("scrollTo","last");

Scroll to some variable value

var val=document.getelementbyid("element-id");
$(selector).mCustomScrollbar("scrollTo",val);

Scroll to 300 pixels

$(selector).mCustomScrollbar("scrollTo",300);

Method options

scrollInertia: integer
Scroll-to duration, value in milliseconds.
Example:
$(selector).mCustomScrollbar("scrollTo","bottom",{
    scrollInertia:3000
});
scrollEasing: "string"
Scroll-to animation easing, values: "linear", "easeOut", "easeInOut".
Example:
$(selector).mCustomScrollbar("scrollTo","bottom",{
    scrollEasing:"easeOut"
});
moveDragger: boolean
Scroll scrollbar dragger (instead of content).
Example:
$(selector).mCustomScrollbar("scrollTo",80,{
    moveDragger:true
});
timeout: integer
Set a timeout for the method (the default timeout is 60 ms in order to work with automatic scrollbar update), value in milliseconds.
Example:
$(selector).mCustomScrollbar("scrollTo","top",{
    timeout:1000
});
callbacks: boolean
Trigger user defined callbacks after scroll-to completes.
Example:
$(selector).mCustomScrollbar("scrollTo","left",{
    callbacks:false
});

stop

Usage $(selector).mCustomScrollbar("stop");

Stops any running scrolling animations (usefull when you wish to interupt a previously scrollTo method call).

disable

Usage $(selector).mCustomScrollbar("disable");

Calling disable method will temporarily disable the scrollbar (demo). Disabled scrollbars can be re-enable by calling the update method.

To disable the scrollbar and reset its content position, set the method’s reset parameter to true

$(selector).mCustomScrollbar("disable",true);

view examples

/* initialize plugin */
$(selector).mCustomScrollbar();

/* at some point in your js script/code disable scrollbar */
$(selector).mCustomScrollbar("disable");

/* re-enable scrollbar as needed */
$(selector).mCustomScrollbar("update");

destroy

Usage $(selector).mCustomScrollbar("destroy");

Calling destroy method will completely remove the custom scrollbar and return the element to its original state (demo).

view examples

/* initialize plugin */
$(selector).mCustomScrollbar();

/* at some point in your js script/code destroy scrollbar */
$(selector).mCustomScrollbar("destroy");

Scrollbar styling & themes

You can design and visually customize your scrollbars with pure CSS, using jquery.mCustomScrollbar.css which contains the default/basic styling and all scrollbar themes.

The easiest/quickest way is to select a ready-to-use scrollbar theme. For example:

$(selector).mCustomScrollbar({
  theme:"dark"
});

View all ready-to-use themes

You can modify the default styling or any theme either directly in jquery.mCustomScrollbar.css or by overwriting the CSS rules in another stylesheet.

Creating a new scrollbar theme

Create a name for your theme (e.g. “my-theme”) and set it as the value of the theme option

$(selector).mCustomScrollbar({
    theme:"my-theme"
});

Your element will get the class “mCS-my-theme” (your theme-name with “mCS” prefix), so you can create your CSS using the .mCS-my-theme in your rules. For instance:

.mCS-my-theme.mCSB_scrollTools .mCSB_dragger .mCSB_dragger_bar{ background-color: red; }
.mCS-my-theme.mCSB_scrollTools .mCSB_draggerRail{ background-color: white; } 
/* and so on... */

In the same manner you can clone any existing theme (e.g. “dark”), change its selector (e.g. .mCS-dark) to your own theme name (e.g. .mCS-my-theme) and modify its CSS rules.

Scrollbar markup

The plugin applies specific id (unique) and/or classes to every scrollbar element/component, meaning that you can target and modify any scrollbar in more than one ways.

For example, every element with a scrollbar gets a unique class in the form of _mCS_1, _mCS_2 etc. Every scrollbar container element gets a unique id in the form of mCSB_1_scrollbar_vertical, mCSB_2_scrollbar_vertical etc. Every scrollbar dragger gets a unique id in the form of mCSB_1_dragger_vertical, mCSB_2_dragger_vertical etc. in addition to the class mCSB_dragger. All these mean that you can do stuff like:

._mCS_1 .mCSB_dragger .mCSB_dragger_bar{ background-color: red; }

._mCS_2 .mCSB_dragger .mCSB_dragger_bar{ background-color: green; }

#mCSB_3_dragger_vertical .mCSB_dragger_bar{ background-color: blue; }

#mCSB_1_scrollbar_vertical .mCSB_dragger{ height: 100px; }

#mCSB_1_scrollbar_horizontal .mCSB_dragger{ width: 100px; }

.mCSB_1_scrollbar .mCSB_dragger .mCSB_draggerRail{ width: 4px; }

Custom scrollbar layout

User-defined callbacks

You can trigger your own js function(s) by calling them inside mCustomScrollbar callbacks option parameter

$(".content").mCustomScrollbar({
    callbacks:{
        onScroll:function(){
            myCustomFn(this);
        }
    }
});

function myCustomFn(el){
    console.log(el.mcs.top);
}

In the example above, each time a scroll event ends and content has stopped scrolling, the content’s top position will be logged in browser’s console. There are available callbacks for each step of the scrolling event:

  • onScrollStart – triggers the moment a scroll event starts
  • whileScrolling – triggers while scroll event is running
  • onScroll – triggers when a scroll event completes
  • onTotalScroll – triggers when content has scrolled all the way to bottom or right
  • onTotalScrollBack – triggers when content has scrolled all the way back to top or left

You can set an offset value (pixels) for both onTotalScroll and onTotalScrollBack by setting onTotalScrollOffset and onTotalScrollBackOffset respectively (view example).

The following will trigger the callback function when content has scrolled to bottom minus 100 pixels

$(".content").mCustomScrollbar({
    callbacks:{
        onTotalScroll:function(){
            console.log("scrolled to bottom");
        },
    onTotalScrollOffset:100
    }
});

By default, onTotalScroll and onTotalScrollBack callbacks are triggered repeatedly. To prevent multiple calls when content is within their offset, set alwaysTriggerOffsets option to false (view example).

$(".content").mCustomScrollbar({
    callbacks:{
        onTotalScroll:function(){
            console.log("scrolled to bottom");
        },
    onTotalScrollOffset:100,
    alwaysTriggerOffsets:false
    }
});

Additional callbacks:

Returning values

The script returns a number of values and objects related to scrollbar that you can use in your own functions

  • this – the original element containing the scrollbar(s)
  • this.mcs.content – the original content wrapper as jquery object
  • this.mcs.top – content’s top position (pixels)
  • this.mcs.left – content’s left position (pixels)
  • this.mcs.draggerTop – scrollbar dragger’s top position (pixels)
  • this.mcs.draggerLeft – scrollbar dragger’s left position (pixels)
  • this.mcs.topPct – content vertical scrolling percentage
  • this.mcs.leftPct – content horizontal scrolling percentage
  • this.mcs.direction – content’s scrolling direction (y or x)

view examples

Load more content when scrolled to bottom

$(selector).mCustomScrollbar({
    callbacks:{
        onTotalScroll:function(){
            this.mcs.content.append("...");
        }
    }
});

Run code when at least half of the content is scrolled

$(selector).mCustomScrollbar({
    callbacks:{
        whileScrolling:function(){
            var pct=this.mcs.topPct;
            if(pct>=50){
              /* do something... */
            }
        }
    }
});

Plugin-specific jQuery expressions

$("#myID:mcsInView")
Select element(s) in your content that are within scrollable viewport.
As condition: $("#myID").is(":mcsInView");
$(".content:mcsOverflow")
Select overflowed element(s) with visible scrollbar.
As condition: $(".content").is(":mcsOverflow");
$("#myID:mcsInSight")
$("#myID:mcsInSight(exact)")
Select element(s) in your content that are in view of the scrollable viewport. Using the exact parameter will include elements that have any part of them (even 1 pixel) in view of the scrollable viewport.
As condition: $("#myID").is(":mcsInSight");, $("#myID").is(":mcsInSight(exact)");

Plugin dependencies & requirements

License

This work is released under the MIT License.
You are free to use, study, improve and modify it wherever and however you like.
http://opensource.org/licenses/MIT

Pages: 1 2 3 4


5,585 Comments

Post a comment

Comments pages: 1 5 6 7 8 9 83

  1. pedroR
    Posted on September 5, 2011 at 19:21 Permalink

    Is there any known bug related to the window resize function?

    Because I’m having a problem when I resize the browser window. I also have a script that resizes the background image and one container div. Could be any conflict with my resize function??

    Thanks

    Reply
  2. killphi (d.s)
    Posted on September 5, 2011 at 17:27 Permalink

    Hi,

    Great project!

    I’m currently “learning by doing” HTML/JS/CSS and your plugin just helped out with our new corporate website. It’s not online yet, but I just wanted to let you know how I wrote a quick and dirty “scrollTo” solution:
    // scroll to $(container).css('left', '-' + parseInt(scrollTo * parseInt($(horWrapper).css('width'))) + 'px'); $(dragger).css('left', parseInt(scrollTo * parseInt($(dragger_container).css('width'))) + 'px');

    I have a wrapper function, in which the elements (container, dragger, …) are created via document.createElement(‘div’) and after I called mCustomScrollbar on the parent node, I exec these to lines to jump to a pre-defined float value (scrollTo).

    This probably isn’t very accurate, but for now it does it’s job.

    Reply
  3. Kunal
    Posted on September 5, 2011 at 13:33 Permalink

    The scrollbar seems to be working fine in Mac OS X 10.7 (Lion). But like you said, it scrolls fast in Snow Leopard. Can you update the mac specific version of the plugin to account for the difference between Snow Leopard and Lion?

    Reply
  4. Peter Boomsma
    Posted on September 1, 2011 at 18:49 Permalink

    Great plugin! I had some problems with showing the scrollbar in a hidden div but I fixed it using the tips above (put the div you want to hide in the window load function) but… now it shows the div for a flash and then hides it… kind of anoying. Anyone fixed this problem?

    Reply
  5. SondreB
    Posted on September 1, 2011 at 11:39 Permalink

    If I load jQuery 1.6 instead of 1.4, the scrolling animation becomes a little bit jagged. This happens in all browsers I’ve tested (FireFox, IE and Chrome). Changing the reference to 1.4, makes it perfectly smooth again. It’s not very noticeable, but still annoying enough that I’m considering using older version of jQuery. Perhaps some issue between the jquery.easing and later versions of jQuery?

    Reply
  6. Stef
    Posted on August 30, 2011 at 17:15 Permalink

    Hi Manos!

    On Google I found your jQuery solution for custom scroll bars. I can’t get it to work in WordPress… The bottom of the content isn’t shown properly:

    http://www.sadiejayne.nl/media/photos/

    Is there a solution or fix for this problem? Or am I just doing something terribly wrong?

    Reply
  7. Joseph
    Posted on August 29, 2011 at 21:41 Permalink

    Hello, I have a strange issue in IE 7 and 8.

    I have some dynamic content loaded via jquery. When I load the content in IE 7, it isn’t able to scroll all the way to the bottom. Could this be to my css positioning?

    Reply
  8. Ben
    Posted on August 29, 2011 at 12:45 Permalink

    hai
    In Horizontal non-adjustable image scroller with easing, can i make “arrows” disable or non-clickbale when image reaches the at the end?

    Reply
  9. Pablo
    Posted on August 28, 2011 at 19:42 Permalink

    Many thanks for the plug-in! It really come handy to me…

    I have one question to do and it’s about the vertical dragger. I’d like to have it as a point, not instead as an slash. (I want a 9×9 pix dragger)

    The css code is as follows: #mcs_container .dragger {width:9px; height:9px; }

    but in fact, as you can see in the next photo, is has been reshaped to a 9×132 one http://i52.tinypic.com/hvqbl3.png

    What should I change? Is it possible to have it in a certain lenght?

    Many thanks for your help!

    Pablo

    Reply
  10. Nick
    Posted on August 28, 2011 at 16:14 Permalink

    Hi Malihu – this is by far the best scroller I’ve found after many weeks of searching. However I just can’t seem to get it working on my project. I’m sure it’s something very simple I’m overlooking, but I just don’t know what. Do you know of any special considerations for installing it on Joomla sites? Initially I followed the instructions from this site with no luck, then I tried replicating the code from the first example included in the download, also to no avail. Any suggestions you have would be much appreciated. I am dying to get this to work as visually as well as structurally your scroller would add serious value to my site. Cheers. Nick.

    Reply
  11. Kunwar
    Posted on August 28, 2011 at 11:52 Permalink

    hi first Thanks for this excellent plugin. Secondly i am trying to use horizontal version. for displaying images in a row. is there a way that dragger starts from middle of the dragger container box instead of far left and the content also be centered in the display area.

    looking forward for some easy and fast fix. thanks again.
    Kunwar

    Reply
  12. indwebexperts
    Posted on August 26, 2011 at 19:28 Permalink

    smart

    Reply
  13. pedroR
    Posted on August 25, 2011 at 19:21 Permalink

    Hi. This is very well developed.

    Just got one question. Is it possible to have just the dragger container if the amount of content isn’t enough to fill the hole area, instead of doesn’t appear the dragger container and the dragger. For instance: in the demo file “jquery_custom_scrollbar.html” if the first block just have one paragraph the container and the dragger disappear. right?? It was interesting to disappear just the dragger and keep the dragger container (line).

    Thanks

    Reply
    • pedroR
      Posted on August 25, 2011 at 19:29 Permalink

      sorry …

      I found it. line 325 of js file–> $dragger_container.css(“display”,”block”);

      Thanks for this excellent plugin

      Reply
    • Perm
      Posted on August 26, 2011 at 10:31 Permalink

      Great plugin. Really well done. Question–is there an easy way to just have the buttons for scrolling and no scrollbar? I know I can probably hack it out, but wondering if there was a proper or recommended method of doing this. Thanks!

      Reply
  14. Alain
    Posted on August 24, 2011 at 18:29 Permalink

    Hi,

    is there a way to let the scrollbar at the bottom after reinit it?

    for exemple after someone have add a comment (in ajax) we have to reload the scrollbar, but after that the scroll is on top.. not very user friendly 🙁

    Thanks!

    Reply
    • Highstrike
      Posted on July 7, 2012 at 05:25 Permalink

      Hey dude, if you wana keep the scroll at the bottom use this function:

      // perform scrolling scroll: function(container, down) { jQuery(container).mCustomScrollbar("vertical", 100, "easeOutCirc", 0, "auto", "yes", "no", 15); // scroll to bottom if(down) { var calc = jQuery('div.content', container).height() - jQuery('div.customScrollBox', container).height(); if(calc > 0) jQuery('div.container', container).css('top', (calc * -1) + 'px'); var calc = jQuery('div.dragger', container).height() - jQuery('div.dragger_container', container).height(); if(jQuery('div.dragger', container).is(":visible")) jQuery('div.dragger', container).css('top', (calc * -1) + 'px'); } },

      use it like this: this.scroll(‘#mcs_container’, true);
      the 1st param is your unique id and then 2nd param is if you want it to scroll at the bottom after you call it (calling this function also re-initializes the whole plugin)

      Reply
  15. Chetena
    Posted on August 24, 2011 at 13:27 Permalink

    Hey,
    The plugin is realy cool, but i am facing a problem.

    I will add div in place of plain text with property float, the scroller doesnot work properly.

    Please let me know the solution for the same.

    Thank You in advance!

    Reply
  16. Nathaniel
    Posted on August 23, 2011 at 21:16 Permalink

    Hi Malihu,

    For some reason the code isn’t working for me. It was working about an hour ago but since dreamweaver shut down unexpectedly it hasn’t been working since.

    Any clues?

    Reply
  17. Philip
    Posted on August 23, 2011 at 16:24 Permalink

    One more thing. Plugin doesn’t work with other jquery plugins just like for example Fancybox

    Reply
    • Philip
      Posted on August 23, 2011 at 16:32 Permalink

      sorry it’s work 🙂

      Reply
    • javier
      Posted on November 23, 2011 at 14:04 Permalink

      Hi, how did you made it work?, (sorry for my english written, i speak spanish)
      I´ve installed fancy box in wordpress.
      Thank you very much

      Javier

      Reply
  18. Philip
    Posted on August 23, 2011 at 11:36 Permalink

    Hey, I have a problem with your plugin in Chrome and WordPress. I don’t know why in Opera 11.5, IE 8 ,9, Safari, Firefox everything is ok, but in Chrome my scroller dosn’t work as it should.

    This is page adress http://www.fnowak.pl/1pointstudio/?cat=1

    Reply
  19. EmmaY
    Posted on August 23, 2011 at 10:09 Permalink

    I’ve tried to use anchors within the scrolling content div, but when I click on the link to go to the anchor, It skips to the right position, but the scroll bar disappears?

    Reply
  20. Andrew
    Posted on August 19, 2011 at 19:42 Permalink

    Has anyone figured out how to get the scroll bar on the left hand side instead of the right side? I’ve toyed with this quite a bit but it’s harder than you might imagine :/

    Anyone feeling bold?

    Reply
  21. Jeremy
    Posted on August 19, 2011 at 00:21 Permalink

    I was having the same issue as Sam, Eric and Gavin above with IE7 not resetting the width of the horWrapper element. The fix is to trigger hasLayout with a zoom value of 1.

    #h-scroller-element .customScrollBox .container {
    zoom: 1;
    }

    Reply
    • malihu
      Posted on August 19, 2011 at 13:57 Permalink

      Great! Thanks for posting this 🙂

      Reply
    • Luca
      Posted on January 2, 2012 at 12:11 Permalink

      Thanks for sharing! Saved me a lot of time!

      Reply
  22. Alain
    Posted on August 15, 2011 at 16:19 Permalink

    Thanks, thanks, thanks! 🙂

    Reply
  23. Matthew
    Posted on August 15, 2011 at 15:14 Permalink

    I have a problem with divs which are changing their height on click. They are inside the content div. So when I’ll change height to big then i can’t to scroll down to the end. Do you have some solution for this?

    Reply
  24. Oscar
    Posted on August 12, 2011 at 14:54 Permalink

    Hey, great plugin. Got a question:

    I’m using an iframe inside the scroller to load an external page (tumblr) into the scroller, works great except that I want the scroller to go back to the top when a new page is loaded in the iframe – right now it stays scrolled down when the next tumblr page is loaded. I’m a bit lost here, is there a way to get the scroller back to the top? Should I load the external content otherwise perhaps?

    Grateful for any help.

    Reply
    • malihu
      Posted on August 12, 2011 at 20:57 Permalink

      Hello Oscar,

      If you know when a new iframe page is loaded, you can use the following code (for vertical scroller):
      $dragger.css("top",0); Scroll();

      and
      $dragger.css("left",0); ScrollX();

      for horizontal scroller.
      This may also be used as a callback on other functions or events.

      Reply
      • Oscar
        Posted on August 24, 2011 at 12:24 Permalink

        Hey, thanks for getting back to me.

        So I’m thinking something like this should work:

        function load()
        {
        $dragger.css(“top”,0);
        Scroll();
        }

        But to no effect, any ideas? Really appreciate the help.

        Reply
    • Oscar
      Posted on August 24, 2011 at 12:27 Permalink

      Sry, code got messed up:

      function load() { $dragger.css("top",0); Scroll(); }

      Reply
      • Oscar
        Posted on August 24, 2011 at 12:29 Permalink

        and:

        – iframe onload=”load()” src=”link.html” –
        – /iframe –

        Reply
  25. Gabriele
    Posted on August 12, 2011 at 00:34 Permalink

    Hi, great plugin, thanks!
    I modified the css for my project.
    I have a question: the arrow buttons work fine on iPad?
    I have only an android platform and I seen that the arrow buttons don’t work (but the slider works fine if you touch). Have you any suggestion?
    You can try my site at this link
    Thanks 😉

    Reply
    • malihu
      Posted on August 12, 2011 at 21:15 Permalink

      I’m betting the arrows won’t work on iPad, simply cause the only event that really works on those devices is click, which is not efficient for this plugin (as you wanna press to scroll). Android supports more stuff in general.

      Reply
      • Gabriele
        Posted on August 29, 2011 at 11:42 Permalink

        Thanks malihu,
        you know how I can fix this problem? I’m not an expert with js code.

        Reply
  26. Kristina
    Posted on August 11, 2011 at 09:57 Permalink

    Hi there,

    Thank you for posting this! It’s just what I was looking for. I’m in the process of implementing your code (the horizontal scroller) and have a few questions:

    1) Is it possible to add a function that enables scrolling with the arrow keys? How do you do that? (I’m a newbie)

    2) As of today, does the scroller work on the ipad and iphone? If not, how do you add a condition (I saw that in the comments above)?

    You can my work in progress here (please note, not all links are working yet, it’s just a mock-up with the scroller): http://industriallosangeles.org/NEWila/sites/hughes.html.

    Any help you can give would be most appreciated. Again, thanks for all your hard work!

    Reply
  27. greg
    Posted on August 10, 2011 at 08:56 Permalink

    This is a great-looking plugin and the demo functions beautifully. I’ve been trying to implement it here :

    http://whitelemondesigns.com/test/about.html

    But I just can’t seem to get it to function. I’m not an experienced javascript or jquery user at all; I assume there’s some basic thing that I’m not doing. Could I have some kind of javascript conflict?

    Any help at all would be greatly appreciated.

    Reply
    • malihu
      Posted on August 10, 2011 at 17:59 Permalink

      Hello Greg,

      Check the final step on this post to include the actual custom scrollbar plugin and the function that calls and configures the scrollbar.

      Reply
      • greg
        Posted on August 11, 2011 at 06:31 Permalink

        Thanks… I incorporated that… but it’s still not working. Sorry to bother again, this is actually my first foray into javascript. Any further insight?

        Reply
  28. raymond
    Posted on August 9, 2011 at 03:16 Permalink

    Sorry another question is there a way to change the draggers hover state?

    Reply
  29. raymond
    Posted on August 9, 2011 at 02:57 Permalink

    Speaking of which is there a way to center the track like so that the button is like walking on a line so to speak?

    Reply
  30. raymond
    Posted on August 9, 2011 at 02:18 Permalink

    I am definitely new to all this..

    Does this work with floated elements?

    I’ve just started to implement it. It seems to mess things up when my content is floated and reached a certain size. Also doesn’t seem to work in firefox ver5(I don’t know about the lower versions). The arrows start disappear when I have my container scroll div floated. It seems to do the same even when I keep the whole script and css intact.

    Maybe I could also be doing it all wrong.
    It’s such a great look and the fact that you can customize it makes it so convenient.
    However I have yet to understand how exactly to use it.

    Does the container for the scrolling area have to be relative or be positioned relatively or absolutely as shown in the examples?

    Reply

Comments pages: 1 5 6 7 8 9 83

Post a comment

Your e-mail is never published nor shared. Required fields are marked *

You may use these HTML tags and attributes:
<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>
You can write or copy/paste code directly in your comment using the <code> tag:
<code>code here...</code>
You may also use the data-lang attribute to determine the code language like so:
<code data-lang-html>, <code data-lang-css>, <code data-lang-js> and <code data-lang-php>

css.php