Have ideas to improve npm?Join in the discussion! »

    makeup-prevent-scroll-keys
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/makeup-prevent-scroll-keys package

    0.0.4 • Public • Published

    makeup-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

    Install

    npm i makeup-prevent-scroll-keys

    DownloadsWeekly Downloads

    39

    Version

    0.0.4

    License

    MIT

    Unpacked Size

    3.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar