npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@michellocana/react-scrolllock

v1.0.1

Published

Prevent scroll on the body when component is mounted.

Downloads

42

Readme

React Scroll Lock

🚨 Not Maintained No Maintenance Intended

This project is a fork of react-scrolllock, which is now unmantained. This version keeps almost all of the original code, but updates the react and react-dom peer dependencies and moves from Flow to TypeScript.

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

Install

yarn add react-scrolllock

Usage

import { ScrollLock, TouchScrollable } from 'react-scrolllock'

class Modal extends Component {
  state = { lockScroll: false }
  render() {
    return (
      <div>
        ... // the lock accepts a single child element, which supports touch-scrolling.
        <ScrollLock>
          <ElementWithScrollableContent>...</ElementWithScrollableContent>
        </ScrollLock>
        // if your app structure doesn't allow wrapping like above, the `TouchScrollable` // component is exposed as a
        named export.
        <ScrollLock />
        <TouchScrollable>
          <ElementWithScrollableContent>...</ElementWithScrollableContent>
        </TouchScrollable>
        // you can also toggle the lock based on some state.
        <ScrollLock isActive={this.state.lockScroll} />
      </div>
    )
  }
}

Props

ScrollLock

| Property | Description | | ------------------------------ | --------------------------------------------------------------------------------------- | | accountForScrollbars boolean | Default: true -- Whether or not to replace the scrollbar width when active. | | isActive boolean | Default: true -- Whether or not the lock is active. | | children element | Default: null -- This element is wrapped internally by the TouchScrollable component. |

TouchScrollable

Wrap an element in the TouchScrollable component if you need an area that supports scroll on mobile.

This is necessary because the touchmove event is explicitly cancelled — iOS doesn't observe overflow: hidden; when applied to the <body /> element 😢

| Property | Description | - | | ------------------ | ---------------- | ---------------------------------------------- | | children element | ref => element | Required The element that can be scrolled. |