❤
npm
Sign UpSign In

react-scrolllock-reactref

3.0.3 • Public • Published

React Scroll Lock

Prevent scroll on the <body /> when a component is mounted.

Install

yarn add react-scrolllock

Usage

import ScrollLock from 'react-scrolllock';
 
class Modal extends Component {
  render() {
    return (
      <div>
        ...
        <ScrollLock />
      </div>
    );
  }
}

Props

Property Description
accountForScrollbars boolean Default: true -- Measures the scrollbar width and replaces it with padding when mounted.
touchScrollTarget HTMLElement Default: null -- Touch scroll is locked for iOS when mounted due to overflow: hidden; not being observed on the <body/>. This property allows you to provide an element to allow scroll on, typically within a modal.

Readme

Keywords

Package Sidebar

Install

npm i react-scrolllock-reactref

Repository

github.com/jossmac/react-scrolllock

Homepage

jossmac.github.io/react-scrolllock

Weekly Downloads

2

Version

3.0.3

License

MIT

Unpacked Size

300 kB

Total Files

12

Last publish

Collaborators

  • niftyasp
Try on RunKit
Report malware