https://github.com/nuxt-contrib/lock-body-scroll
https://github.com/nuxt-contrib/lock-body-scroll
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nuxt-contrib/lock-body-scroll
- Owner: nuxt-contrib
- License: mit
- Created: 2018-10-10T09:17:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T11:39:39.000Z (almost 2 years ago)
- Last Synced: 2025-06-09T12:48:17.411Z (5 months ago)
- Language: JavaScript
- Size: 127 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Lock body scroll
> 🌈 Lock/unlock body scrolling when modal is opened
[![Standard JS][standard-js-src]][standard-js-href]
[![Circle CI][circle-ci-src]][circle-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
## Installation
```bash
$ yarn add lock-body-scroll
or
$ npm i lock-body-scroll
```
## Usage
### ES modules
```js
import createLocker from 'lock-body-scroll'
const locker = createLocker()
// or
const locker = createLocker(options)
locker.lock()
locker.unlock()
```
### CommonJS
```js
const createLocker = require('lock-body-scroll')
const locker = createLocker()
locker.lock()
locker.unlock()
```
### Browser
HTML:
```html
```
JavaScript:
```js
const locker = window.createLocker()
locker.lock()
locker.unlock()
```
## Options
### scrollElement
Default: `document.scrollingElement || document.documentElement`
The dom element which is for locking scrolling
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT][license--href]
[standard-js-src]: https://flat.badgen.net/badge/code%20style/standard/green
[standard-js-href]: https://standardjs.com
[circle-ci-src]: https://flat.badgen.net/circleci/github/clarkdo/lock-body-scroll
[circle-ci-href]: https://circleci.com/gh/clarkdo/lock-body-scroll
[codecov-src]: https://flat.badgen.net/codecov/c/github/clarkdo/lock-body-scroll
[codecov-href]: https://codecov.io/gh/clarkdo/lock-body-scroll
[npm-version-src]: https://flat.badgen.net/npm/v/lock-body-scroll/latest
[npm-version-href]: https://npmjs.com/package/lock-body-scroll
[npm-downloads-src]: https://flat.badgen.net/npm/dt/lock-body-scroll
[npm-downloads-href]: https://npmjs.com/package/lock-body-scroll
[license--href]: https://github.com/clarkdo/lock-body-scroll/blob/master/LICENSE