this package is archived because release of the official version: https://github.com/KingSora/OverlayScrollbars/tree/master/packages/overlayscrollbars-vue

os-vue

Overlay Scrollbars Vue Component

Installation

yarn add os-vue
# or
npm i --save os-vue

Then import it in your js file and install it

import OverlayScrollbars from 'os-vue';

Vue.use(OverlayScrollbars);

Or

import OverlayScrollbars from 'os-vue/overlay-scrollbars';

Vue.component(OverlayScrollbars.name, OverlayScrollbars);

Usage

Once installed, it can be used in a template as simply as:

<overlay-scrollbars>
    <div v-for="item of count">{{ item }}</div>
</overlay-scrollbars>

You can also provide options

<overlay-scrollbars :options="os_options">
    <div v-for="item of count">{{ item }}</div>
</overlay-scrollbars>

To access OverlayScrollbars instance and for example add extensions to it see this example

If you have discovered a 🐜 or have a feature suggestion, feel free to create an issue on Github.

License

Released under The MIT License. Copyright (c) hamed-ehtesham.