# @a11y-tools/aria-roles 中文文档

规范地址：https://npmcn.com/package/%40a11y-tools/aria-roles/

版本：1\.0\.0
npm 元数据更新时间：2025-05-11T23:00:28.244Z
中文译文更新时间：2026-11-05T17:59:51.430Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：12.4 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2025-05-11T23:00:27.742Z
- 最新版本发布：2025-05-11T23:00:27.980Z
- 近 30 天下载量：114327（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

用于动态获取有效的ARIA角色,验证角色,并提供类型安全访问ARIA角色名的功能.

## 安装

```sh
npm install @a11y-tools/aria-roles
```

也可以使用：`pnpm add @a11y-tools/aria-roles`、`yarn add @a11y-tools/aria-roles`、`bun add @a11y-tools/aria-roles`

## README

# 亚- 作用

**亚- 作用** 是一个轻量级的公用工具库,它为动态获取有效的ARIA角色提供了可靠的方式. 它通过防止硬码角色值并促成验证以更好地遵守UI的可访问性来简化可访问性开发.

## \* 特性

-   · 获取所有有效ARIA角色的完整、最新清单
-   确定某一角色是否为公认的ARIA角色
-   \* 类型安全访问ARIA角色名称
-   轻、快、无依赖
-   \* 设计用于无障碍工具、测试和前端框架

## \* 安装

```sh
npm install @a11y-tools/aria-roles
```

## 使用量

### 基本用途

```js
import { getAllAriaRoles, isValidAriaRole, ariaRoles } from "@a11y-tools/aria-roles";

// Get all valid ARIA roles
console.log(getAllAriaRoles()); // Returns an array of valid ARIA roles

// Validate a role
console.log(isValidAriaRole("button")); // true
console.log(isValidAriaRole("fake-role")); // false

// Type-safe access to role names
element.setAttribute('role', ariaRoles.button);
element.setAttribute('role', ariaRoles.tabpanel);
```

### 类型脚本使用

```ts
import { AriaRole, ariaRoles, isValidAriaRole } from "@a11y-tools/aria-roles";

// Type-safe role definition
const myRole: AriaRole = ariaRoles.button;

// Type narrowing with isValidAriaRole
function setRole(element: HTMLElement, role: string) {
  if (isValidAriaRole(role)) {
    // TypeScript knows 'role' is of type AriaRole here
    element.setAttribute('role', role);
  } else {
    console.warn(`Invalid ARIA role: ${role}`);
  }
}
```

### 反应示例

```tsx
import React from 'react';
import { ariaRoles } from '@a11y-tools/aria-roles';

function AccessibleButton({ children, onClick }) {
  return (
    <div 
      role={ariaRoles.button} 
      onClick={onClick}
      tabIndex={0}
      onKeyDown={(e) => {
        if (e.key === 'Enter' || e.key === ' ') {
          onClick();
        }
      }}
    >
      {children}
    </div>
  );
}
```

### Vue 示例

```vue
<template>
  <div 
    :role="ariaRoles.button"
    @click="onClick"
    tabindex="0"
    @keydown="handleKeyDown"
  >
    <slot></slot>
  </div>
</template>

<script>
import { ariaRoles } from '@a11y-tools/aria-roles';

export default {
  setup() {
    const handleKeyDown = (e) => {
      if (e.key === 'Enter' || e.key === ' ') {
        onClick();
      }
    };
    
    return {
      ariaRoles,
      handleKeyDown
    };
  },
  methods: {
    onClick() {
      // Handle click
    }
  }
}
</script>
```

### 测试示例

```tsx
import { render, screen } from '@testing-library/react';
import { ariaRoles, isValidAriaRole } from '@a11y-tools/aria-roles';

// React Testing Library - use ariaRoles for type-safe queries
test('Component uses correct ARIA roles', () => {
  render(<MyComponent />);
  
  // Query elements by their roles using ariaRoles
  const button = screen.getByRole(ariaRoles.button);
  const navigation = screen.getByRole(ariaRoles.navigation);
  
  // Verify elements have proper attributes
  expect(button).toHaveAttribute('aria-pressed', 'false');
  expect(navigation).toBeInTheDocument();
});

// Validate all roles in a component
test('All roles are valid', () => {
  const { container } = render(<MyComponent />);
  
  // Check that all role attributes are valid
  container.querySelectorAll('[role]').forEach(element => {
    const role = element.getAttribute('role');
    expect(isValidAriaRole(role)).toBe(true);
  });
});
```

## API 参考

### `getAllAriaRoles()`

返回所有有效的 ARIA 字符串的数组 .

```ts
function getAllAriaRoles(): AriaRole[]
```

### `isValidAriaRole(role)`

验证字符串是否为有效的 ARIA 角色 。 在TypeScript中,此函数起到类型守护的作用.

```ts
function isValidAriaRole(role: string): role is AriaRole
```

### `ariaRoles`

一个提供类型安全访问所有ARIA角色名的对象. 每个属性以一个ARIA角色命名并返回角色名作为字符串.

```ts
const ariaRoles: Record<AriaRole, AriaRole>
```

### `AriaRole` (只有脚本)

一个代表所有有效ARIA角色的TypeScript类型.

```ts
type AriaRole = 'alert' | 'alertdialog' | 'application' | /* ... */;
```

## 捐款

欢迎捐款! 请随意提交拉力请求.

## 许可证

这个项目根据麻省理工学院的许可证获得许可.

## 常见问题

### @a11y-tools/aria-roles 是什么？

用于动态获取有效的ARIA角色,验证角色,并提供类型安全访问ARIA角色名的功能\.

### 如何安装 @a11y-tools/aria-roles？

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

### @a11y-tools/aria-roles 支持 TypeScript 吗？

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

### @a11y-tools/aria-roles 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @a11y-tools/aria-roles 需要什么版本的 Node\.js？

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

### @a11y-tools/aria-roles 可以商用吗？

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

### @a11y-tools/aria-roles 的下载量有多少？

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

### @a11y-tools/aria-roles 还在维护吗？

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