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="https://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.
https://opensource.org/licenses/MIT

Pages: 1 2 3 4


5,630 Comments

Post a comment

Comments pages: 1 42 43 44 45 46 85

  1. Zq
    Posted on November 7, 2013 at 05:41 Permalink

    Thanks, the plugin works in my project.

    But if is it possible to use both vertical and horizontal scrollbar on the same element?

    Also I have a message alerter in my project like this:
    function #{alias}(){ var msg="#{facesMessages}"; if(msg!=""){ alert(msg); } } window.setTimeout("#{alias}();", 100);
    It is in every page’s end before call mCustomScrollbar function, and with your plugin it alert everything twice instead once now, could you tell me where in your plugin may cause this problem? Thanks a lot!

    And sorry for my English.

    Reply
  2. Lucian
    Posted on November 7, 2013 at 01:04 Permalink

    The plugin is working but messing up my subclasses for the div I apply it to.

    I have other divs with subclasses with height in %. And it messes it up.
    Actually is messes the parent containers height, and it doesn’t work if I use set_height

    Reply
  3. LucFol
    Posted on November 6, 2013 at 18:13 Permalink

    Bottom scroll button doesn’t work for me – instead of scrolling down, it scrolls the content up, just like the top scroll button. What could be the possible cause of this? Do I need to configure it?

    Reply
  4. Alex Mdna
    Posted on November 4, 2013 at 17:28 Permalink

    Hi ! Thanks for the amazing job !
    I just have a problem with the scrollto plugin : I want it to react like an anchor so, when clicking on an element, it will scroll to the defined id element… is it possible ? Because when using the plugin the way you introduce it, it scroll to the defined id element on page loading !
    thanks in advance!

    Reply
  5. Taha
    Posted on November 3, 2013 at 22:26 Permalink

    Hey Malihu,
    This is an amazing plugin and I’d love to use it but it doesn’t seem to be compatible with jquery mobile. Is there some fix for this? Thanks!

    Reply
    • Taha
      Posted on November 3, 2013 at 22:30 Permalink

      It works for content but not the body tag.

      Reply
  6. Adam Basich
    Posted on November 3, 2013 at 03:47 Permalink

    Hello there!

    FANTASTIC plug in, great work.

    Question- Internet Explorer is still showing the default scrollbar area alongside the custom scroll bar plug in- Can u tell me how to fix this?

    Thanks in advance for the help!

    AB

    Reply
    • Adam Basich
      Posted on November 10, 2013 at 05:58 Permalink

      Hey if anyone else has a solution to this that would be awesome too. I cant get the default area to disappear in IE and its throwing one of the layout elements off.

      Anyone else experiencing this?

      Reply
  7. Diego Machado
    Posted on October 31, 2013 at 22:00 Permalink

    Hey malihu!

    Is it possible to create a method to scroll X pixels to one of the directions (up, down, left, right) ?

    Great job on the plugin! 🙂

    Reply
  8. Nag
    Posted on October 30, 2013 at 14:28 Permalink

    Hi
    (function ($) {
    $(window).load(function () {
    $(“#dvSubButtonTabs”).mCustomScrollbar({
    horizontalScroll: true,
    scrollButtons: {
    enable: true
    },
    //autoHideScrollbar: true,
    theme: “dark-thin”
    });
    });
    })(jQuery);

    At very first time it’s working fine, after postback not working.Pls hep

    Reply
    • Narendar
      Posted on November 18, 2013 at 12:01 Permalink

      did anybody find solution for this issue? if yes, pls help me.
      I’m also facing the same problem.

      Reply
  9. MrPilou
    Posted on October 30, 2013 at 11:52 Permalink

    Hi,

    Great job !
    I had just one problem : in a div with horizontal scroll i use input.
    Those input couldn’t be edit because of the infinite loop mCSB_onContentResize (i don’t know why a loop at this time).

    option:
    horizontalScroll:true,
    advanced:{
    updateOnContentResize: true,
    autoExpandHorizontalScroll:true
    }

    Sorry for my bad english

    Reply
  10. Steven Simoni
    Posted on October 29, 2013 at 23:24 Permalink

    Is there a method or value to pass such that when I get to the end of a nested div scroll the outside div scroll won’t start scrolling?

    Thanks, this is a great plugin btw! makes my site look sharper.

    Reply
  11. ray
    Posted on October 28, 2013 at 23:41 Permalink

    hi, i am trying to use the infinite scroll but i noticed that it just keeps restyling the same content. how do i get it to call different content everytime you scroll to the bottom. any help would be appreciated, this plugin is amazing!

    Reply
  12. chris
    Posted on October 28, 2013 at 02:12 Permalink

    This is a very nice plugin… nice job Malihu

    Is there an option to make the scroll bars invisible but still retaining their functions?

    Reply
    • Lechampi
      Posted on October 28, 2013 at 02:54 Permalink

      Hey Chris,

      You might be able to override the css like this :

      // override the scrollbar on normal behaviour .mCS-dark > .mCSB_scrollTools .mCSB_dragger .mCSB_dragger_bar { background: none repeat scroll 0 0 rgba(0, 0, 0, 0.2); /* Replace the opacity 0.2 by 0 to get transparent */ } // override the scrollbar on hover behaviour .mCS-dark > .mCSB_scrollTools .mCSB_dragger:hover .mCSB_dragger_bar { background: none repeat scroll 0 0 rgba(0, 0, 0, 0.7); /* Replace the opacity 0.7 by 0 to get transparent */ }

      You can do so many things overriding the styles ! 🙂
      Enjoy !

      Reply
  13. Julian
    Posted on October 27, 2013 at 18:16 Permalink

    Thanks for the great plugin! It works perfectly for me!

    Regards,
    Julian

    Reply
  14. Lechampi
    Posted on October 27, 2013 at 10:38 Permalink

    Hi Malihu !
    First of all, thanks for that wonderful plugin ! You really contribute to improve the web and our minds ! so, thank you !

    I actually faced to a big problem for me: the fact it’s not possible to zoom (pinch in/out on iPad for example) when using your plugin. That’s really a pity because some other plugins not as complete as yours seem to be ok with that.
    But, reading further into your documentation, I noticed on the “disable & distroy methods example” that disabling the scrollbar allow to zoom!

    Here is my simple code which allow using zoom:
    function MyGesture(element) { var self = this; element = $(element); this.init = function() { // see Apple's Safari Developer Library -> GestureEvent Class Reference for a list of the gestures. element.on('gesturestart', function(ev) { $('#scrolling_area').mCustomScrollbar('disable'); // disable only, not distroy }); element.on('gestureend', function(ev) { $('#scrolling_area').mCustomScrollbar('update'); // re-activate at the same position }); }; }

    $().ready(function() { var myGesture = new MyGesture('#scrolling_area'); myGesture.init(); });

    Like this, it works very well ! The only problem is that when you pinch in, scrolling will still work, so moving inside the zoomed page will require using 2 fingers (create gesture) when moving over the scrolling area. The rest of the page will require only 1 finger ( normal behavior : ‘swipe’).
    My scrolling area is horizontal, so I guess if I desactivate the scroll while I’m operating a drag up or drag down (only require one finger), it might solve the problem… But this last tip, I haven’t tried it yet.
    Anyway, I hope it will be useful to many people!
    Thanks again Malihu for your amazing work!

    Lechampi

    Reply
  15. Slava
    Posted on October 26, 2013 at 17:03 Permalink

    /*”/very well thought out and carefully written plug-in that allows for a wide range of manipulations, I expect you new, amazing plugins!

    Reply
  16. site design
    Posted on October 26, 2013 at 12:48 Permalink

    tanx a lot

    Reply
  17. thankful
    Posted on October 25, 2013 at 16:19 Permalink

    Hi,
    Thanks for your great effort

    I wonder how i can replace browser main scrollbar with your own customized version.
    I’m using joomla 3 with bootstrap and i want to make custom scrollbars

    please help with instructions

    My regards

    Reply
  18. pojta
    Posted on October 25, 2013 at 15:42 Permalink

    Hi,

    This plugin doesn’t work, if is used jquery-ui.min.js in the same project. Any ideas how to fix it? Thanks

    Reply
  19. pradeep reddy
    Posted on October 25, 2013 at 15:04 Permalink

    I’m using this custom scrollbar for a chat window.. so the content will be loading when we send or recieve messages.. I’m loading this scrollbar when the div has got a scrollbaroption… Also, I’m using “advanced:{updateOnContentResize:true}” as the content will be loading when we chat… For the first time when this scrollbar is getting activated, I’m scrolling to bottom by using “$(“#id”).mCustomScrollbar(“scrollTo”,”bottom”)” … But this is working only for once.. this has to be done when a new message is done or received..

    Reply
  20. Yoko
    Posted on October 25, 2013 at 12:21 Permalink

    Hi Malihu, this is really a great scroller, but unfortunately the dragger does not work in IE !! Is there any hint to fix this? Greets Yoko

    Reply
    • malihu
      Posted on October 25, 2013 at 14:04 Permalink

      Hi,

      Do the examples and demos work on IE? I need more information like browser version, OS and probably a link with your implementation in order to help.

      Reply
      • Yoko
        Posted on October 26, 2013 at 01:08 Permalink

        Hi, thank you very much for your reply! No, unfortunately all other examples and demos that are used the current build of the scroller doesn’t work in IE 11 who is released with the recent release of Win 8.1.

        It seems that the dragger is not registered the click event.

        Thank you, in hope of a hint …

        Yoko

        Reply
      • Jonathan
        Posted on October 30, 2013 at 22:56 Permalink

        I’ve found why IE bug with Windows 8.1

        In Internet Explorer 11 in the “developper tools” by default “Edge mode” is selected. If I change for an other mode the plugin works fine.

        I hope help you with this information

        Reply
      • Derek Keeler
        Posted on November 1, 2013 at 20:13 Permalink

        The issue is with how IE11 detects pointer events. The way the plugin is checking for pointer event support is: window.navigator.msPointerEnabled, which returns true in IE11. The problem is that IE11 doesn’t support the vendor prefixed versions of the pointer event.

        If you find the if statement where $.support.msPointer is being checked (under /*scrollbar drag scrolling*/) and remove the if so that only the else code is run or you change the pointer events to the non-vendor prefixed versions then IE11 works fine in my use cases. I imagine this may break in some cases but the offending code is the pointer events.

        Reply
        • Cesar Schrega
          Posted on November 8, 2013 at 20:01 Permalink

          Found a better way to fix this.

          The agent string in ie11 is ‘Mozilla/5.0 (Windows NT 6.3; Trident/7.0; rv 11.0) like Gecko’ (Microsoft is taking some effort in hiding it is IE, so they stoped using the MSIE in the Agent String).

          So I added a user agent check for ‘MSIE’ in the if that checks support for msPointer:

          changing the line :

          if( $.support.msPointer){ /*MSPointer*/

          to

          if( $.support.msPointer && navigator.userAgent.match(/MSIE\./)){ /*MSPointer*/

          So far this have worked everywhere I’ve tested.

          Reply
          • itg
            Posted on November 16, 2013 at 15:08 Permalink

            thx for that soulution. works exactly as expected.

        • malihu
          Posted on November 19, 2013 at 14:26 Permalink

          Pointer events updated on latest version (2.8.3). Thanks for the feedback.

          Reply
          • Yoko
            Posted on November 20, 2013 at 11:05 Permalink

            Thank you very much!

  21. Q
    Posted on October 24, 2013 at 17:26 Permalink

    Doesn’t seem to work in IE 10 you don’t get the styled scrollbar just the browser scrollbar

    Reply
    • malihu
      Posted on October 25, 2013 at 14:01 Permalink

      Hi,

      The plugin works well on IE10 (tested on win7 and 8). Please check if your implementation is correct and for any console errors.

      Reply
  22. pradeep reddy
    Posted on October 23, 2013 at 14:34 Permalink

    These scrollbars are wonderful!!
    I’m working on a web application chat window UI, I wanted to use a dark-thick jquery scrollbar for the Chat message body. The chat window will be opened upon click of a button after 8 seconds. Below are my questions…

    I’m able to add this custom scrollbar using Chrome develepor tools console and found the below problems..

    1. Where do I need to write the code “$(“#id”).mCustomScrollbar()” as the chat window is loaded upon the click of a button;
    2. Also, in the message body div element the scrollbar plugin is creating another div with classes “mCustomScrollBox mCS-dark-thick”. Whenever a message is sent, we are creating another div element to show in the message body. But this div is loading below the “plugin div”, which is not correct as the messages are shown from bottom;

    Reply
  23. quang thinh
    Posted on October 20, 2013 at 18:48 Permalink

    how to auto move up or down?

    Reply
  24. Will Martin
    Posted on October 19, 2013 at 10:09 Permalink

    Hi,

    I’m trying to implement your scrollbars on jquery colorbox, specifically this wordpress version http://wordpress.org/plugins/jquery-colorbox/, but it’s not working see here for full details:

    http://stackoverflow.com/questions/19457574/jquery-colorbox-and-custom-scrollbar

    Reply
  25. John smith
    Posted on October 18, 2013 at 08:53 Permalink

    It’s looking fantastic. Thanks for such a wonderful plugin…
    How can I use this in iframe and page body????

    Thanks .

    Reply
  26. Fabio
    Posted on October 18, 2013 at 06:33 Permalink

    First of all, thank you for a great plugin. I played around a bit and it seems really nice and straightforward, however, I’m facing a weird issue: in a site using Skrollr, the whole dragbar and arrows aren’t showing. However, if I inspect the element, they suddenly show up. There are no message errors, the paths are OK (obviously since things show up at some point) and everything seems to be fine… but nothing shows up. I’m quite sure this is a Skrollr thing since it has quite a bunch of bugs on the CSS side, but maybe you know what is causing this and how to solve it.

    Anyway, thank you again

    F.

    Reply
  27. Abhishek
    Posted on October 17, 2013 at 12:55 Permalink

    Hi Malihu, Thanks a lot for such a great plugin. I have used it into my application and now it looks cool but at the same time i am facing an issue with it. My application is server side and the technology i’m using is ASP.net.
    i have used a telerik rad treeview to display some data hierarchy which comes from data-base inside a Division (div) on which i have applied the mCustomscrollbar but the problem i’m facing is, when i click on the lowest node or any of the node that comes after scrolling the tree, postback occurs and the scroll bar goes to the top of the tree.

    Q. HOW TO MAINTAIN SCROLL POSITION SO THAT A USER SEE ONLY THAT NODE WHICH IS CURRENTLY CLICKED/SELECTED?

    i have also used an AJAX panel for the same, but doing that also not fixes the issue.

    waiting for your reply . . . . 🙂

    Reply
    • Ramzi
      Posted on October 27, 2013 at 00:22 Permalink

      I have the same problem.

      Reply
    • Shay
      Posted on November 17, 2013 at 21:37 Permalink

      Try
      advanced:{
      autoScrollOnFocus: false
      }

      Reply
      • Abhishek
        Posted on December 10, 2013 at 10:12 Permalink

        Hi . . 🙂 , thanks for the reply, I have tried this earlier but doesn’t work for me. Is there any other way?

        Reply
  28. Helmut
    Posted on October 17, 2013 at 09:36 Permalink

    a very good plugin!

    but I miss one important function:
    scroll page down if you click below the scrollbar dragger, and scroll pageup when you click above them, like every browser scrollbar do that.

    thank you!

    Reply
  29. Jane
    Posted on October 17, 2013 at 03:39 Permalink

    works bad in IE6 and IE7

    Reply
    • malihu
      Posted on October 19, 2013 at 17:25 Permalink

      Any IE version below 8 is not supported any more.

      Reply
  30. Shin
    Posted on October 16, 2013 at 13:44 Permalink

    i place a inside a and call function:
    $(“div”)…
    it works well but when i click in the form (radio button,check box ..) the form auto scroll up 🙁 .How do i fix it (disable auto scroll)???
    thank for help 🙂

    Reply

Comments pages: 1 42 43 44 45 46 85

Post a comment

Cancel reply

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