/trick-scrollbar

The native browser's scrollbar customized with some magic tricks ✨

Primary LanguageJavaScriptMIT LicenseMIT

trick-scrollbar

The native browser's scrollbar customized with some magic tricks ✨

Build License


Why trick-scrollbar?

trick-scrollbar don't emulate a scroll, it's the browser's own scroll but customized with some magic tricks.

  • It's native, it's efficient.
  • You can use plain JavaScript scrollTo, scrollTop and all native methods.
  • Is fully customizable.
  • Easy to use.
  • No dependencies.

Live preview

Coming soon..

How to use

First, don't set the CSS overflow as hidden because the scroll won't work.

<style>
  .scroll {
    height: 100%;
    width: 100%;
    overflow: auto;
  }
</style>

You need to include the trick-scrollbar.css file.

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

Import from ES module:

import TrickScrollbar from 'trick-scrollbar'

Import in browser:

<script src="dist/trick-scrollbar.js"></script>

Initialise:

const scrollContainer = document.querySelector('.scroll')
const scroller = new TrickScrollbar(scrollContainer)

License

MIT

TODO

  • Add support to horizontal scroll
  • Hide scrollbar when mouse is stopped
  • Finish the doc
  • Add tests
  • Publish to npm