Giter Club home page Giter Club logo

disable-scroll's Introduction

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

disable-scroll's People

Contributors

gilbarbara avatar

Watchers

Ben Henderson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.