3.0.3 • Published 6 years ago

react-scrolllock-reactref v3.0.3

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

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

PropertyDescription
accountForScrollbars booleanDefault: true -- Measures the scrollbar width and replaces it with padding when mounted.
touchScrollTarget HTMLElementDefault: 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.