# @giokaxo/smooth-scrollbar

> Customize scrollbar in modern browsers with smooth scrolling experience.

Latest version **8.5.4** (published 2020-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @giokaxo/smooth-scrollbar
pnpm add @giokaxo/smooth-scrollbar
yarn add @giokaxo/smooth-scrollbar
bun add @giokaxo/smooth-scrollbar
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.5.4 |
| Published | 2020-11-03 |
| First published | 2020-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 844.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Giorgi Kakhoshvili |
| Maintainers | giokaxo |
| Keywords | scrollbar, customize, acceleration, performance |

## Links

- npm: https://www.npmjs.com/package/@giokaxo/smooth-scrollbar
- Repository: https://github.com/giokaxo/smooth-scrollbar
- Homepage: https://github.com/giokaxo/smooth-scrollbar#readme
- Issues: https://github.com/giokaxo/smooth-scrollbar/issues
- npm.io page: https://npm.io/package/@giokaxo/smooth-scrollbar

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^1.10.0
- [core-js](https://npm.io/package/core-js.md) ^2.6.9
- [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.15

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 8.5.4 (latest) — 2020-11-03

## README

# Smooth Scrollbar

[![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][travis-badge]](https://travis-ci.org/idiotWu/smooth-scrollbar)
[![Gitpod Ready-to-Code][gitpod-badge]](https://gitpod.io/from-referrer/)

Customizable, Flexible, and High Performance Scrollbars!

## Installation

> ⚠️ DO NOT use custom scrollbars unless you know what you are doing. [Read more](docs/caveats.md)

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
<script src="dist/smooth-scrollbar.js"></script>

<script>
  var Scrollbar = window.Scrollbar;

  Scrollbar.init(document.querySelector('#my-scrollbar'));
</script>
```

## Documentation

| [latest](docs) | [7.x](https://github.com/idiotWu/smooth-scrollbar/tree/7.x) |
|----|----|

## Who's Using It

- [conference.awwwards.com](https://conference.awwwards.com/): Awwwards Conference - An Event for UX / UI Designers and Web Developers.
- [lp.anzi.kr](http://lp.anzi.kr/): Listeners Playlist.
- [Matter](https://matterapp.com/): A new and better way to grow your professional skills.
- Feel free to add yours here 🤗.

## 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
[travis-badge]: https://img.shields.io/travis/idiotWu/smooth-scrollbar.svg?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

---
_Source: https://npm.io/package/@giokaxo/smooth-scrollbar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._