@activix/double-scroll

A jQuery plugin that duplicate the bottom scrollbar of an element to its top

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@activix/double-scroll
Minified + gzip package size for @activix/double-scroll in KB

Readme

jQuery DoubleScroll Plugin

A Simple jQuery plugin to display additional scrollbar on top of the element. This plugin does not requires jQuery-UI

Usage

Call the doubleScroll function on the desired jQuery elements on page load :

$(document).ready(function() {
   $('.double-scroll').doubleScroll();
});

Options

You can configure the double scroll with the following options :

{
    contentElement: undefined, // Widest element, if not specified first child element will be used
    scrollCss: {
        'overflow-x': 'auto',
        'overflow-y': 'hidden'
    },
    contentCss: {
        'overflow-x': 'auto',
        'overflow-y': 'hidden'
    },
    onlyIfScroll: true, // top scrollbar is not shown if the bottom one is not present
    resetOnWindowResize: false // recompute the top ScrollBar requirements when the window is resized
}
contentElement

The element to use as the scroll reference. First child element is used if nothing is specified.

scrollCss

Key-Value pairs that allow you to customize the top scrollbar CSS.

contentCss

Key-Value pairs that allow you to customize the content CSS.

onlyIfScroll

If true, will display the top scrollbar only if the content is scrollable...

resetOnWindowResize

If true, will attach an event to regenerate the top scrollbar when the window is resized. Use it when the scrollable element has a width which is relative to the window width.

Licence

Dual licensed under the MIT and GPL licenses:

Authors

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.