tua-body-scroll-lock

English | 简体中文

Introduction

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

-
width="160"
alt="Open in StackBlitz"
src="https://developer.stackblitz.com/img/open_in_stackblitz.svg"
/>

-
width="160"
alt="Open in codepen"
src="https://assets.codepen.io/t-1/codepen-logo.svg"
/>

- Open in codesandbox
- Open in jsfiddle
- Open in jsbin

Install

$3

``bash
pnpm i tua-body-scroll-lock
`

$3







UMD(tua-bsl.umd.js)

`html





`




Minified UMD(tua-bsl.umd.min.js)

`html





`




ESM in browser(tua-bsl.esm.browser.js)

`html





`




Minified ESM in browser(tua-bsl.esm.browser.min.js)

`html





`

Usage

$3

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

lock()
unlock()
`

$3

#### setOverflowForIOS: boolean (iOS lock only)

Version: 1.6.0+
Optional, default: false

Used to prevent mouse scroll events in iOS simulator.

#### overflowType: 'hidden' | 'clip'

optional, default: 'hidden'

clip is suitable for adapting elements of position: sticky in high-version browsers (Chrome 90 +).

> https://caniuse.com/mdn-css_types_overflow_clip

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

lock(targetElement, { overflowType: 'clip' })
`

#### useGlobalLockState: boolean

optional, default: false

Whether to use global lockState for every BSL. It's useful when your page have multiple BSL instances.

$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 elementOne = document.querySelector('#elementOne')
const elementTwo = document.querySelector('#elementTwo')

// one targetElement
const targetElement = elementOne
// multiple targetElements
const targetElements = [elementOne, elementTwo]

lock(targetElement)
lock(targetElements)
unlock(targetElement)
unlock(targetElements)
`

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

$3


In the SPA, if you called lock, but forgot to call unlock before jumping to other pages, that is too bad. Because the operation of the page is not restored, such as forbid touchmove, clearBodyLocks is used to clear all side effects. Sure, you can also call unlock, but if you have called lock multiple times, you must call unlock` multiple times, which is very unfriendly.

Examples

!bodyScrollLock

Please see these examples:
- vue
- react
- vanilla

Contributors

Thanks goes to these wonderful people (emoji key):

evinma 💻 📖 🚇 🌍	StEve Young 💻 📖 🚇 🌍	li2go 💻 🐛	songyan,Wang 💻 🐛	Даниил Пронин 🐛	阿卡琳 🐛	falstack 💻
David Q. Jin 🐛

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

> inspired by body-scroll-lock