# react-lock-scroll

> A react hook for locking scroll on mount or on toggle

Latest version **0.1.8** (published 2020-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-lock-scroll
pnpm add react-lock-scroll
yarn add react-lock-scroll
bun add react-lock-scroll
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2020-02-20 |
| First published | 2019-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | elllgeeemm |
| Keywords | React, scroll, lock, scroll-lock |

## Links

- npm: https://www.npmjs.com/package/react-lock-scroll
- Repository: https://github.com/ElllGeeEmm/react-lock-scroll
- Issues: https://github.com/ElllGeeEmm/react-lock-scroll/issues
- npm.io page: https://npm.io/package/react-lock-scroll

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.8 (latest) — 2020-02-20
- 0.1.7 — 2020-01-12
- 0.1.6 — 2020-01-12
- 0.1.5 — 2019-12-19
- 0.1.4 — 2019-12-19
- 0.1.3 — 2019-12-19
- 0.1.2 — 2019-12-19
- 0.1.1 — 2019-12-19
- 0.1.0 — 2019-12-19

## README

This project was bootstrapped with [Create React Library](https://github.com/dimimikadze/create-react-library).

# Install

`npm i react-lock-scroll`

es6
`import lockScroll from "react-lock-scroll;"`

es5
`const lockScroll = require("react-lock-scroll");`

# Usage

## default

By default, react-lock-scroll will lock the document body when the component where it is called is mounted, and unlock the document body when that component is dismounted.

ex:
```
export default (props) => {
  lockScroll();
  return (
    <div>I lock the bodys scroll when mounted</div>
```

## First argument: toggle (default=true)

lockScroll can also be passed a boolean state value, and will lock the screen on true and unlock it on false.

ex:
```
export default (props) => {
  [toggle, setToggle] = useState(false);
  lockScroll(toggle)
  return <button onClick={()=>setToggle(!toggle}>Lock Scrolling</button>
}
```

## Second argument: target (default=false)

LockScroll can be passed the ref of a target div to lock scrolling on. This also supports passing of a boolean state value for a toggle, however if you simply want it to lock on mount/dismount, you can just pass it a ref to the div that has overflow: scroll set. Note that this will likely require the use of [forwardRef](https://reactjs.org/docs/forwarding-refs.html) to construct this component if the DOM node is outside of the component where lockScroll is called.

ex.
```
export default (props) => {
  const ref = useRef();
  const [lock, setLock] = useState(false)
  lockScroll(lock, ref);
  
  return (
    <div className="divThatScrolls" ref={ref}>
      <div>
        <button onClick={() => setLock(!lock)}>Lock</button>
      </div>
    </div>
  )
};
```
## last argument: styles (default=false)

include a valid style object with styles you want to be applied to the locked div when it's locked. Useful for adjusting for scroll bars.

```
export default (props) => {
  lockScroll({margin: "15px"});
  
  return (
    <div>
      when mounted, I lock and add 15px of margin to the body
    </div>
  )
};
```

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