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 9 10 11 12 13 85

  1. Victor
    Posted on February 27, 2012 at 21:10 Permalink

    hello how are you, scrolls bar excellent, I have relieved much of work for my site, I’m using the right model I modified the style sheet but do not remove or increase the shadow that has the content box, I thought it was a png, so a remote file has to be coding but not where your configuration, you can helpme? thanks

    Reply
  2. nettino
    Posted on February 27, 2012 at 02:03 Permalink

    Great plugin though I had the problem using it on two columns floated left content. after some investigation occured that scrollAmount seemed to be calculated incorrectly (became negative), so I’ve added Math.abs to it and it’s working fine now:

    var scrollAmount=Math.abs(totalContent-(visibleHeight/bottomSpace))/(draggerContainerHeight-draggerHeight);
    line 316

    Reply
    • nettino
      Posted on February 27, 2012 at 02:34 Permalink

      actually Math.abs didn’t fix that (although initially ie appeared fixed.
      it was just .content lost his height – clearfix helped

      Reply
  3. Justin Clark
    Posted on February 20, 2012 at 23:20 Permalink

    Great plugin! I’m having an issue though:

    I can’t get it to work with JQuery UI Tabs. It seems that whatever tab is shown when the slider loads will display it properly, but it’s broken on every other tab.

    Example here

    Click between Bourbon and Tennessee to see the problem. If I load the page then quickly switch to Tennessee, that slider with work fine but Bourbon will be broken.

    Any help would be greatly appreciated!

    Reply
  4. Ton Gregorio
    Posted on February 20, 2012 at 14:54 Permalink

    Thank you for creating this jquery scroller!

    Used your scroller on a project I am currently working on..will let you know once launched!

    Reply
  5. Ernesto
    Posted on February 18, 2012 at 00:25 Permalink

    Hi,
    I’m using you plug-in and it’s great. But I’ve problems with elements that does not have the “id” attribute 🙂
    So I’ve changed the way it looks for components and now it works also with elements without the “id”:

    $.fn.mCustomScrollbar = function (scrollType, animSpeed, easeType, bottomSpace, draggerDimType, mouseWheelSupport, scrollBtnsSupport, scrollBtnsSpeed) { var $this = $(this); var $customScrollBox = $(".customScrollBox", $this); var $customScrollBox_container = $(".customScrollBox .container", $this); var $customScrollBox_content = $(".customScrollBox .content", $this); var $dragger_container = $(".dragger_container", $this); var $dragger = $(".dragger", $this); var $scrollUpBtn = $(".scrollUpBtn", $this); var $scrollDownBtn = $(".scrollDownBtn", $this); var $customScrollBox_horWrapper = $(".customScrollBox .horWrapper", $this); .....

    I hope it helps.
    Thanks.

    Reply
    • Gal
      Posted on February 20, 2012 at 14:47 Permalink

      Just wanted to do the same, you saved me a few minutes. Thanks.

      Reply
  6. Kaspar
    Posted on February 17, 2012 at 14:54 Permalink

    Hi,

    I’m trying to use this plugin with WordPress but I can’t get the mouse scrolling to work. The scroll works only when I drag it.. Any ideas?

    Reply
  7. Matt
    Posted on February 16, 2012 at 02:39 Permalink

    Is there a good way to hide the buttons when the contents are scrolled to their maximum? So initially the Up/Left button would be invisible, it would then change to visible once the content is scrolled, until the left value = 0 again. Likewise the Down/Right button would get hidden when the content is scrolled to the end.

    I’m willing to extend the existing plugin, but I’m hoping at least for a little direction.

    Is there a good way to check the scroll bounds when scrolling so I can implement this?

    Reply
  8. balboa
    Posted on February 15, 2012 at 17:02 Permalink

    Would be nice if you could pass the function which you could call when scroll bar reaches the end. In this way we can call load function for new content. Is it possible?

    Thanks

    balboa

    Reply
    • balboa
      Posted on February 16, 2012 at 13:26 Permalink

      Hi again,

      I modified your code in function Scroll in following way:

      function Scroll() {
      var draggerY = $dragger.position().top;
      var targY = -draggerY * scrollAmount;
      var thePos = $customScrollBox_container.position().top – targY;
      $customScrollBox_container.stop().animate({ top: “-=” + thePos }, animSpeed, easeType);
      if (draggerY == $dragger_container.height() – $dragger.height())
      bottomReachedFunction();
      }

      and the function declaration:

      $.fn.mCustomScrollbar = function (scrollType, animSpeed, easeType, bottomSpace, draggerDimType, mouseWheelSupport, scrollBtnsSupport, scrollBtnsSpeed, bottomReachedFunction) {

      so now i am using your plugin in way:

      $(window).load(function () {
      $(“#mcs_container”).mCustomScrollbar(“vertical”, 400, “easeOutCirc”, 1.05, 20, “yes”, “yes”, 10, bottomReached);
      });

      function bottomReached() {
      alert(‘bottom reached’);
      }

      I don’t know if it is best way to do it but now I can pass the function for loading new content or hiding arrows or so. Of course it should be done for horizontal scroll. I f you find it useful you can update your plugin 🙂

      cheers

      balboa

      Reply
  9. Saurabh
    Posted on February 15, 2012 at 15:47 Permalink

    this plugin is not working within a table :/ but works without a table
    please help me up with this

    Reply
    • Saurabh
      Posted on February 16, 2012 at 16:08 Permalink

      Can someone resolve my problem?
      i need to use this plugin within a table but its not working within a table

      Reply
  10. pedro
    Posted on February 14, 2012 at 19:35 Permalink

    I’m having a strange problem. When I scroll down the content instead of going up is going down. Anyone knows why?? Thanks

    Reply
    • pedro
      Posted on February 14, 2012 at 20:00 Permalink

      OK. My are float:left; if they are floar:none the scroll as it is suppose. Bu t I realy nead to specify the float, bacause I have side-by-side . Any ideas?? Thanks

      Reply
  11. samueljesse
    Posted on February 13, 2012 at 04:34 Permalink

    I’m having issues making #mcs3_container work without absolute positioning. Is this possible? I have a fluid layout and want the horizontal positioning, and width and height of the content to change, and the scrollbar be used when required.

    Is this possible?

    Thanks

    Reply
  12. Yury
    Posted on February 13, 2012 at 00:14 Permalink

    Hej, Malihu!
    Thanks for the great tool!

    I also got a problem with a horizontal scroll.
    The scroller itself moving just fine, but the images are not.
    If I test the page I try your scroll at in the offline browser (running the content from my hard drive) the scroll works just fine!
    But when I upload it to my hosting and running on WEB the problem appears.

    Do you have any idea about how to fix it?
    Here is the link: http://zaklep.spb.ru/lenztest/index.html

    I read the comments through but didn’t find anything that would work for me.
    Thank you.

    Reply
  13. Sarees
    Posted on February 9, 2012 at 11:35 Permalink

    Really Very Nice Blog. Its very useful stuff. Thanks for sharing it. Keep sharing more such useful stuff.

    Reply
    • Mirko
      Posted on February 12, 2012 at 19:54 Permalink

      Thanks Malihu for the great script.But i have one problem, i can’t find a way to put all of my content inside the scrollable area.It always chops the last few sentences.
      One person above also had the same issue, but no one responded.
      So i have put the files online, just click on Biography tab, and you will see what i mean.There should be one more sentence, but it is cut off.
      I think it is Css related, but i have tried everything, and i just can’t get it to work.

      Link: http://www.madebym.net/test/index.html
      Thanks!

      Reply
      • Mirko
        Posted on February 14, 2012 at 16:31 Permalink

        A little edit to my post, i managed to get it to work, but only with the non-adjustable version.
        Still can’t get the others to accomodate all of my content.

        Reply
  14. Simon Dau
    Posted on February 6, 2012 at 17:46 Permalink

    Hi Malihu,

    I have updated the mobile plugin extension to add some custom parameters. Now you can choose between vertical/horizontal scrolling as well as scrolling distance.

    http://www.blog.kartogram.co.uk/post.cfm/jquery-custom-scroller-mobile-ext

    Simon

    Reply
  15. David
    Posted on February 6, 2012 at 16:04 Permalink

    Hello!

    I’m very stuck on this.. please excuse my newbieness;

    I have merged parts of blogger with my website, however i’m unhappy with the scroll bar; I’m guessing I would have to add this script that is mentioned here to blogger but i’m quite confused about the steps of doing so..

    here is the page http://fatcatgigs.com/uploads/3.0/home.html

    any help would be wonderful! (starting at step1!) 🙂

    Reply
  16. Nils
    Posted on February 6, 2012 at 15:05 Permalink

    Hi!

    great plugin, works awesome!

    However, is there any way to utilize css-tranformations for the animation instead of javascript? I’ve tried briefly whith https://github.com/benbarnett/jQuery-Animate-Enhanced but the animation gets jerky and erratic. Any ideas?

    Reply
  17. Wilson De Jesus
    Posted on February 5, 2012 at 00:41 Permalink

    Does anybody know how to do anchor points to the sections in the scrollbar. I tried adding them as a regular HTML anchor point and it didn’t work. Any help would be greatly appreciated.

    Will

    Reply
  18. McMouse
    Posted on February 4, 2012 at 22:00 Permalink

    I didn’t have the errors and erratic behavior you are experiencing, but I did make a little script to resize on window resize. Not sure if it will help you but here it is if it does:

    $(window).resize(function(){ var totalHeight = $('#main').height() - ($('#top').height() + $('#bottom').height()); $('#mcs_container .dragger_container').css('height', totalHeight-70); $('#mcs_container').css('height', totalHeight); }

    Reply
  19. Tomas Sandven
    Posted on February 4, 2012 at 17:04 Permalink

    First of all, I’m using Chrome 16.0.912.77 m 🙂

    I’m having a problem with resizing the outer container. It seems like your script assumes that the outer container always has a constant size. When I (for instance) fill the screen with a box (position: absolute; top: 0px, right: 0px; bottom: 0px; left: 0px;) and apply your script to it, it get very odd behaviour when resizing the window.

    If I increase the height of the window beyond the bottom of the content of the box, the content doesn’t follow the bottom of the window. The dragger then indicates that I’m still at the bottom of the box, even though I’m far, far below it. If at any point I scroll or touch the dragger, the content snaps back into place and everything works again.

    If I decrease the height of the window while the dragger is at “top: 0” then the dragger leaves it’s container and floats too far up. Again, the second I scroll or move the dragger, everything snaps into place and works again. This leads me to think that there’s a simple fix to this issue.

    To summarize, any resizing of the window like maximizing, restoring or just plain edge-pulling, makes your scrollbar script explode, and scrolling in the box instantly fixes the issue. If I could somehow emit a “scroll event” every time the window has been resized. Any ideas?

    Also I think your script has a memory leak. Just for fun I set $('#mycontainer').mCustomScrollbar(...); to run every second. After a short lunch break my page was running extremely sluggish and it took a few attempts to close the window.

    Reply
    • Tomas Sandven
      Posted on February 4, 2012 at 17:16 Permalink

      Also, I’ve tried to call mCustomScrollbar on window resize, but not only does it not work, it makes the page go sluggish in just a few seconds of resizing. I’m currently trying to hack the script to scroll to top on window resize as a temporary solution

      Reply
  20. Stiker Motor
    Posted on February 4, 2012 at 12:43 Permalink

    Thank you for you custom scrollbar plugin

    Reply
  21. McMouse
    Posted on February 4, 2012 at 09:25 Permalink

    Hi Malihu! I just stumbled across this scrollbar, and it looks absolutely perfect for my website. However, I’m having a devil of a time getting my page to load jquery.mCustomScrollbar.js. As far as I can tell the directory structure is set up correctly, and the include is in the right place and formatted correctly. When I attempt it locally, the script does not even register as being loaded. Now that I’ve hosted my protosite, it loads but does not function. Maybe someone could take a look and tell me where I messed up? I’ve been over the guide and comments several times and didn’t find any solutions, though I may simply be too tired right now ><

    Here's my code, apologies for the color scheme : http://lookingforgroup.net/ScrollTest/DockingTest3.htm

    Thanks in advance for your help!

    Reply
    • McMouse
      Posted on February 4, 2012 at 09:28 Permalink

      After hours searching… it was an extra bracket. Seems to be fixed now, though I need to rework my dynamic content. Thanks anyway!

      Reply
  22. kristin Schreiber
    Posted on February 3, 2012 at 00:26 Permalink

    I am trying to change the height of the content box but when I do the dragger grows in height with the height of the container box. Am I missing something in the JS or css file that controls the size of the dragger?

    thanks for any advice. Great script and nice scrolling feature.

    Reply
  23. von
    Posted on February 1, 2012 at 11:38 Permalink

    Hi,

    Why is that the scrollbar buttons doesn’t work if I resize the browser and the buttons reached each other? The dragger and mousewheel works perfectly, it’s just that the buttons.

    Thanks!

    Reply
  24. Salustiano Silva
    Posted on January 31, 2012 at 22:13 Permalink

    I’ve found that the scrollbar unload process is incomplete.
    At the current date (2012-01-31) I’ve downloaded the script from this page, and notice that, if the content is shorter then the container, the mouse wheel is still binded, thus causing a misbehavior.

    To solve it:
    where it is commented “//disable scrollbar if content is short”, add the unbind method for the mousewheel:

    $customScrollBox.unbind("mousewheel");

    Hope it helps some of you with the same problem!

    Reply
  25. Ward van den Berg
    Posted on January 28, 2012 at 20:52 Permalink

    Hi there,

    Very good plugin! Compliments!
    If you don’t object, I’d like to use it in my new site.

    One question though…
    I use a later jquery version and it appears that the scroll only works in Firefox…
    In all other browsers, the scrollbar moves alright, but the content doesn’t…
    When I use your link to the Google api jquery 1.4.4 it works fine.

    Any idea why this is?
    Thanks!

    Ward

    Reply
  26. Eddie Reyes
    Posted on January 28, 2012 at 05:33 Permalink

    Thanks for such a great plugin!

    I have a question about a weird thing happening for me.
    The scroller loads OK, but after using it, the javascript computed margin-top css never resets to “0”.

    Example: ( on load )
    <div class="container" margin-top:0px;="

    (on usage )

    http://wilshirerestaurant.com/press/

    Any ideas?

    Reply
  27. Alessandro Mariani
    Posted on January 25, 2012 at 13:34 Permalink

    i was very satisfied but i tried it with my mobile and it doesnt work at all…arrows and scroll as well…
    why?

    Reply
  28. Alessandro Mariani
    Posted on January 25, 2012 at 13:00 Permalink

    Very great job!…compliments!

    Reply
  29. Michael
    Posted on January 24, 2012 at 03:50 Permalink

    Hi, I keep getting this error on IE
    jquery.Custom Scrollbar $dragger.position()top not specified or null?
    Site: http://nagomedia.pl/index.php?id=8

    Any idea what might be the problem?

    Reply
  30. Robert
    Posted on January 20, 2012 at 21:27 Permalink

    I’m trying to use this to scroll the text on this
    http://www.csslab.cl/2011/08/18/jquery-timelinr/comment-page-6/#comment-46104
    Demo: http://www.csslab.cl/ejemplos/timelinr/latest/horizontal.html
    and it’s just not working, at all. I have placed all the code inside where the content is, the scroll finally appeared but its funy, doesn’t actually scroll, and when I hit the arrows on the timeline the content of the previous section doesn’t go away. Please help, sort of new with jquery 🙁

    Reply

Comments pages: 1 9 10 11 12 13 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