tua-body-scroll-lock

> inspired by body-scroll-lock

English | 简体中文

Introduction

tua-body-scroll-lock enables body scroll locking for everything.

$3

* Doesn't work on Android webview
* Doesn't work on PC with mouse wheel
* Doesn't work on iOS, if you touch somewhere instead of targetElement
* Must pass targetElement, even if it's not necessary

Try This

Install

$3

``bash
$ npm i -S tua-body-scroll-lock


OR


$ yarn add tua-body-scroll-lock
`

$3

* UMD(tua-bsl.umd.js)
* unpkg
* jsdelivr

`html





`

* Minified UMD(tua-bsl.umd.min.js)
* unpkg
* jsdelivr

`html





`

Usage

$3

`js
import { lock, unlock } from 'tua-body-scroll-lock'

lock()
unlock()
`

$3

In some scenarios, when scrolling is prohibited, some elements still need to scroll, at this point, pass the targetElement.

`js
import { lock, unlock } from 'tua-body-scroll-lock'

const targetElement = document.querySelector('#someElementId')

lock(targetElement)
unlock(targetElement)
`

> The targetElement` is not required on the PC and Android.

Test

testLink

!bodyScrollLock

Contributors

Thanks goes to these wonderful people (emoji key):

evinma 💻 📖 🚇 🌍

StEve Young 💻 📖 🚇 🌍

li2go 💻 🐛

songyan,Wang 💻 🐛

Даниил Пронин 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!