JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 94
  • Score
    100M100P100Q95256F
  • License MIT

Prevents default scroll event when pressing down arrow, page down, spacebar, etc.

Package Exports

  • makeup-prevent-scroll-keys

Readme

makeup-prevent-scroll-keys

This 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 you must consider all minor releases as breaking changes.

Example

import * as scrollKeyPreventer from 'makeup-prevent-scroll-keys';

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

// execute
scrollKeyPreventer.add(el);

// to remove
scrollKeyPreventer.remove(el);