# makeup-keyboard-trap

> Restricts keyboard tabindex to a single subtree in the DOM

Latest version **0.6.0** (published 2026-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install makeup-keyboard-trap
pnpm add makeup-keyboard-trap
yarn add makeup-keyboard-trap
bun add makeup-keyboard-trap
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2026-03-31 |
| First published | 2017-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 47 |
| Author | Ian McBurnie |
| Maintainers | dylanpiercey, sendlo, ianmcburnie, agliga, saiponnada, artblue, lulavalva, gardneraustin |
| Keywords | makeup, ebay, accessibility, a11y |

## Links

- npm: https://www.npmjs.com/package/makeup-keyboard-trap
- Repository: https://github.com/makeup/makeup-js.git#master
- Homepage: https://github.com/makeup/makeup-js/tree/master#readme
- Issues: https://github.com/makeup/makeup-js/issues
- npm.io page: https://npm.io/package/makeup-keyboard-trap

## Dependencies (1)

- [makeup-focusables](https://npm.io/package/makeup-focusables.md) ^0.5.0

## Recent versions

- 0.6.0 (latest) — 2026-03-31
- 0.5.8 — 2026-01-21
- 0.5.7 — 2025-08-19
- 0.5.6 — 2025-08-18
- 0.5.5 — 2025-04-22
- 0.5.4 — 2024-12-20
- 0.5.3 — 2024-10-24
- 0.5.2 — 2024-09-03
- 0.5.1 — 2024-08-27
- 0.5.0 — 2024-06-23
- 0.4.2 — 2024-06-17
- 0.4.1 — 2022-02-11
- 0.4.0 — 2022-02-02
- 0.3.0 — 2021-07-10
- 0.2.6 — 2020-12-02
- … 17 more at https://npm.io/package/makeup-keyboard-trap/versions

## 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 <em>programmatically</em> focusable items with a tabindex of `-1`.

## Experimental

This module is still in an experimental state, until it reaches v1 you must consider all minor releases as breaking changes.

```js
import { trap, untrap } from "makeup-keyboard-trap";

// trap an element
trap(document.querySelector("el"));

// untrap the current trapped element
untrap();
```

## Install

```js
// 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

---
_Source: https://npm.io/package/makeup-keyboard-trap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
