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.4 (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")
Select element(s) in your content that are in view of the scrollable viewport.
As condition: $("#myID").is(":mcsInSight");

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,230 Comments

Post a comment

Comments pages: 1 74 75 76

  1. Alex
    Posted on June 23, 2016 at 12:54 Permalink

    I am currently using the latest plugin version 3.1.4 and testing on Chrome version “51.0.2704.103 m” with jQuery version 2.1.4. I have a page, which loads at “domain1.com”. The page has an iframe, which loads the content from a different domain “domain2.com”. The iframe has some elements with scrollbars. If I click and drag the scrollbar, but release the mouse button outside of the iframe, the scrollbar does not get released. If I move the mouse back into the iframe, the scrollbar scrolls while I am moving the mouse inside the iframe. If I click anywhere inside the iframe, the scrollbar gets released.

    I have found a similar reported issue https://github.com/malihu/malihu-custom-scrollbar-plugin/issues/87, but I assume it is fixed for the cases, when the page and the iframe are loaded from the same domain. If I try to access top.document in the iframe, I get this error in the browser’s console:

    “Uncaught SecurityError: Blocked a frame with origin “http://www.domain2.com” from accessing a frame with origin “http://www.domain1.com”. Protocols, domains, and ports must match.”

    Any help would be appreciated. Thank you in advance.

    Reply
  2. Joshua
    Posted on June 20, 2016 at 09:39 Permalink

    Anybody get this plugin to work with the Aurelia Framework.. If so please share the steps here.. !!

    Reply
  3. Dean
    Posted on June 19, 2016 at 22:20 Permalink

    Hi Manos,

    Will Custom Scrollbar permit position: sticky; for h1-6 tags? I can’t seem to get it working for me.

    Reply
  4. Jason
    Posted on June 14, 2016 at 02:52 Permalink

    Hi,

    Am using the scrollbar script with the jQuery Autocomplete Script (Devbridge version). Scripts works great on first AutoComplete results however after textfield looses focus and focus is given back to the textfield to display the autocomplete results the scrollbars do not appear again.

    jQuery(document).ready(function($){ $('.dropdown .dropdown-menu').on({ "click":function(e){ e.stopPropagation(); } }); var el = $('.wcus_search_term'), def_loader = ( typeof woocommerce_params != 'undefined' && typeof woocommerce_params.ajax_loader_url != 'undefined' ) ? woocommerce_params.ajax_loader_url : woo_ultimate_search_config.search_icon, loader_icon = woo_ultimate_search_config.search_icon == '' ? def_loader : woo_ultimate_search_config.search_icon, search_button = $('.wcus_search_button'), min_chars = woo_ultimate_search_config.min_chars; search_button.on('click', function(){ var form = $(this).closest('form'); if( form.find('.wcus_search_term').val()==''){ return false; } return true; }); el.each( function(){ var $t = $(this), $form = $t.closest('form'), have_results = false, search_categories = $form.find('.wcus_search_categories'), post_type = $form.find('.wcus_post_type'), lang = ( $form.find('[name="lang"]').length > 0 ) ? $form.find('[name="lang"]').val() : '', append_to = ( typeof $t.data('append-to') == 'undefined') ? $t.closest('.wcus_wrapper') : $t.closest($t.data('append-to')), dropdown_width = ( typeof $t.data('results-width') == 'auto') ? 'auto' : $t.data('results-width'), defer_request_by = woo_ultimate_search_config.ajax_delay == '' ? 0 : woo_ultimate_search_config.ajax_delay; $t.wcusautocomplete({ minChars: min_chars, maxHeight: 150, appendTo: append_to, deferRequestBy: defer_request_by, width: dropdown_width, zIndex: 1, triggerSelectOnValidInput: false, serviceUrl: woo_ultimate_search_config.ajax_url + '&post_type=' + post_type.val()+ '&lang='+ lang, onSearchStart: function () { $t.css({'background-image': 'url(' + loader_icon + ')','background-repeat': 'no-repeat', 'background-position': 'center right'}); }, onSearchComplete: function () { $t.css('background-image', 'none'); $(window).trigger('resize'); $t.trigger('focus'); $(".wcus-autocomplete-suggestions").mCustomScrollbar({ theme:"dark", scrollButtons:{ enable:true } }); }, onSelect: function(suggestion){ if(suggestion.id != -1){ window.location.href = suggestion.url; } }, beforeRender: function (){ if(woo_ultimate_search_config.display_full_search_bar == 'true' && have_results ){ var params = {s: $t.val(), post_type: $form.find('.wcus_post_type').val()}; if ($form.find('.wcus_search_categories').length > 0) { params['product_cat'] = $form.find('.wcus_search_categories').val(); } var action = $form.attr('action'); var separator = action.indexOf('?') !== -1 ? "&" : "?"; var url = action + separator + $.param(params); var div_result = '<div class="link-result"><a href="' + url + '">' + woo_ultimate_search_config.full_search_text + '</a></div>'; $t.find('.wcus-autocomplete-suggestions').append(div_result); } }, transformResult: function (response) { response = typeof response === 'string' ? $.parseJSON(response) : response; have_results = response.results; return response ; }, formatResult: function (suggestion, currentValue) { var pattern = '(' + $.WCUSAutocomplete.utils.escapeRegExChars(currentValue) + ')'; var html = ''; if(typeof suggestion.img !== 'undefined'){ html += suggestion.img; } html += '<div class="wcus_result_content"><div class="title">'; html += suggestion.value.replace(new RegExp(pattern, 'gi'), '<strong>$1<\/strong>'); html += '</div>'; if(typeof suggestion.product_categories !== 'undefined'){ html += ' ' + suggestion.product_categories; } if(typeof suggestion.div_badge_open !== 'undefined'){ html += suggestion.div_badge_open; } if(typeof suggestion.on_sale !== 'undefined'){ html += suggestion.on_sale; } if(typeof suggestion.outofstock !== 'undefined'){ html += suggestion.outofstock; } if(typeof suggestion.featured !== 'undefined'){ html += suggestion.featured; } if(typeof suggestion.div_badge_close !== 'undefined'){ html += suggestion.div_badge_close; } if(typeof suggestion.price !== 'undefined' && suggestion.price != ''){ html += ' ' + woo_ultimate_search_config.price_text + ' ' + suggestion.price; } if(typeof suggestion.excerpt !== 'undefined'){ html += ' ' + suggestion.excerpt.replace(new RegExp(pattern, 'gi'), '<strong>$1<\/strong>'); } html += '</div>'; return html; } }); });

    Reply
    • malihu
      Posted on June 14, 2016 at 17:12 Permalink

      Hi,

      I haven’t worked with Devbridge Autocomplete before, but I think you could try the following:

      Since you’re calling mCustomScrollbar function each time a search is completed, it would make sense to destory (remove) the scrollbar when autocomplete box is closed. Something like this:

      onHide: function (container) { $(".wcus-autocomplete-suggestions").mCustomScrollbar("destroy"); }

      Reply
      • Jason
        Posted on June 16, 2016 at 06:27 Permalink

        Thanks a million malihu for your time and help.

        I tried your code and it didn’t work. The DevBridge Autocomplete doesn’t seem to have a “onHide” method.

        I may have to port my script over to the jQueryUI autocomplete. Been trying for days to get this to work.

        Reply
        • malihu
          Posted on June 16, 2016 at 14:39 Permalink

          I see. I saw the onHide option in plugin’s “Configuration Settings” so I thought that it might work.

          I didn’t have time to test it or create a demo with this plugin, but if you could create and send me a test page with your code I might be able to quickly check it and see if there’s an easy solution.

          Reply
          • Jason
            Posted on June 27, 2016 at 01:03 Permalink

            Got it working. Thanks Malihu.

            Seems I was using an older verion of the AutoComplete script which didn’t have an “onHide” method.
            Upgraded script and all works great now.

  5. Mrudul
    Posted on June 10, 2016 at 08:50 Permalink

    Thanks for sharing the post…
    It really helps a lot.
    I can see that it is working in Chrome, but does not work in old versions of IE like IE7 or IE6.
    Any comments or assistance on that part.

    Reply
    • malihu
      Posted on June 13, 2016 at 17:53 Permalink

      Hello,

      The plugin does not support IE versions below 8 (IE8 has approx. 2% worldwide usage while IE7 is non-existent).

      In general, you should not use jQuery plugins (esp. ones like custom scrollbar) for IE7, IE6 etc. (even if they work, performance won’t be good).
      If for some reason you want to support 10-15 year old browsers you should add a condition in your HTML and include/enable the plugin only on IE8 or later and leave browser’s native scrollbar for older ones.

      Reply
  6. Manuel
    Posted on June 9, 2016 at 17:57 Permalink

    Thanks for the plugin, maybe there is more than one already but I will not read the 5000 comments. here is and example of a directive for use it with angularjs

    (function() { 'use strict'; //references and documentation for the config http://manos.malihu.gr/jquery-custom-content-scroller/ angular .module('app') .directive('mScrollBar', mScrollBar); function mScrollBar () { // Usage: // <div m-scroll-bar></div> // Creates: // var directive = { link: link, restrict: 'A', scope: { config: '=?mScrollBar' } }; return directive; function link(scope, element, attrs) { if (scope.config) { $(element).mCustomScrollbar(scope.config); } else { $(element).mCustomScrollbar(); } } } })();

    and an example if you want to use it

    <div m-scroll-bar="{theme: 'minimal'}"> <p>bigggg paragraph blahh blahh ...</p> </div>

    Reply
  7. Vyacheslav
    Posted on June 8, 2016 at 15:25 Permalink

    Hello everybody!
    There is a problem with slippage scroll . This happens occasionally , for 3d or 4th scrolling – suddenly scroll length doubles .
    I don’t know what to do.
    Help me, please!

    Reply
    • malihu
      Posted on June 13, 2016 at 18:22 Permalink

      Hi,

      What do you mean by “slippage scroll”? Can you provide more info?

      Reply
  8. Dylan
    Posted on June 3, 2016 at 19:59 Permalink

    All files loaded but it keeps saying there is an error in jquery.mCustomScrollbar.concat.min.js. It keeps saying “Uncaught TypeError: e(…).load is not a function”. Help please.

    Reply
  9. santosh dhonde
    Posted on June 3, 2016 at 12:38 Permalink

    I have used this scroll bar, it working fine, but when i have use it a twice in same element inner element with different id or class it is not working for inner element it work only first element.

    Reply
  10. Rohit
    Posted on May 30, 2016 at 14:01 Permalink

    Hey Guys,

    Thank you for everything!
    You all are savior.
    I really want to make donation but not through pay pal is there any other way to donate?
    Thanks once again

    Reply
  11. georgina
    Posted on May 23, 2016 at 15:21 Permalink

    HI,
    is it possible to make dragger bar on center of dragger div by default ,on page loading ??

    Reply
    • malihu
      Posted on June 13, 2016 at 18:17 Permalink

      Hi,

      You can do it in more than one ways. The easiest/quickest would be:

      $("#content-1").mCustomScrollbar({ /* your options... */ }).mCustomScrollbar("scrollTo","50%",{scrollInertia:0});

      Reply
  12. Reef
    Posted on May 19, 2016 at 22:37 Permalink

    I am using this code on a css 3d rotate animation (flip card). When the backside of the card is flipped content that needs to be scrolled appears. Sometimes the mouse wheel with scroll this content sometimes it won’t. This is across all browsers. I would really appreciate if someone would point me in the right direction to fix this. I left the code the way it was downloaded, so the mouse wheel should scroll.

    Reply
  13. AJ
    Posted on May 19, 2016 at 21:51 Permalink

    I’m having problems getting the mousewheel scroll to work. I basically copied all the code from the demo and placed it in my template. The scrollto function works fine, but when I try to scroll with my mousewheel, it hardly moves.

    I have linked the files,
    jquery.mCustomScrollbar.concat.min.js
    jquery.mCustomScrollbar.css
    jquery.min.js

    What am I missing?

    Any help would be appreciated. Thank you in advance.

    http://beehivepicturehangers.com/new/faqs-new/

    Reply
  14. Evgeniy
    Posted on May 10, 2016 at 18:05 Permalink

    Hi All , i use RTL direction in HTML , usually horizontal scroll works fine and located on the right side of the needed content .
    But in other else – if by default, horizontal scroll doesn’t exist in HTML and i add needed content programmatically and the horizontal scroll appears – the horizontal scroll located on the Left !!! not right side of the content.
    Does anyboby know how can i fix this issue ?

    Thanx all , Evgeniy

    $("a[rel='add-content']").click(function(e){ e.preventDefault(); var markup="<p style='direction:rtl;'>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>"; $("#div_test").append(markup); $("#test_resizable").mCustomScrollbar("update"); });

    Reply
  15. PooMer
    Posted on May 7, 2016 at 01:36 Permalink

    Hi
    THX for the plugin

    I used HTML version of initialization but there is no scroll button.

    Any help would be appreciated.

    Reply
  16. Vincent Wansink
    Posted on May 6, 2016 at 02:17 Permalink

    For some reason I can’t get this to work. I’ve created a very basic test page like so, and it still doesn’t work. I’m loading jquery plus the custom scrollbar js and css. There are no javascript errors and the mCustomScrollBar() function is called and executed but the result is no scrollbar.

    What am I missing?

    <html> <head><title>Test</title></head> <link type="text/css" href="common/jquery/custom-scrollbar/jquery.mCustomScrollbar.min.css" /> <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script> <script type="text/javascript" src="common/jquery/custom-scrollbar/jquery.mCustomScrollbar.concat.min.js"></script> <style type=text/css> .content{height:140px;width:200px;overflow-y:auto;display:block;border:1px solid blue} </style> <body> <div class=content> <table> <tr><td>One</td></tr> <tr><td>Two</td></tr> <tr><td>Three</td></tr> <tr><td>Four</td></tr> <tr><td>Five</td></tr> <tr><td>Six</td></tr> <tr><td>Seven</td></tr> <tr><td>Eight</td></tr> <tr><td>Nine</td></tr> <tr><td>Ten</td></tr> <tr><td>Eleven</td></tr> <tr><td>Twelve</td></tr> <tr><td>Thirteen</td></tr> <tr><td>Fourteen</td></tr> <tr><td>Fifteen</td></tr> <tr><td>Sixteen</td></tr> <tr><td>Seventeen</td></tr> <tr><td>Eighteen</td></tr> <tr><td>Nineteen</td></tr> <tr><td>Twenty</td></tr> </table> </div> <script type=text/javascript> $(".content").mCustomScrollbar(); </script>

    Reply
  17. bryan
    Posted on May 5, 2016 at 22:27 Permalink

    Why is the current version still 3.1.3? Back in December I reported a bug and it was immediately fixed. The reply said it would be added to the 3.1.4 version.

    I made the fix myself in the local code and it worked, but I think that if the bug was fixed, the newer version of the file should be posted so that others get the fix for the bug.

    Thanks again for the great plugin.

    Reply
  18. Miroslav
    Posted on May 5, 2016 at 18:27 Permalink

    If I load the examples page

    http://manos.malihu.gr/repository/custom-scrollbar/demo/examples/scrollbar_themes_demo.html

    in a Microsoft phone’s browser you cannot drag and scroll content at all. It only works but extremely slow if click on the scroll bar. But it’s almost unusable.

    Can it be fixed?

    Thanks a lot!

    Reply

Comments pages: 1 74 75 76

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