https://github.com/parsisolution/os-scroll-chain

OverlayScrollbars Extension to prevent scroll chaining
https://github.com/parsisolution/os-scroll-chain

chaining overlayscrollbars-extension prevent scroll

Last synced: 5 months ago
JSON representation

OverlayScrollbars Extension to prevent scroll chaining

• Host: GitHub
• URL: https://github.com/parsisolution/os-scroll-chain
• Owner: parsisolution
• License: mit
• Created: 2018-10-20T08:31:52.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-24T08:41:31.000Z (over 3 years ago)
• Last Synced: 2025-10-24T18:40:51.592Z (8 months ago)
• Topics: chaining, overlayscrollbars-extension, prevent, scroll
• Language: JavaScript
• Size: 72.3 KB
• Stars: 7
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# os-scroll-chain

OverlayScrollbars Extension to prevent scroll chaining

[![](https://img.shields.io/github/package-json/v/parsisolution/os-scroll-chain?style=flat-square)](https://github.com/parsisolution/os-scroll-chain)

[![](https://img.shields.io/npm/l/pretty-checkbox.svg?style=flat-square&colorB=b8416b)](https://github.com/parsisolution/os-scroll-chain/blob/master/LICENSE)

[![](https://img.shields.io/npm/dt/os-scroll-chain.svg?style=flat-square)](https://www.npmjs.com/package/os-scroll-chain)

[![](https://data.jsdelivr.com/v1/package/npm/os-scroll-chain/badge)](https://www.jsdelivr.com/package/npm/os-scroll-chain)

[![](https://img.shields.io/bundlephobia/minzip/os-scroll-chain?style=flat-square)](https://www.jsdelivr.com/package/npm/os-scroll-chain)

## Installation

```sh

# with npm

npm install --save os-scroll-chain

# with yarn

yarn add os-scroll-chain

```

### Module

```js

// with es

import 'os-scroll-chain';

// with commonjs

require('os-scroll-chain');

```

### Browser

Include the script file from node_modules directory:

```html

```

Or you can use CDN:

```html

```

## Usage

Once installed, it can be added to OverlayScrollbars like this:

```js

instance.addExt('scroll-chain');

instance.addExt('scroll-chain', {vertical: false});

instance.addExt('scroll-chain', {vertical: true, horizontal: false});

```

### Options

| Option     | Type    | Default Value |

|------------|---------|---------------|

| vertical   | Boolean | true          |

| horizontal | Boolean | true          |

If you have discovered a 🐜 or have a feature suggestion, feel free to create an [issue](https://github.com/parsisolution/os-scroll-chain/issues) on Github.

# License

Released under The MIT [License](https://github.com/parsisolution/os-scroll-chain/blob/master/LICENSE). Copyright (c) hamed-ehtesham.