Nocturnal Pumpkin Maelstrom
Miss any of our Open RFC calls?Watch the recordings here! »

no-scroll

2.1.1 • Public • Published

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

IE9+

Usage

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

var noScroll = require('no-scroll');
 
// To turn off the document's scrolling
noScroll.on();
 
// To restore scrolling
noScroll.off();
 
// To toggle scrolling
noScroll.toggle();

If you do not have a CommonJS environment (no module.exports), the module exposes the global object noScroll.

Install

npm i no-scroll

DownloadsWeekly Downloads

67,822

Version

2.1.1

License

MIT

Unpacked Size

5.24 kB

Total Files

5

Last publish

Collaborators

  • avatar