1.0.0 • Published 6 years ago
lock-body-scroll v1.0.0
Lock body scroll
Lock/unlock body scrolling when modal is opened.
Installation
$ yarn add lock-body-scroll
or
$ npm i lock-body-scrollUsage
ES modules
import createLocker from 'lock-body-scroll'
const locker = createLocker()
// or
const locker = createLocker(options)
locker.lock()
locker.unlock()CommonJS
const createLocker = require('lock-body-scroll')
const locker = createLocker()
locker.lock()
locker.unlock()Browser
HTML:
<head>
<script src="lock-body-scroll.min.js" />
</head>JavaScript:
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.