/no-scroll

Disable scrolling on an element that would otherwise scroll

Primary LanguageJavaScriptMIT LicenseMIT

no-scroll

Disable the document's scrolling.

It's silly how many libraries have their own implementation of this. So I thought I'd make a module that other libraries could use.

Here's how this works:

  • When you turn it on(), the documentElement is styled with width: calc(100% - scrollbarSize), position: fixed, top: currentScrollTop, and overflow: hidden.
  • When you turn it off(), everything goes back to the way it was before.

Installation

npm install no-scroll

Dependencies: none.

Browser Support

Mobile: works perfectly on iOS, even if iOS Safari window resizes

Usage

This module exposes three simple functions: on(), off() and toggle().

import noScroll from 'no-scroll';

// To turn off the document's scrolling
noScroll.on();

// To restore scrolling
noScroll.off();

// To toggle scrolling
noScroll.toggle();