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()
, thedocumentElement
is styled withwidth: calc(100% - scrollbarSize)
,position: fixed
,top: currentScrollTop
, andoverflow: 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 = ; // To turn off the document's scrollingnoScroll; // To restore scrollingnoScroll; // To toggle scrollingnoScroll;
If you do not have a CommonJS environment (no module.exports
), the module
exposes the global object noScroll
.