Skip to content

Latest commit

History

22 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

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().

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

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

About

Disable scrolling on an element that would otherwise scroll

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages