Angular CDK 无障碍性 API 参考

import {A11yModule} from '@angular/cdk/a11y';

服务

InputModalityDetector

检测用户输入模式的服务。

当用户使用屏幕阅读器进行导航（例如借助 VoiceOver 进行线性导航、借助 NVDA 使用对象导航/浏览模式、借助 JAWS 使用虚拟 PC 光标模式）时，此服务不会改变输入模式。这部分是由于技术限制（即在这些模式下键盘事件不会按预期触发），但也可以说是正确的行为。使用屏幕阅读器导航类似于视觉扫描页面，不应被解释为实际的用户输入交互。

当用户不是在导航而是与屏幕阅读器交互时，此服务会尝试将输入模式改为键盘，但一般来说此服务的行为在很大程度上是未定义的。

属性

HighContrastModeDetector

本服务用于确定浏览器当前是否处于高对比度模式环境中。

Microsoft Windows 支持一种称为“高对比度模式”的辅助功能。此模式更改所有应用程序（包括 Web 应用程序）的外观，以显著提高对比度。

目前，IE、Edge 和 Firefox 支持此模式。Chrome 浏览器不支持 Windows 高对比度模式。此服务无法检测到由 Chrome 的“高对比度” 扩展程序添加的高对比度模式。

方法

AriaDescriber

该实用工具创建带有消息内容的视觉不可见元素。对于希望使用 aria-describedby 来进一步描述自己而不想添加其他视觉内容的元素很有用。

方法

ConfigurableFocusTrapFactory

本工厂允许轻松实例化可配置的焦点陷阱。

方法

FocusTrapFactory

允许轻松实例化焦点陷阱的工厂。

方法

InteractivityChecker

用于检查元素交互性的实用程序，例如元素是否可聚焦或可制表。

方法

LiveAnnouncer

方法

FocusMonitor

监视鼠标和键盘事件以确定焦点事件的原因。

方法

指令

CdkTrapFocus

在 zone 内捕获焦点的指令。

选择器： [cdkTrapFocus]

属性

CdkAriaLive

该指令与 aria-live 相似，但使用 LiveAnnouncer 来确保与更多浏览器和屏幕阅读器的兼容性。

选择器： [cdkAriaLive]

属性

CdkMonitorFocus

指令，用于确定如何让特定元素获得焦点（通过键盘，鼠标，触摸或以编程方式），并向该元素添加相应的类。

此指令有两种变体：

此指令有两种变体： 1）cdkMonitorElementFocus：如果元素的任何一个子元素有焦点，则不认为该元素拥有焦点。 2）cdkMonitorSubtreeFocus：如果元素或其任何子元素都有焦点，则认为该元素拥有焦点。

选择器： [cdkMonitorElementFocus] [cdkMonitorSubtreeFocus]

属性

类

ActiveDescendantKeyManager 继承自 ListKeyManager

属性

方法

FocusKeyManager 继承自 ListKeyManager

属性

方法

ListKeyManager

此类管理可选列表的键盘事件。如果向其传递条目的查询列表，则当发生方向键事件时，它将正确设置活动条目。

属性

方法

ConfigurableFocusTrap 继承自 FocusTrap

允许在 DOM 元素内捕获焦点的类。

此类使用一种策略模式来确定如何捕获焦点。请参阅 FocusTrapInertStrategy。

属性

方法

EventListenerFocusTrapInertStrategy

轻型 FocusTrapInertStrategy，添加了文档焦点事件侦听器以将焦点重定向回 FocusTrap 内部。

方法

FocusTrap

允许在 DOM 元素内捕获焦点的类。

此类当前使用相对简单的方法进行焦点捕获。它假定 tab 顺序与 DOM 顺序相同，但这不一定正确。和 tabIndex > 0 一样，flex order 和 Shadow DOM 之类的都可能导致两者未对齐。

属性

方法

IsFocusableConfig

isFocusable 方法的配置。

属性

接口

InputModalityDetectorOptions

用于配置 InputModalityDetector 行为的选项。

属性

RegisteredMessage

本接口用于注册消息元素并保留具有相同消息的注册数量的计数，以及用于 aria-describedby 对消息元素的引用。

属性

Highlightable

这是突出显示项的界面（由 ActiveDescendantKeyManager 使用）。每个条目都必须知道如何将自己设置为活动或非活动样式，以及当前是否处于禁用状态。

