Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idiotWu/smooth-scrollbar
Customizable, Extendable, and High-Performance JavaScript-Based Scrollbar Solution.
https://github.com/idiotWu/smooth-scrollbar
custom-scrollbar frontend javascript javascript-scrollbar-plugin scrollbar smooth-scrollbar smooth-scrolling
Last synced: 3 months ago
JSON representation
Customizable, Extendable, and High-Performance JavaScript-Based Scrollbar Solution.
- Host: GitHub
- URL: https://github.com/idiotWu/smooth-scrollbar
- Owner: idiotWu
- License: mit
- Created: 2015-12-09T09:20:27.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2023-06-06T05:20:24.000Z (over 1 year ago)
- Last Synced: 2024-04-14T16:20:02.139Z (7 months ago)
- Topics: custom-scrollbar, frontend, javascript, javascript-scrollbar-plugin, scrollbar, smooth-scrollbar, smooth-scrolling
- Language: TypeScript
- Homepage: https://idiotwu.github.io/smooth-scrollbar/
- Size: 5.48 MB
- Stars: 3,275
- Watchers: 28
- Forks: 389
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Smooth Scrollbar
**Customizable, Flexible, and High Performance Scrollbars!**
[![npm][npm-version-badge]](https://www.npmjs.com/package/smooth-scrollbar)
[![monthly downloads][npm-downloads-badge]](https://www.npmjs.com/package/smooth-scrollbar)
[![core size][size-badge]](dist/smooth-scrollbar.js)
[![gzip size][gzip-size-badge]](dist/smooth-scrollbar.js)
[![Build status][github-action-badge]](https://github.com/idiotWu/smooth-scrollbar/actions/workflows/deploy.yml)
[![Gitpod Ready-to-Code][gitpod-badge]](https://gitpod.io/from-referrer/)
## Installation
> ⚠️ DO NOT use custom scrollbars unless you know what you are doing. [Read more](docs/caveats.md)
> [Tell us about the features you want in the next major update](https://github.com/idiotWu/smooth-scrollbar/discussions/392).
Via NPM **(recommended)**:
```
npm install smooth-scrollbar --save
```
Via Bower:
```
bower install smooth-scrollbar --save
```
## Browser Compatibility
| Browser | Version |
| :------ | :-----: |
| IE | 10+ |
| Chrome | 22+ |
| Firefox | 16+ |
| Safari | 8+ |
| Android Browser | 4+ |
| Chrome for Android | 32+ |
| iOS Safari | 7+ |
## Demo
https://idiotwu.github.io/smooth-scrollbar/
## Usage
Since this package has a [pkg.module](https://github.com/rollup/rollup/wiki/pkg.module) field, it's highly recommended to import it as an ES6 module with some bundlers like [webpack](https://webpack.js.org/) or [rollup](https://rollupjs.org/):
```js
import Scrollbar from 'smooth-scrollbar';
Scrollbar.init(document.querySelector('#my-scrollbar'));
```
If you are not using any bundlers, you can just load the UMD bundle:
```html
var Scrollbar = window.Scrollbar;
Scrollbar.init(document.querySelector('#my-scrollbar'));
```
## Documentation
| [latest](docs) | [7.x](https://github.com/idiotWu/smooth-scrollbar/tree/7.x) |
|----|----|
## FAQ
- How to **deal with `position: fixed` elements**? [#362](https://github.com/idiotWu/smooth-scrollbar/discussions/362#discussioncomment-854090)
- How to **temporarily stop scrolling**? [#361](https://github.com/idiotWu/smooth-scrollbar/discussions/361#discussioncomment-854079)
- How to **enable hash/anchor scrolling**? [#360](https://github.com/idiotWu/smooth-scrollbar/discussions/360#discussioncomment-854071)
- How to **direct all scrolling to a particular direction**? [#359](https://github.com/idiotWu/smooth-scrollbar/discussions/359#discussioncomment-854052)
- How to **disable scrolling in a particular direction**? [#357](https://github.com/idiotWu/smooth-scrollbar/discussions/357#discussioncomment-854036)
- [more...](https://github.com/idiotWu/smooth-scrollbar/discussions/categories/faq)
## Who's Using It
- [Awwwards Conference](https://conference.awwwards.com/): An Event for UX / UI Designers and Web Developers.
- [Listeners Playlist](http://lp.anzi.kr/): A cool music player designed by Jiyong Ahn sharing musics from the facebook group 'Listeners Playlist'.
- [Matter](https://matterapp.com/): A new and better way to grow your professional skills.
- [Parsons Branding](https://www.parsonsbranding.com/): Brand strategy and design studio based in Cape Town.
- [zer0bin](https://zer0b.in): Just a place to paste
- Feel free to add yours here 🤗.
## Credits
- [Logo](https://github.com/idiotWu/smooth-scrollbar/discussions/461) by Kainoa Kanter ([@ThatOneCalculator](https://github.com/ThatOneCalculator))
## License
[MIT](LICENSE)
[npm-version-badge]: https://img.shields.io/npm/v/smooth-scrollbar.svg?style=for-the-badge
[npm-downloads-badge]: https://img.shields.io/npm/dm/smooth-scrollbar.svg?style=for-the-badge
[github-action-badge]: https://img.shields.io/github/actions/workflow/status/idiotWu/smooth-scrollbar/deploy.yml?branch=master&style=for-the-badge
[size-badge]: http://img.badgesize.io/idiotWu/smooth-scrollbar/master/dist/smooth-scrollbar.js?label=core%20size&style=for-the-badge
[gzip-size-badge]: http://img.badgesize.io/idiotWu/smooth-scrollbar/master/dist/smooth-scrollbar.js?label=gzip%20size&compression=gzip&style=for-the-badge
[gitpod-badge]: https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?style=for-the-badge