Wondering what’s next for npm?Check out our public roadmap! »

    makeup-keyboard-trap
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/makeup-keyboard-trap package

    0.2.6 • Public • Published

    makeup-keyboard-trap

    This module restricts keyboard tabindex to a single subtree in the DOM. This behaviour is useful when implementing a modal interface (e.g. a modal dialog).

    It will ignore programmatically focusable items with a tabindex of -1.

    Experimental

    This CommonJS 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.

    const keyboardTrap = require('makeup-keyboard-trap');
    
    // trap an element
    keyboardTrap.trap(document.querySelector('el'));
    
    // untrap the current trapped element
    keyboardTrap.untrap();

    Install

    // via npm
    npm install makeup-keyboard-trap
    
    // via yarn
    yarn add makeup-keyboard-trap

    Events

    • keyboardTrap : fired by trapped element when keyboard trap is activated
    • keyboardUntrap : fired by trapped element when keyboard trap is deactivated

    Dependencies

    Install

    npm i makeup-keyboard-trap

    DownloadsWeekly Downloads

    36

    Version

    0.2.6

    License

    MIT

    Unpacked Size

    7.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar
    • avatar