Skip to content
Prevents default scroll event when pressing down arrow, page down, spacebar, etc.
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
test
.eslintrc
.gitignore
.npmrc
.travis.yml
LICENSE
README.md
babel.config.json
browser.json
index.js
karma.conf.js
package.json
webpack.docs.js
yarn.lock

README.md

makeup-prevent-scroll-keys

Build Status Coverage Status Dependency status devDependency status

A vanilla JavaScript port of jquery-prevent-scroll-keys.

This CommonJS module prevents the default scroll event when pressing down arrow, page down, spacebar, etc. This behaviour is required for ARIA widgets such as menu, tabs and comboboxes. See eBay MIND Patterns for further information.

Experimental

This module is still in an experimental state, until it reaches v1.0.0 you must consider all minor releases as breaking changes. Patch releases may introduce new features, but will be backwards compatible.

Install

// via npm
npm install makeup-prevent-scroll-keys

// via yarn
yarn add makeup-prevent-scroll-keys

Example

// require the module
const scrollKeyPreventer = require('makeup-prevent-scroll-keys');

// get element reference
const widgetEl = document.querySelector('.widget');

// execute
scrollKeyPreventer.add(el);

// to remove
scrollKeyPreventer.remove(el);

Parameters

None

Custom Events

None

Dependencies

None

CI Build

https://travis-ci.org/makeup-js/makeup-prevent-scroll-keys

Code Coverage

https://coveralls.io/github/makeup-js/makeup-prevent-scroll-keys

You can’t perform that action at this time.