# aria-hidden 中文文档

规范地址：https://npmcn.com/package/aria-hidden/

版本：1\.2\.6
npm 元数据更新时间：2025-05-19T00:03:51.078Z
中文译文更新时间：2026-11-05T15:47:51.405Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/aria-hidden
原文对照：https://npmcn.com/package/aria-hidden/?lang=original
项目主页：https://github.com/theKashey/aria-hidden#readme
源码仓库：https://github.com/theKashey/aria-hidden

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：31 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10
- 运行依赖：1 个
- 首次发布：2018-10-23T06:47:56.095Z
- 最新版本发布：2025-05-19T00:03:50.887Z
- 近 30 天下载量：289978314（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

除了...

## 安装

```sh
npm install aria-hidden
```

也可以使用：`pnpm add aria-hidden`、`yarn add aria-hidden`、`bun add aria-hidden`

## README

# 隐藏的线条

[![NPM](https://nodei.co/npm/aria-hidden.png?downloads=true&stars=true)](https://nodei.co/npm/aria-hidden/)

隐藏 ARIA 除提供节点外的一切.

帮助隔离模式对话框和重点任务 - 内容将无法使用 可用的工具.

现在用 [HTML 惯性](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert) 支助

# API 密码

打电话 `hideOthers` 和DOM节点 你想保持, 它会 _隐藏_ 其他的都一样. `targetNode` 它的兄弟姐妹会被藏起来 但它和它的父母.

> "隐藏"的术语或 `aria-hidden`

```js
import { hideOthers } from 'aria-hidden';

const undo = hideOthers(exceptThisDOMnode);
// everything else is "aria-hidden"

// undo changes
undo();
```

您也可以通过提供作为第二个参数的顶级节点来限制效果扩展

```js
// keep only `anotherNode` node visible in #app
// the rest of document will be untouched
hideOthers(anotherNode, document.getElementById('app'));
```

> `parentNode` 默认为文档. body

# 惰性

虽然 `aria-hidden` 过去发挥重要作用,今后将发挥 用例总是围绕着隔离内容,使元素"透明",不仅为了aria,而且为了 用户互动.

这就是为什么你可能会考虑使用 `inertOthers`

```tsx
import { hideOthers, inertOthers, supportsInert } from 'aria-hidden';

// focus on element mean "hide others". Ideally disable interactions
const focusOnElement = (node) => (supportsInert() ? inertOthers(node) : hideOthers(node));
```

相同的功能已被压缩并导出为

```tsx
import { suppressOthers } from 'aria-hidden';

suppressOthers([keepThisNode, andThis]);
```

QQ 注 - 惰性 **将禁用任何交互** 与 _压制_ 要点

### 无惰性地制止相互作用

一个可以 `marker`,第三个参数为函数,以标记隐藏的元素. 以后可以创建匹配给定标记的样式来应用 `pointer-events:none`

```css
[hidden-node] {
  pointer-events: none;
}
```

```tsx
hideOthers(notThisOne, undefined /*parent = document*/, 'hidden-node');
```

一般而言,通过解决 `[aria-hidden]` 节点,但是 并非所有 `aria-hidden` 节点预计为非交互. 因此,最好把问题分开.

# 灵感

依据 [平滑动](https://github.com/smooth-code/smooth-ui) 模式对话框 .

# 另见

-   [惰性](https://github.com/WICG/inert) - HTML属性/财产来将DOM树的部分标记为"惰".
-   [反应 - 焦点- 锁定](https://github.com/theKashey/react-focus-lock) 将焦点锁定在模式内.
-   [反应- 滚动- 锁定](https://github.com/theKashey/react-scroll-lock) 在打开模式时禁用页滚动.

# 大小

代码为30行长

# 许可证

麻省理工学院

## 常见问题

### aria-hidden 是什么？

除了\.\.\.

### 如何安装 aria-hidden？

在项目目录运行 npm install aria-hidden，或使用 pnpm add / yarn add / bun add。

### aria-hidden 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### aria-hidden 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### aria-hidden 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### aria-hidden 可以商用吗？

aria-hidden 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### aria-hidden 的下载量有多少？

根据 npm 官方下载统计，aria-hidden 在 2026/10/05 – 2026/11/03 这 30 天内被下载 289,978,314 次，日均约 9,665,944 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### aria-hidden 还在维护吗？

最新版本 1\.2\.6 发布于 2025/05/19（1\.5 年前）；至今共发布 12 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/10/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。