![](\"https://mdbootstrap.com/img/Marketing/general/logo/medium/mdb-r.png\"){kind=logo}
\n \n\n \n \n \n
Minimalistic but perfect custom scrollbar plugin
\n\n\n
\n ![\"Downloads\"](\"https://img.shields.io/npm/dm/perfect-scrollbar.svg\")
\n ![\"License\"](\"https://img.shields.io/badge/license-MIT-green.svg\"){kind=icon}
\n ![\"npm\"](\"https://badge.fury.io/js/perfect-scrollbar.svg\"){kind=icon}
\n ![](\"https://img.shields.io/twitter/url/http/shields.io.svg?style=social\")
\n
![\"Filter](\"https://mdbootstrap.com/img/Marketing/products/jquery/plugins/datatable.jpg\")
| ![\"Filter](\"https://mdbootstrap.com/img/Marketing/products/jquery/plugins/treeview.jpg\")
| ![\"Filter](\"https://mdbootstrap.com/img/Marketing/products/jquery/plugins/filter.jpg\")
\n_________\n\n## Table of Contents\n\n* [Install](#install)\n* [Before using perfect-scrollbar](#before-using-perfect-scrollbar)\n* [Caveats](#caveats)\n* [How to use](#how-to-use)\n* [Options](#options)\n* [Events](#events)\n* [Helpdesk](#helpdesk)\n* [IE Support](#ie-support)\n* [License](#license)\n* [Related resources](#related-resources)\n* [Social media](#social-media)\n\n## Install\n\n#### Download now\n\nYou can manually download perfect-scrollbar [here](https://mdbootstrap.com/freebies/perfect-scrollbar/?utm_source=GitHub&utm_medium=PerfectScrollbar).\n\n#### npm\n\nYou can install and use perfect-scrollbar with npm. It's registered\nas [perfect-scrollbar](https://www.npmjs.com/package/perfect-scrollbar).\n\n```\n$ npm install om-perfect-scrollbar\n```\n#### From sources\n\nIf you want to use the development version of the plugin, build from source\nmanually. The development version may be unstable.\n\n```\n$ git clone https://github.com/omishyn/perfect-scrollbar.git\n$ cd perfect-scrollbar\n$ npm install\n$ npm run build\n```\n\n#### Unofficial sources\n\nSources not mentioned above are not maintained officially. If there are issues\nof the following sources, please ask and resolve in each repository.\n\n## Before using perfect-scrollbar\n\nThe following requirements should meet.\n\n* the container must have a `position` style.\n* the container must be a normal container element.\n\nThe following requirements are included in the basic CSS, but please keep in\nmind when you'd like to change the CSS files.\n\n* the container must have an `overflow: hidden` css style.\n* the scrollbar's position must be `absolute`.\n* the scrollbar-x must have `bottom` or `top`, and the scrollbar-y must have\n `right` or `left`.\n\nFinally, scroll hooking is generally considered as a bad practice, and\nperfect-scrollbar should be used carefully. Unless custom scroll is really\nneeded, using browser-native scroll is always recommended.\n\n## Caveats\n\nperfect-scrollbar emulates some scrolls, but not all of the kinds. It also *does not* work\nin some situations. You can find these cases in [Caveats](https://github.com/mdbootstrap/perfect-scrollbar/wiki/Caveats).\nBasically, items listed in the caveats are hacky to implement and may not be\nimplemented in the future. If the features are really needed, please consider\nusing browser-native scroll.\n\n## How to use\n\nFirst of all, please check if the container element meets the requirements and\nthe main CSS is imported.\n\n```html\n\n\n```\n\n\nImport via ES modules:\n\n```js\nimport PerfectScrollbar from 'om-perfect-scrollbar';\n```\n\nOr in browser:\n\n```html\n\n```\n\nTo initialise:\n\n```js\nconst container = document.querySelector('#container');\nconst ps = new PerfectScrollbar(container);\n\n// or just with selector string\nconst ps = new PerfectScrollbar('#container');\n```\n\nIt can be initialised with [options](#options).\n\n```js\nconst ps = new PerfectScrollbar('#container', {\n wheelSpeed: 2,\n wheelPropagation: true,\n minScrollbarLength: 20\n});\n```\n\nIf the size of your container or content changes, call `update`.\n\n```js\nps.update();\n```\n\nIf you want to destroy the scrollbar, use `destroy`.\n\n```js\nps.destroy();\nps = null; // to make sure garbages are collected\n```\n\nIf you want to scroll to somewhere, just update `scrollTop`.\n\n```js\nconst container = document.querySelector('#container');\ncontainer.scrollTop = 0;\n```\n\nYou can also get information about how to use the plugin from code in [`examples/`](examples).\n\n## Options\n\n### `handlers {String[]}`\n\nIt is a list of handlers to scroll the element.\n\n**Default**: `['click-rail', 'drag-thumb', 'keyboard', 'wheel', 'touch']`\n\n### `wheelSpeed {Number}`\n\nThe scroll speed applied to mousewheel event.\n\n**Default**: `1`\n\n### `wheelPropagation {Boolean}`\n\nIf this option is true, when the scroll reaches the end of the side, mousewheel\nevent will be propagated to parent element.\n\n**Default**: `true`\n\n### `swipeEasing {Boolean}`\n\nIf this option is true, swipe scrolling will be eased.\n\n**Default**: `true`\n\n### `minScrollbarLength {Number?}`\n\nWhen set to an integer value, the thumb part of the scrollbar will not shrink\nbelow that number of pixels.\n\n**Default**: `null`\n\n### `maxScrollbarLength {Number?}`\n\nWhen set to an integer value, the thumb part of the scrollbar will not expand\nover that number of pixels.\n\n**Default**: `null`\n\n### `scrollingThreshold {Number}`\n\nThis sets threshold for `ps--scrolling-x` and `ps--scrolling-y` classes to\nremain. In the default CSS, they make scrollbars shown regardless of hover\nstate. The unit is millisecond.\n\n**Default**: `1000`\n\n### `useBothWheelAxes {Boolean}`\n\nWhen set to true, and only one (vertical or horizontal) scrollbar is visible\nthen both vertical and horizontal scrolling will affect the scrollbar.\n\n**Default**: `false`\n\n### `suppressScrollX {Boolean}`\n\nWhen set to true, the scrollbar in X-axis will not be available, regardless of\nthe content width.\n\n**Default**: `false`\n\n### `suppressScrollY {Boolean}`\n\nWhen set to true, the scroll bar in Y-axis will not be available, regardless of\nthe content height.\n\n**Default**: `false`\n\n### `scrollXMarginOffset {Number}`\n\nThe number of pixels the content width can surpass the container width without\nenabling the X-axis scroll bar. Allows some \"wiggle room\" or \"offset break\", so\nthat X-axis scroll bar is not enabled just because of a few pixels.\n\n**Default**: `0`\n\n### `scrollYMarginOffset {Number}`\n\nThe number of pixels the content height can surpass the container height without\nenabling the Y-axis scroll bar. Allows some \"wiggle room\" or \"offset break\", so\nthat Y-axis scroll bar is not enabled just because of a few pixels.\n\n**Default**: `0`\n\n## Events\n\nperfect-scrollbar dispatches custom events.\n\n```js\ncontainer.addEventListener('ps-scroll-x', () => {/* ... */});\n```\n\n### `ps-scroll-y`\n\nThis event fires when the y-axis is scrolled in either direction.\n\n### `ps-scroll-x`\n\nThis event fires when the x-axis is scrolled in either direction.\n\n### `ps-scroll-up`\n\nThis event fires when scrolling upwards.\n\n### `ps-scroll-down`\n\nThis event fires when scrolling downwards.\n\n### `ps-scroll-left`\n\nThis event fires when scrolling to the left.\n\n### `ps-scroll-right`\n\nThis event fires when scrolling to the right.\n\n### `ps-y-reach-start`\n\nThis event fires when scrolling reaches the start of the y-axis.\n\n### `ps-y-reach-end`\n\nThis event fires when scrolling reaches the end of the y-axis (useful for\ninfinite scroll).\n\n### `ps-x-reach-start`\n\nThis event fires when scrolling reaches the start of the x-axis.\n\n### `ps-x-reach-end`\n\nThis event fires when scrolling reaches the end of the x-axis.\n\nYou can also watch the reach state via the `reach` property.\n\n```js\nconst ps = new PerfectScrollbar(/* ... */);\n\nconsole.log(ps.reach.x); // => 'start' or 'end' or null\nconsole.log(ps.reach.y); // => 'start' or 'end' or null\n```\n\n## Helpdesk\n\nIf you have any idea to improve this project or any problem using this, please\nfeel free to upload an [issue](https://github.com/mdbootstrap/perfect-scrollbar/issues).\n\nFor common problems, there is a [FAQ](https://github.com/mdbootstrap/perfect-scrollbar/wiki/FAQ) wiki\npage. Please check the page before uploading an issue.\n\nAlso, the project is not actively maintained. No maintainer is paid, and most of\nus are busy on our professional or personal works. Please understand that it may\ntake a while for an issue to be resolved. Uploading a PR would be the fastest\nway to fix an issue.\n\n## IE Support\n\nThe plugin is developed to work in modern MS browsers including Edge and IE11,\nbut may have some issues in IE11 mainly because of IE rendering bug concerning\nsync update on scroll properties. The problem is mentioned in\n[Caveats](https://github.com/mdbootstrap/perfect-scrollbar/wiki/Caveats) too.\n\nIE<11 is not supported, and patches to fix problems in IE<=10 will not be\naccepted. When old IEs should be supported, please fork the project and make\nmodification locally.\n\n## License\n\n[MIT](LICENSE)\n\n## Related resources\n\n- [Material Scrollbar](https://mdbootstrap.com/docs/jquery/javascript/scroll/?utm_source=GitHub&utm_medium=PerfectScrollbar)\n\n- [Table scroll](https://mdbootstrap.com/docs/jquery/tables/scroll/?utm_source=GitHub&utm_medium=PerfectScrollbar)\n\n- [Full screen scroller](https://mdbootstrap.com/plugins/jquery/screen-scroller/?utm_source=GitHub&utm_medium=PerfectScrollbar)\n\n- [Scrollspy](https://mdbootstrap.com/docs/jquery/navigation/scrollspy/?utm_source=GitHub&utm_medium=PerfectScrollbar)\n\n## Social Media\n\n - [Twitter](https://twitter.com/MDBootstrap)\n\n - [Facebook](https://www.facebook.com/mdbootstrap)\n\n - [Pinterest](https://pl.pinterest.com/mdbootstrap)\n\n - [Dribbble](https://dribbble.com/mdbootstrap)\n\n - [LinkedIn](https://www.linkedin.com/company/material-design-for-bootstrap)\n\n - [YouTube](https://www.youtube.com/channel/UC5CF7mLQZhvx8O5GODZAhdA)\n\n## MDB PRO\n\n - [Material Design for Bootstrap PRO](https://mdbootstrap.com/products/jquery-ui-kit/?utm_source=GitHub&utm_medium=PerfectScrollbar)\n","readmeFilename":"README.md"}