prevent-scrolling
TypeScript icon, indicating that this package has built-in type declarations

1.3.10 • Public • Published

prevent-scrolling

Prevent scrolling while optionally allowing scrolling on specified elements.

GitHub release Build Status codecov Codacy Badge

Features

  • Prevents scrolling via keyboard
  • Maintains scrolling position
  • Scrollbar will not disappear
  • Can specify elements to still allow scrolling within
  • Elements without scrolling disabled do not allow scroll events to overflow out to parent elements

Install

You can install via npm or yarn.

npm

npm install --save prevent-scrolling

yarn

yarn add prevent-scrolling

Usage

Importing

You can import using ES6 imports.

import { PreventScrolling, ReEnableScrolling } from 'prevent-scrolling';

Preventing Scrolling

PreventScrolling();

Preventing Scrolling but keep scrolling available on one element

const myScrollableElement = document.querySelector('.MyScrollableElement');

PreventScrolling(myScrollableElement);

Preventing Scrolling but keep scrolling available on multiple elements

const myScrollableElements = [].slice.call(document.querySelectorAll('.MyScrollableElement'));

PreventScrolling(myScrollableElements);

Re-enabling Scrolling

ReEnableScrolling();

Package Sidebar

Install

npm i prevent-scrolling

Weekly Downloads

43

Version

1.3.10

License

MIT

Unpacked Size

274 kB

Total Files

21

Last publish

Collaborators

  • bameyrick