pvalentim / disable-scroll

Prevent page scrolling

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

disable scroll

Prevent page scrolling like a boss.
Supports scrollbar, mousewheel, touchmove, keydown events.

Demo

Install

npm

npm install --save disable-scroll

and require it

var disableScroll = require('disable-scroll');

bower

bower install --save disable-scroll

Reference the script in your html file

<script src="disable-scroll.min.js"></script>

Usage

disableScroll.on(); // prevent scrolling
...
disableScroll.off(); // re-enable scroll

API

.on([element], [options])

Disable page scrolling by adding event listeners and locking the scroll position.

  • [element] - DOM Element. Defaults to document.body
  • [options] - Change the initial options. Defaults to:
{
    disableWheel: true,
    disableScrollbar: true,
    disableKeys: true,
    scrollEventKeys: [32, 33, 34, 35, 36, 37, 38, 39, 40]
}

.off()

Re-enable page scrolling and destroy the listeners.


Inspired by jquery-disablescroll

About

Prevent page scrolling

License:MIT License


Languages

Language:JavaScript 55.2%Language:HTML 26.6%Language:Shell 18.2%