# @bluecadet/embla-carousel-a11y 中文文档

规范地址：https://npmcn.com/package/%40bluecadet/embla-carousel-a11y/

版本：0\.1\.2
npm 元数据更新时间：2025-04-17T20:59:36.129Z
中文译文更新时间：2026-11-08T08:21:13.754Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：27.6 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：embla-carousel ^8\.5\.2
- 首次发布：2025-04-01T20:45:36.825Z
- 最新版本发布：2025-04-17T20:59:35.880Z
- 近 30 天下载量：2937（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

Embla Carousel 的 A11y 插件

## 安装

```sh
npm install @bluecadet/embla-carousel-a11y
```

也可以使用：`pnpm add @bluecadet/embla-carousel-a11y`、`yarn add @bluecadet/embla-carousel-a11y`、`bun add @bluecadet/embla-carousel-a11y`

## README

# Embla Carousel A11y 插件

一个无障碍插件 [埃布拉·卡鲁塞尔](https://www.embla-carousel.com/) 遵循WAI-ARIA对旋转木马的写作实践.

## 特征

-   在旋转木马元素中添加适当的 ARIA 角色和属性
-   创建可访问的直播区域以宣布幻灯片更改
-   尊重用户提供的ARIA属性
-   显示有用的开发警告, 改善无障碍环境

## 安装

```bash
# npm
npm install embla-carousel @bluecadet/embla-carousel-a11y

# yarn
yarn add embla-carousel @bluecadet/embla-carousel-a11y

# pnpm
pnpm add embla-carousel @bluecadet/embla-carousel-a11y
```

## 基本用途

```typescript
import A11y from "@bluecadet/embla-carousel-a11y";
import EmblaCarousel from "embla-carousel";

// Initialize Embla with the A11y plugin
const emblaNode = document.querySelector(".embla");
const embla = EmblaCarousel(emblaNode, { loop: true }, [A11y()]);

// The plugin is accessible through embla.plugins().a11y
const a11yPlugin = embla.plugins().a11y;
```

## API 参考

### 选项

A11y 插件接受以下选项:

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `carouselLabel` | `string | undefined` | `undefined` | 旋转木马的自定义标签. 如果不提供,则使用现有的 `aria-label` 或设置默认值. |
| `slideSelector` | `string | undefined` | `undefined` | 自定义幻灯片元素的选择器 。 如果不提供,则使用 Embla 默认的幻灯片节点. |
| `announceSlideChanges` | `boolean` | `true` | 是否向屏幕阅读器宣布幻灯片更改 . |
| `slideAnnouncementTemplate` | `string` | `"Slide {{currentSlide}} of {{totalSlides}}"` | 幻灯片更改通知模板 。 使用 `{{currentSlide}}` 财务报告和审定财务报表 `{{totalSlides}}` 作为变量. |
| `showDeveloperWarnings` | `boolean` | `true` | 是否在非生产环境中显示开发者控制台警告 . |

### 插件方法

A11y 插件暴露了以下方法:

| 方法 | 说明 |
| --- | --- |
| `update()` | 基于当前自旋状态更新 ARIA 属性. 当所选幻灯片更改时自动调用 . |

## 无障碍特性

此插件执行以下无障碍特性:

### ARIA 适当的作用和属性

-   添加数 `role="region"` 到木马容器
-   添加数 `aria-roledescription="carousel"` 把它当作木马
-   添加正则 `aria-label` (或尊重已存在的标签)
-   添加数 `role="group"` 财务报告和审定财务报表 `aria-roledescription="slide"` 转到幻灯片
-   应用 `aria-hidden="true"` 改为非可见幻灯片
-   设定 `aria-setsize` 财务报告和审定财务报表 `aria-posinset` 用于适当的幻灯片位置信息

### 发布现场区域

-   为屏幕阅读器通知创建可视化隐藏直播区域
-   导航时宣布当前幻灯片位置
-   使用自定义的公告模板

### 尊重用户属性

-   检测用户在初始化前提供的现有ARIA属性
-   保护这些属性而不是凌驾于它们之上
-   只更新动态属性, 如 `aria-hidden` 视需要

### 发展警告

在开发模式中,插件为无障碍性改进提供了有益的控制台警告:

-   当没有为旋转木马提供无障碍名称( 标签) 时警告
-   建议在幻灯片中添加描述性标签
-   可在生产中或选择中被禁用

## 无障碍木马的最佳做法

为了最大限度的无障碍,我们建议:

1.  **提供有意义的标签**: 使用 `carouselLabel` 选项或添加 `aria-label` 带有描述内容的旋转木马和幻灯片.

```html
<div class="embla" aria-label="Featured products">
  <div class="embla__container">
    <div class="embla__slide" aria-label="Red summer dress, $49.99">...</div>
    <div class="embla__slide" aria-label="Blue winter coat, $89.99">...</div>
  </div>
</div>
```

2.  **添加可访问的导航控制**: 包含带有适当标签的上个/下个按钮.

```html
<button class="embla__prev" aria-label="Previous slide">Prev</button>
<div class="embla">...</div>
<button class="embla__next" aria-label="Next slide">Next</button>
```

3.  **互动中暂停自动播放**:如果使用自動播放,当用户与旋转木马互动时暂停.

```js
const options = {
  loop: true,
  autoplay: true,
};

const embla = EmblaCarousel(emblaNode, options, [A11y()]);

// Pause autoplay on focus within the carousel
emblaNode.addEventListener("focusin", () => {
  embla.plugins().autoplay.stop();
});

// Resume when focus leaves
emblaNode.addEventListener("focusout", (event) => {
  if (!emblaNode.contains(event.relatedTarget)) {
    embla.plugins().autoplay.play();
  }
});
```

## 为什么无障碍问题

使你的旋转木马可以进入,确保:

-   有屏幕阅读器的用户可以理解并浏览您的内容
-   只有键盘用户可以访问所有自动机特性
-   您的网站符合 WCAG 等无障碍标准
-   你接触到更广泛的受众,包括残疾人

## 捐款

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

## 常见问题

### @bluecadet/embla-carousel-a11y 是什么？

Embla Carousel 的 A11y 插件

### 如何安装 @bluecadet/embla-carousel-a11y？

在项目目录运行 npm install @bluecadet/embla-carousel-a11y，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：embla-carousel（^8\.5\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bluecadet/embla-carousel-a11y 支持 TypeScript 吗？

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

### @bluecadet/embla-carousel-a11y 支持 ESM 还是 CommonJS？

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

### @bluecadet/embla-carousel-a11y 可以商用吗？

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

### @bluecadet/embla-carousel-a11y 的下载量有多少？

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

### @bluecadet/embla-carousel-a11y 还在维护吗？

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