# makeup-screenreader-trap

> Restricts screen reader virtual cursor to a single subtree in the DOM

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

## Install

```sh
npm install makeup-screenreader-trap
pnpm add makeup-screenreader-trap
yarn add makeup-screenreader-trap
bun add makeup-screenreader-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.7.0 |
| Published | 2026-03-31 |
| First published | 2017-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 47 |
| Author | Ian McBurnie |
| Maintainers | dylanpiercey, sendlo, ianmcburnie, agliga, saiponnada, artblue, lulavalva |
| Keywords | makeup, ebay, accessibility, a11y |

## Links

- npm: https://www.npmjs.com/package/makeup-screenreader-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-screenreader-trap

## Recent versions

- 0.7.0 (latest) — 2026-03-31
- 0.6.0 — 2026-03-31
- 0.5.7 — 2026-01-14
- 0.5.6 — 2025-08-19
- 0.5.5 — 2025-08-13
- 0.5.4 — 2025-04-04
- 0.5.3 — 2024-12-20
- 0.5.2 — 2024-11-22
- 0.5.1 — 2024-09-03
- 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.1 — 2020-09-10
- … 11 more at https://npm.io/package/makeup-screenreader-trap/versions

## README

# makeup-screenreader-trap

This module restricts screen reader virtual cursor to a single subtree in the DOM. This behaviour is useful when implementing a modal interface (e.g. a modal dialog).

```js
import * as screenreaderTrap from "makeup-screenreader-trap";

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

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

## Experimental

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

## Options

- `useHiddenProperty`: use `hidden` property instead of `aria-hidden` to fully hide the surrounding DOM tree for all users (useful for full-screen modal dialog) (default: false)

## Events

- screenreaderTrap : fired by trapped element when screenreader trap is activated
- screenreaderUntrap : fired by trapped element when screenreader trap is deactivated

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