JSPM

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

Restricts keyboard tabindex to a single subtree in the DOM

Package Exports

  • makeup-keyboard-trap

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (makeup-keyboard-trap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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