prevent-scroll

Reliably disable scrolling

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
prevent-scroll
12152.0.06 years ago7 years agoMinified + gzip package size for prevent-scroll in KB

Readme

prevent-scroll
Reliably disable scrolling
Travis build status Test Coverage Dependency Status devDependency Status

Motivation

Preventing a user from scrolling is a surprisingly challenging thing to do on the web. This library is the most robust solution I know of to disable scrolling.

Features

✓ Mobile and desktop support
✓ Prevents scrolling through keyboard inputs
✓ Never loses the position of the scrollbar
✓ Never causes the scrollbar to appear or disappear unnecessarily
✓ Solid browser support
✓ Zero dependencies

Installation

The recommended way to install this package is through npm.
npm install prevent-scroll

API

preventScroll.on()
Disables scrolling.
preventScroll.off()
Enables scrolling.

Example Usage

import preventScroll from 'prevent-scroll';

// Disable scrolling
preventScroll.on();

// Allow scrolling
preventScroll.off();