# vue-body-scroll-lock

> Vue plugin to disable scrolling page. Built on top of [https://www.npmjs.com/package/scroll-lock](https://www.npmjs.com/package/scroll-lock) For better use, check out the [scroll-lock](https://www.npmjs.com/package/scroll-lock) documentation

Latest version **2.0.2** (published 2021-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-body-scroll-lock
pnpm add vue-body-scroll-lock
yarn add vue-body-scroll-lock
bun add vue-body-scroll-lock
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2021-05-12 |
| First published | 2021-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 469.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Rustam |
| Maintainers | 17axah |
| Keywords | vue-scroll-lock, body-scroll-lock, scroll-lock, v-scroll-lock |

## Links

- npm: https://www.npmjs.com/package/vue-body-scroll-lock
- Repository: https://github.com/17axah/vue-body-scroll-lock
- Homepage: https://github.com/17axah/vue-body-scroll-lock#readme
- Issues: https://github.com/17axah/vue-body-scroll-lock/issues
- npm.io page: https://npm.io/package/vue-body-scroll-lock

## Dependencies (3)

- [vue](https://npm.io/package/vue.md) ^2.6.11
- [core-js](https://npm.io/package/core-js.md) ^3.6.5
- [scroll-lock](https://npm.io/package/scroll-lock.md) ^2.1.5

## Recent versions

- 2.0.2 (latest) — 2021-05-12
- 2.0.1 — 2021-05-12
- 2.0.0 — 2021-05-07
- 1.0.6 — 2021-05-07
- 1.0.5 — 2021-05-07
- 1.0.4 — 2021-05-07
- 1.0.2 — 2021-05-07
- 1.0.1 — 2021-05-07
- 1.0.0 — 2021-05-07

## README

# vue-body-scroll-lock

Vue plugin to disable scrolling page.
Built on top of [https://www.npmjs.com/package/scroll-lock](https://www.npmjs.com/package/scroll-lock)
For better use, check out the [scroll-lock](https://www.npmjs.com/package/scroll-lock) documentation

## Installation

```bash
$ npm i vue-body-scroll-lock
```

## Usage (global)

```js
import Vue from 'vue';
import VueBodyScrollLock from 'vue-body-scroll-lock';

Vue.use(VueBodyScrollLock);
```

## Usage (local)

```html
<div v-scroll-lock="value"></div>

<!-- with gap method: -->
<div v-scroll-lock:padding="value"></div>
<div v-scroll-lock:margin="value"></div>
```

```js
<script>
import { directive } from 'vue-body-scroll-lock';

export default {
    directives: {
        scrollLock: directive,
    },
    data() {
        return {
            value: false
        }
    }
};
</script>
```

You can also use attributes from the [scroll-lock](https://www.npmjs.com/package/scroll-lock) module:
***data-scroll-lock-fill-gap***, ***data-scroll-lock-scrollable***, ***data-scroll-lock-lockable***

---
_Source: https://npm.io/package/vue-body-scroll-lock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._