方法

FocusableOption

这是可获取焦点条目的接口（由 FocusKeyManager 使用）。每个条目都必须知道如何获取焦点，无论当前是否已禁用并能提供其标签。

方法

ListKeyManagerOption

此接口用于可传递给 ListKeyManager 的条目。

属性

方法

ConfigurableFocusTrapConfig

用于创建 ConfigurableFocusTrap 的选项。

属性

FocusTrapInertStrategy

一种策略，指示 FocusTrap 应如何防止 FocusTrap 外部的元素获得焦点。

方法

LiveAnnouncerDefaultOptions

可用于配置 LiveAnnouncer 的默认选项的对象。

属性

FocusOptions

对应于可以传递给原生 focus 事件的选项。通过 https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus

属性

FocusMonitorOptions

FocusMonitor 在可注入服务级别的选项。

属性

函数

类型别名

InputModality

此服务检测到的输入模式。如果输入模式未知，则使用 Null。

type InputModality = 'keyboard' | 'mouse' | 'touch' | null;

ListKeyManagerModifierKey

ListKeyManager 处理的修饰键。

type ListKeyManagerModifierKey = 'altKey' | 'ctrlKey' | 'metaKey' | 'shiftKey';

AriaLivePoliteness

可能的礼貌度。

type AriaLivePoliteness = 'off' | 'polite' | 'assertive';

FocusOrigin

type FocusOrigin = 'touch' | 'mouse' | 'keyboard' | 'program' | null;

常量

INPUT_MODALITY_DETECTOR_DEFAULT_OPTIONS

InputModalityDetector 的默认选项。

默认情况下忽略修饰键（即按下时不会导致服务检测键盘输入模式），这有两个原因：

1. 修饰键通常与鼠标一起使用以执行诸如“右键单击”或“在新选项卡中打开”之类的操作，因此不太能代表实际的键盘交互。
2. 当使用 Control + Option 进行线性导航时，VoiceOver 会触发一些键盘事件（但不会与 Caps Lock 混淆）。因此，为了与其他屏幕阅读器保持一致，我们忽略这些键以免改变输入模式。

请注意，默认情况下我们不会忽略 Safari 上的右侧 Meta 键，因为它与其他浏览器上的 ContextMenu 键具有相同的键代码。当我们转而使用 event.key 时，我们能够区分两者。

const INPUT_MODALITY_DETECTOR_DEFAULT_OPTIONS: InputModalityDetectorOptions;

INPUT_MODALITY_DETECTOR_OPTIONS

InputModalityDetector 的可注入选项。这些会与默认选项进行浅合并。

const INPUT_MODALITY_DETECTOR_OPTIONS: InjectionToken<InputModalityDetectorOptions>;

MESSAGES_CONTAINER_ID

用于追加所有消息的正文容器的 ID。

const MESSAGES_CONTAINER_ID: "cdk-describedby-message-container";

CDK_DESCRIBEDBY_ID_PREFIX

用于所创建的每个消息元素的 ID 前缀。

const CDK_DESCRIBEDBY_ID_PREFIX: "cdk-describedby-message";

CDK_DESCRIBEDBY_HOST_ATTRIBUTE

用来指定消息元素描述的每个宿主元素的属性。

const CDK_DESCRIBEDBY_HOST_ATTRIBUTE: "cdk-describedby-host";

FOCUS_TRAP_INERT_STRATEGY

用于指定惰性策略的注入令牌。

const FOCUS_TRAP_INERT_STRATEGY: InjectionToken<FocusTrapInertStrategy>;

LIVE_ANNOUNCER_ELEMENT_TOKEN

const LIVE_ANNOUNCER_ELEMENT_TOKEN: InjectionToken<HTMLElement>;

LIVE_ANNOUNCER_DEFAULT_OPTIONS

注入令牌，可用于配置 LiveAnnouncer 的默认选项。

const LIVE_ANNOUNCER_DEFAULT_OPTIONS: InjectionToken<LiveAnnouncerDefaultOptions>;

FOCUS_MONITOR_DEFAULT_OPTIONS

FocusMonitorOptions 的 InjectionToken。

const FOCUS_MONITOR_DEFAULT_OPTIONS: InjectionToken<FocusMonitorOptions>;