smooth-scrollbar

smooth-scrollbar

Customize scrollbar in modern browsers with smooth scrolling experience.

Browser Compatibility

Browser	Version
IE	10+
Chrome	22+
Firefox	16+
Safari	8+
Android Browser	4+
Chrome for Android	32+
iOS Safari	7+

Install

Via npm:

npm install smooth-scrollbar --save

Via bower:

bower install smooth-scrollbar --save

Demo

http://idiotwu.github.io/smooth-scrollbar/

Why is native scrolling slow?

As is explained in this article, browser repaint every frame in scrolling. Less painting is better.

To avoid repainting, I use translate3d in scroll content to create composite layers and force hardware accelerating.

Usage

Smooth scrollbar is defined as an UMD module which named Scrollbar, you can use any loader to load it:

import Scrollbar from 'smooth-scrollbar';

Or get it from window object:

const { Scrollbar } = window;

Don't forget to include the stylesheet in your page:

<link rel="stylesheet" href="dist/smooth-scrollbar.css">

Here're three ways to tell the plugin which element should be a smooth scrollbar:

1. As an element:

   <scrollbar>
       ...
   </scrollbar>
   

2. As an attribute:

   <section scrollbar>
       ...
   </section>
   

3. As a data attribute

   <section data-scrollbar>
       ...
   </section>
   

Then init all scrollbars:

Scrollbar.initAll(options);

Or you can call Scrollbar.init(elem, options) to manually init the scrollbar.

Available Options for Scrollbar

parameter	type	default	description
speed	Number	1	Scrolling speed scale.
fricton	Number	10	Scrolling fricton, a percentage value within (1, 100)
ignoreEvents	Array	[ RegExp ]	A list of events names that are ignored, all handled events are: ["blur", "click", "dragend", "dragover", "dragstart", "focus", "keydown", "mousedown", "mousemove", "mouseup", "resize", "scroll", "selectstart", "touchend", "touchmove", "touchstart", "wheel"]

Confusing with the option field? Try edit tool here!

DOM Structure

Following is the DOM structure that Scrollbar generated:

<scrollbar>
    <article class="scroll-content">
        your contents here...
    </article>
    <aside class="scrollbar-track scrollbar-track-x">
        <div class="scrollbar-thumb scrollbar-thumb-x"></div>
    </aside>
    <aside class="scrollbar-track scrollbar-track-y">
        <div class="scrollbar-thumb scrollbar-thumb-y"></div>
    </aside>
</scrollbar>

APIs

• Scrollbar API Documents
• Instance API Documents

Scrollbar

• Scrollbar.init( element, [options] )
• Scrollbar.initAll( [options] )
• Scrollbar.has( element )
• Scrollbar.get( element )
• Scrollbar.getAll()
• Scrollbar.destroy( element )
• Scrollbar.destroyAll()

Instance

Properties

• instance#targets
• instance#offset
• instance#limit
• instance#scrollTop
• instance#scrollLeft

Methods

• instance#update( [async] )
• instance#getSize()
• instance#setPosition( x, y )
• instance#scrollTo( x, y, [duration], [callback] )
• instance#addListener( fn )
• instance#removeListener( fn )
• instance#infiniteScroll( callback, [threshold] )
• instance#destroy()
• instance#getContentElem()
• instance#showTrack( direction )
• instance#hideTrack()

Work with RubaXa/Sortable

Details here.

Related

• angular-smooth-scrollbar
• react-smooth-scrollbar

Todo

• Overscroll effect.

Changelog

4.2.0

• Add ignoreEvents support.

4.1.0

• Reduce movement at container's edge.

4.0.0

• Movement based scrolling algorithm.
• Reduce options, simple is better :)

3.1.0

• Use quadratic curve to perform scrollTo method.

3.0.0

• New easing algorithm.
• Dependency free!

License

MIT.