https://github.com/Grsmto/simplebar

Custom scrollbars vanilla javascript library with native scroll, done simple, lightweight, easy to use and cross-browser.
https://github.com/Grsmto/simplebar

Last synced: 3 months ago
JSON representation

Custom scrollbars vanilla javascript library with native scroll, done simple, lightweight, easy to use and cross-browser.

• Host: GitHub
• URL: https://github.com/Grsmto/simplebar
• Owner: Grsmto
• License: mit
• Created: 2013-05-29T20:39:40.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T19:31:02.000Z (8 months ago)
• Last Synced: 2024-05-17T14:05:26.814Z (8 months ago)
• Language: TypeScript
• Homepage: http://grsmto.github.io/simplebar/
• Size: 19 MB
• Stars: 5,869
• Watchers: 69
• Forks: 534
• Open Issues: 97
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - Grsmto/simplebar - Custom scrollbars vanilla javascript library with native scroll, done simple, lightweight, easy to use and cross-browser. (TypeScript)
• awesome-libraries - simplebar
• my-awesome-list - simplebar - browser. | Grsmto | 6136 | (TypeScript)

README

        


  








  

  

  

  






SimpleBar does only one thing: replace the browser's default scrollbar with a custom CSS-styled one without losing performances.

Unlike some popular plugins, SimpleBar doesn't mimic scroll with Javascript, causing janks and strange scrolling behaviours...

You keep the awesomeness of native scrolling...with a custom scrollbar!

SimpleBar **does NOT implement a custom scroll behaviour**. It keeps the **native** `overflow: auto` scroll and **only** replace the scrollbar visual appearance.

- **🐦 Follow me on [Twitter!](https://twitter.com/adriendenat) or [Mastodon!](https://mas.to/@adrien)**

- **👨‍💻 If you like Simplebar, [buy me a coffee!](adriendenat)**



#### Design it as you want

SimpleBar uses pure CSS to style the scrollbar. You can easily customize it as you want! Or even have multiple style on the same page...or just keep the default style ("Mac OS" scrollbar style).

#### Lightweight and performant

Only 6kb minified. SimpleBar doesn't use Javascript to handle scrolling. You keep the performances/behaviours of the native scroll.

#### Supported everywhere

SimpleBar has been tested on the following browsers: Chrome, Firefox, Safari, Edge, IE11.

### Getting started

The easiest way to use SimpleBar is with the default dependency-free version: `npm install simplebar`.

- [Core documention](https://github.com/Grsmto/simplebar/tree/master/packages/simplebar)

If you are using a framework, SimpleBar also supports the most popular ones: Vue, Angular and React.

- [React documention](https://github.com/Grsmto/simplebar/tree/master/packages/simplebar-react)

- [Angular documentation](https://github.com/Grsmto/simplebar/tree/master/packages/simplebar-angular)

- [Vue documentation](https://github.com/Grsmto/simplebar/tree/master/packages/simplebar-vue)

### Demo

You can check our [demo page](https://grsmto.github.io/simplebar/examples) (which is also the one we use for automated tests).

### Changelog

See changelog here : https://github.com/Grsmto/simplebar/releases

### Credits

- [KingSora](https://github.com/KingSora) for multiple features and inspirations (`height: auto` detection, RTL mode cross browser support and more) with [OverlayScrollbars](https://kingsora.github.io/OverlayScrollbars/).

- [Jonathan Nicol](http://www.f6design.com/) for original idea with [Trackpad Scroll Emulator](https://github.com/jnicol/trackpad-scroll-emulator).

- [Cassio Bittencourt](https://cassiobittencourt.com/) for the logo design.