无障碍性 Accessibility

获取页面的当前高对比度模式。

Gets the current high-contrast-mode for the page.

为宿主元素添加一个由 aria-describedby 引用的不可见的消息元素。如果已经注册了相同的消息，则它将复用已创建的消息元素。

Adds to the host element an aria-describedby reference to a hidden element that contains the message. If the same message has already been registered, then it will reuse the created message element.

为宿主元素添加一个由 aria-describedby 引用的现有消息元素。

Adds to the host element an aria-describedby reference to an already-existing message element.

在指定元素周围创建一个焦点捕获区域。

Creates a focus-trapped region around the given element.

要在其周围捕获焦点的元素。

@param element The element around which focus will be trapped.

焦点陷阱配置。

@param config The focus trap configuration.

所创建的焦点陷阱实例。

@returns The created focus trap instance.

传递一个配置对象，而不是 deferCaptureElements 标志。

@deprecated Pass a config object instead of the deferCaptureElements flag.

@breaking-change 11.0.0

在指定元素周围创建一个焦点捕获 zone 。

Creates a focus-trapped region around the given element.

将在其周围捕获焦点的元素。

@param element The element around which focus will be trapped.

推迟创建由用户手动完成的焦点捕获元素。

@param deferCaptureElements Defers the creation of focus-capturing elements to be done manually by the user.

创建的焦点陷阱实例。

@returns The created focus trap instance.

获取元素是否被禁用。

Gets whether an element is disabled.

要检查的元素。

@param element Element to be checked.

元素是否被禁用。

@returns Whether the element is disabled.

获取用户是否可以给某个元素设置焦点。

Gets whether an element can be focused by the user.

要检查的元素。

@param element Element to be checked.

带有用于自定义此方法行为的选项的配置对象

@param config The config object with options to customize this method's behavior

元素是否可获得焦点。

@returns Whether the element is focusable.

获取是否可以通过 Tab 键访问元素。假定已经使用 isFocusable 检查过此元素。

Gets whether an element can be reached via Tab key. Assumes that the element has already been checked with isFocusable.

要检查的元素。

@param element Element to be checked.

元素是否可 tab。

@returns Whether the element is tabbable.

获取某元素可见是否出于交互目的。

Gets whether an element is visible for the purposes of interactivity.

这包括 display: none 和 visibility: hidden 状态下的，但被 overflow: hidden 的父对象切掉或位于视口之外的除外。

This will capture states like display: none and visibility: hidden, but not things like being clipped by an overflow: hidden parent or being outside the viewport.

元素是否可见。

@returns Whether the element is visible.

向屏幕阅读器发布一条消息。

Announces a message to screenreaders.

要通知到屏幕阅读器的消息。

@param message Message to be announced to the screenreader.

将消息添加到 DOM 时将解决的 Promise。

@returns Promise that will be resolved when the message is added to the DOM.

向屏幕阅读器发布一条消息。

Announces a message to screenreaders.

要通知屏幕阅读器的消息。

@param message Message to be announced to the screenreader.

播音员元素的礼貌度。

@param politeness The politeness of the announcer element.

将消息添加到 DOM 时将解决的 Promise。

@returns Promise that will be resolved when the message is added to the DOM.

向屏幕阅读器发布一条消息。

Announces a message to screenreaders.

要通知屏幕阅读器的消息。

@param message Message to be announced to the screenreader.

清除播音员元素的时间（以毫秒为单位）。请注意，这是在将消息添加到 DOM 后生效的，这可能在调用 announce 之后的最多 100ms。

@param duration Time in milliseconds after which to clear out the announcer element. Note that this takes effect after the message has been added to the DOM, which can be up to 100ms after announce has been called.

将消息添加到 DOM 时将解决的 Promise。

@returns Promise that will be resolved when the message is added to the DOM.

向屏幕阅读器发布一条消息。

Announces a message to screenreaders.

要通知屏幕阅读器的消息。

@param message Message to be announced to the screenreader.

播音员元素的礼貌度。

@param politeness The politeness of the announcer element.

清除播音员元素的时间（以毫秒为单位）。请注意，这是在将消息添加到 DOM 后生效的，这可能在 announce 被调用之后最多 100ms。

@param duration Time in milliseconds after which to clear out the announcer element. Note that this takes effect after the message has been added to the DOM, which can be up to 100ms after announce has been called.

将消息添加到 DOM 时将解决的 Promise。

@returns Promise that will be resolved when the message is added to the DOM.

从播音员元素中清除当前文本。可以用于防止屏幕阅读器在用户浏览页面地标时再次读出文本。

Clears the current text from the announcer element. Can be used to prevent screen readers from reading the text out again while the user is going through the page landmarks.

通过指定的焦点来源对元素进行聚焦。

Focuses the element via the specified focus origin.

要获取焦点的元素。

@param element Element to focus.

焦点来源。

@param origin Focus origin.

可用于配置焦点行为的选项。

@param options Options that can be used to configure the focus behavior.

通过指定的焦点来源对元素进行聚焦。

Focuses the element via the specified focus origin.

要获取焦点的元素。

@param element Element to focus.

焦点来源。

@param origin Focus origin.

可用于配置焦点行为的选项。

@param options Options that can be used to configure the focus behavior.

监视元素的焦点，并应用适当的 CSS 类。

Monitors focus on an element and applies appropriate CSS classes.

要监视的元素

@param element The element to monitor

当子元素获得焦点时是否要计入这个焦点。

@param checkChildren Whether to count the element as focused when its children are focused.

会在元素的焦点状态更改时发出通知的可观察对象。当元素失焦时，将发出 null。

@returns An observable that emits when the focus state of the element changes. When the element is blurred, null will be emitted.

监视元素的焦点，并应用适当的 CSS 类。

Monitors focus on an element and applies appropriate CSS classes.

要监视的元素

@param element The element to monitor

当子元素获得焦点时是否要计入这个焦点。

@param checkChildren Whether to count the element as focused when its children are focused.

会在元素的焦点状态更改时发出通知的可观察对象。当元素失焦时，将发出 null。

@returns An observable that emits when the focus state of the element changes. When the element is blurred, null will be emitted.

获取用户当前是否正在使用预输入函数键入此管理员。

Gets whether the user is currently typing into the manager using the typeahead feature.

根据传入的键盘事件设置激活条目。

Sets the active item depending on the key event passed in.

用于确定哪个元素应处于活动状态的键盘事件。

@param event Keyboard event to be used for determining which element should be active.

将活动条目设置为指定索引处的条目，并将活动样式添加到新活动条目。也会从以前的活动条目中删除活动样式。

Sets the active item to the item at the specified index and adds the active styles to the newly active item. Also removes active styles from the previously active item.

要设置为活动条目的索引。

@param index Index of the item to be set as active.

将活动条目设置为指定的条目，并将活动样式添加到该条目。也从以前的活动条目中删除活动样式。

Sets the active item to the item to the specified one and adds the active styles to the it. Also removes active styles from the previously active item.

要设置为活动的条目。

@param item Item to be set as active.

将激活条目设置为列表中第一个可用的（enabled）条目。

Sets the active item to the first enabled item in the list.

将激活条目设置为列表中最后一个可用的（enabled）条目。

Sets the active item to the last enabled item in the list.

将激活条目设置为列表中的下一个可用的（enabled）条目。

Sets the active item to the next enabled item in the list.

将激活条目设置为列表中的上一个可用的（enabled）条目。

Sets the active item to a previous enabled item in the list.

设置谓词函数，该函数会确定列表按键管理器应跳过哪些条目。

Sets the predicate function that determines which items should be skipped by the list key manager.

确定是否应跳过指定条目的函数。

@param predicate Function that determines whether the given item should be skipped.

允许在没有任何其他效果的情况下设置激活状态。

Allows setting the active without any other effects.

要设置为活动条目的索引。

@param index Index of the item to be set as active.

允许设置活动条目，而没有任何其他影响。

Allows setting the active item without any other effects.

要设置为活动的条目。

@param item Item to be set as active.

用户按下方向键时，可以按住修饰键并防止其默认操作。默认为不允许任何修饰键。

Modifier keys which are allowed to be held down and whose default actions will be prevented as the user is pressing the arrow keys. Defaults to not allowing any modifier keys.

配置按键管理器，以在按下 Home 或 End 键时分别激活第一项和最后一项。

Configures the key manager to activate the first and last items respectively when the Home or End key is pressed.

按下 Home 键或 End 键时是否激活第一项/最后一项。

@param enabled Whether pressing the Home or End key activates the first/last item.

配置按键管理器以水平移动选择。传递 null 将禁用水平移动。

Configures the key manager to move the selection horizontally. Passing in null will disable horizontal movement.

所选内容可以移动的方向。

@param direction Direction in which the selection can be moved.

打开预输入模式，该模式允许用户通过键入来设置活动条目。

Turns on typeahead mode which allows users to set the active item by typing.

在最后一次按键操作之后等待一小段时间，然后再设置活动条目。

@param debounceInterval Time to wait after the last keystroke before setting the active item.

配置按键管理器是否应该能够垂直移动选择。

Configures whether the key manager should be able to move the selection vertically.

是否应启用垂直选择。

@param enabled Whether vertical selection should be enabled.

配置回卷模式，当该模式确定在指定方向上没有更多条目时，活动条目是否将回卷列表的另一端。

Configures wrapping mode, which determines whether the active item will wrap to the other end of list when there are no more items in the given direction.

到达末尾时列表是否应该回卷。

@param shouldWrap Whether the list should wrap when reaching the end.

获取用户当前是否正在使用预输入函数键入此管理员。

Gets whether the user is currently typing into the manager using the typeahead feature.

根据传入的键盘事件设置激活条目。

Sets the active item depending on the key event passed in.

用于确定哪个元素应处于活动状态的键盘事件。

@param event Keyboard event to be used for determining which element should be active.

将活动条目设置为指定索引处的条目，并让新的活动条目获得焦点。

Sets the active item to the item at the specified index and focuses the newly active item.

要设置为活动条目的索引。

@param index Index of the item to be set as active.

将活动条目设置为指定的条目并让它获得焦点。

Sets the active item to the item that is specified and focuses it.

要设置为活动的条目。

@param item Item to be set as active.

将激活条目设置为列表中第一个可用的（enabled）条目。

Sets the active item to the first enabled item in the list.

设置焦点来源，该焦点来源将传递给所有后续调用 focus 的条目。

Sets the focus origin that will be passed in to the items for any subsequent focus calls.

用来让条目获取焦点时的焦点来源。

@param origin Focus origin to be used when focusing items.

将激活条目设置为列表中最后一个可用的（enabled）条目。

Sets the active item to the last enabled item in the list.

将激活条目设置为列表中的下一个可用的（enabled）条目。

Sets the active item to the next enabled item in the list.

将激活条目设置为列表中的上一个可用的（enabled）条目。

Sets the active item to a previous enabled item in the list.

设置谓词函数，该函数会确定列表按键管理器应跳过哪些条目。

Sets the predicate function that determines which items should be skipped by the list key manager.

确定是否应跳过指定条目的函数。

@param predicate Function that determines whether the given item should be skipped.

允许在没有任何其他效果的情况下设置激活状态。

Allows setting the active without any other effects.

要设置为活动条目的索引。

@param index Index of the item to be set as active.

允许设置活动条目，而没有任何其他影响。

Allows setting the active item without any other effects.

要设置为活动的条目。

@param item Item to be set as active.

用户按下方向键时，可以按住修饰键并防止其默认操作。默认为不允许任何修饰键。

Modifier keys which are allowed to be held down and whose default actions will be prevented as the user is pressing the arrow keys. Defaults to not allowing any modifier keys.

配置按键管理器，以在按下 Home 或 End 键时分别激活第一项和最后一项。

Configures the key manager to activate the first and last items respectively when the Home or End key is pressed.

按下 Home 键或 End 键时是否激活第一项/最后一项。

@param enabled Whether pressing the Home or End key activates the first/last item.

配置按键管理器以水平移动选择。传递 null 将禁用水平移动。

Configures the key manager to move the selection horizontally. Passing in null will disable horizontal movement.

所选内容可以移动的方向。

@param direction Direction in which the selection can be moved.

打开预输入模式，该模式允许用户通过键入来设置活动条目。

Turns on typeahead mode which allows users to set the active item by typing.

在最后一次按键操作之后等待一小段时间，然后再设置活动条目。

@param debounceInterval Time to wait after the last keystroke before setting the active item.

配置按键管理器是否应该能够垂直移动选择。

Configures whether the key manager should be able to move the selection vertically.

是否应启用垂直选择。

@param enabled Whether vertical selection should be enabled.

配置回卷模式，当该模式确定在指定方向上没有更多条目时，活动条目是否将回卷列表的另一端。

Configures wrapping mode, which determines whether the active item will wrap to the other end of list when there are no more items in the given direction.

到达末尾时列表是否应该回卷。

@param shouldWrap Whether the list should wrap when reaching the end.

获取用户当前是否正在使用预输入函数键入此管理员。

Gets whether the user is currently typing into the manager using the typeahead feature.

根据传入的键盘事件设置激活条目。

Sets the active item depending on the key event passed in.

用于确定哪个元素应处于活动状态的键盘事件。

@param event Keyboard event to be used for determining which element should be active.

把激活条目设置为由索引指定的条目。

Sets the active item to the item at the index specified.

要设置为活动的条目的索引。

@param index The index of the item to be set as active.

将活动条目设置为指定的条目。

Sets the active item to the specified item.

要设置为活动的条目。

@param item The item to be set as active.

将激活条目设置为列表中第一个可用的（enabled）条目。

Sets the active item to the first enabled item in the list.

将激活条目设置为列表中最后一个可用的（enabled）条目。

Sets the active item to the last enabled item in the list.

将激活条目设置为列表中的下一个可用的（enabled）条目。

Sets the active item to the next enabled item in the list.

将激活条目设置为列表中的上一个可用的（enabled）条目。

Sets the active item to a previous enabled item in the list.

设置谓词函数，该函数会确定列表按键管理器应跳过哪些条目。

Sets the predicate function that determines which items should be skipped by the list key manager.

确定是否应跳过指定条目的函数。

@param predicate Function that determines whether the given item should be skipped.

允许在没有任何其他效果的情况下设置激活状态。

Allows setting the active without any other effects.

要设置为活动条目的索引。

@param index Index of the item to be set as active.

允许设置活动条目，而没有任何其他影响。

Allows setting the active item without any other effects.

要设置为活动的条目。

@param item Item to be set as active.

用户按下方向键时，可以按住修饰键并防止其默认操作。默认为不允许任何修饰键。

Modifier keys which are allowed to be held down and whose default actions will be prevented as the user is pressing the arrow keys. Defaults to not allowing any modifier keys.

配置按键管理器，以在按下 Home 或 End 键时分别激活第一项和最后一项。

Configures the key manager to activate the first and last items respectively when the Home or End key is pressed.

按下 Home 键或 End 键时是否激活第一项/最后一项。

@param enabled Whether pressing the Home or End key activates the first/last item.

配置按键管理器以水平移动选择。传递 null 将禁用水平移动。

Configures the key manager to move the selection horizontally. Passing in null will disable horizontal movement.

所选内容可以移动的方向。

@param direction Direction in which the selection can be moved.

打开预输入模式，该模式允许用户通过键入来设置活动条目。

Turns on typeahead mode which allows users to set the active item by typing.

在最后一次按键操作之后等待一小段时间，然后再设置活动条目。

@param debounceInterval Time to wait after the last keystroke before setting the active item.

配置按键管理器是否应该能够垂直移动选择。

Configures whether the key manager should be able to move the selection vertically.

是否应启用垂直选择。

@param enabled Whether vertical selection should be enabled.

配置回卷模式，当该模式确定在指定方向上没有更多条目时，活动条目是否将回卷列表的另一端。

Configures wrapping mode, which determines whether the active item will wrap to the other end of list when there are no more items in the given direction.

到达末尾时列表是否应该回卷。

@param shouldWrap Whether the list should wrap when reaching the end.

将这些锚点插入 DOM。这通常是在构造函数中自动完成的，但是对于诸如 *ngIf 之类的指令，可以将其推迟。

Inserts the anchors into the DOM. This is usually done automatically in the constructor, but can be deferred for cases like directives with *ngIf.

焦点陷阱是否成功附加。如果目标元素当前不在 DOM 中，则可能不是这种情况。

@returns Whether the focus trap managed to attach successfully. This may not be the case if the target element isn't currently in the DOM.

通知 FocusTrapManager，此 FocusTrap 将被销毁。

Notifies the FocusTrapManager that this FocusTrap will be destroyed.

让焦点陷阱范围内第一个可 tab 的元素获得焦点。

Focuses the first tabbable element within the focus trap region.

焦点是否成功移动。

@returns Whether focus was moved successfully.

等待 zone 稳定，然后让焦点陷阱内第一个可 tab 的元素获得焦点。

Waits for the zone to stabilize, then focuses the first tabbable element within the focus trap region.

返回一个解析为布尔值的 promise，具体取决于焦点是否成功移动。

@returns Returns a promise that resolves with a boolean, depending on whether focus was moved successfully.

在初始化焦点陷阱时应获得焦点的元素。

Focuses the element that should be focused when the focus trap is initialized.

焦点是否成功移动。

@returns Whether focus was moved successfully.

等待 zone 稳定，然后聚焦用户指定的第一个元素或第一个可 tab 的元素。

Waits for the zone to stabilize, then either focuses the first element that the user specified, or the first tabbable element.

返回一个解析为布尔值的 promise，具体取决于焦点是否成功移动。

@returns Returns a promise that resolves with a boolean, depending on whether focus was moved successfully.

让焦点陷阱范围内最后一个可 tab 的元素获得焦点。

Focuses the last tabbable element within the focus trap region.

焦点是否成功移动。

@returns Whether focus was moved successfully.

等待 zone 稳定，然后让焦点陷阱内最后一个可 tab 的元素获得焦点。

Waits for the zone to stabilize, then focuses the last tabbable element within the focus trap region.

返回一个解析为布尔值的 promise，具体取决于焦点是否成功移动。

@returns Returns a promise that resolves with a boolean, depending on whether focus was moved successfully.

检查焦点陷阱是否已附加成功。

Checks whether the focus trap has successfully been attached.

删除在 preventFocus 中添加的事件侦听器。

Removes the event listener added in preventFocus.

添加一个文档事件监听器，使焦点保持在 FocusTrap 内部。

Adds a document event listener that keeps focus inside the FocusTrap.

将这些锚点插入 DOM。这通常是在构造函数中自动完成的，但是对于诸如 *ngIf 之类的指令，可以将其推迟。

Inserts the anchors into the DOM. This is usually done automatically in the constructor, but can be deferred for cases like directives with *ngIf.

焦点陷阱是否成功附加。如果目标元素当前不在 DOM 中，则可能不是这种情况。

@returns Whether the focus trap managed to attach successfully. This may not be the case if the target element isn't currently in the DOM.

清理锚点以销毁焦点陷阱。

Destroys the focus trap by cleaning up the anchors.

让焦点陷阱范围内第一个可 tab 的元素获得焦点。

Focuses the first tabbable element within the focus trap region.

焦点是否成功移动。

@returns Whether focus was moved successfully.

等待 zone 稳定，然后让焦点陷阱内第一个可 tab 的元素获得焦点。

Waits for the zone to stabilize, then focuses the first tabbable element within the focus trap region.

返回一个解析为布尔值的 promise，具体取决于焦点是否成功移动。

@returns Returns a promise that resolves with a boolean, depending on whether focus was moved successfully.

在初始化焦点陷阱时应获得焦点的元素。

Focuses the element that should be focused when the focus trap is initialized.

焦点是否成功移动。

@returns Whether focus was moved successfully.

等待 zone 稳定，然后聚焦用户指定的第一个元素或第一个可 tab 的元素。

Waits for the zone to stabilize, then either focuses the first element that the user specified, or the first tabbable element.

返回一个解析为布尔值的 promise，具体取决于焦点是否成功移动。

@returns Returns a promise that resolves with a boolean, depending on whether focus was moved successfully.

让焦点陷阱范围内最后一个可 tab 的元素获得焦点。

Focuses the last tabbable element within the focus trap region.

焦点是否成功移动。

@returns Whether focus was moved successfully.

等待 zone 稳定，然后让焦点陷阱内最后一个可 tab 的元素获得焦点。

Waits for the zone to stabilize, then focuses the last tabbable element within the focus trap region.

返回一个解析为布尔值的 promise，具体取决于焦点是否成功移动。

@returns Returns a promise that resolves with a boolean, depending on whether focus was moved successfully.

检查焦点陷阱是否已附加成功。

Checks whether the focus trap has successfully been attached.

切换 tabindex 以捕获 Tab 焦点或允许脱离。

Toggles thetabindex of both anchors to either trap Tab focus or allow it to escape.

@param enabled: Whether the anchors should trap Tab.

将活动条目的样式应用于此条目。

Applies the styles for an active item to this item.

将非活动条目的样式应用于此条目。

Applies the styles for an inactive item to this item.

让此 FocusableOption 获得焦点。

Focuses the FocusableOption.

获取此选项的标签。

Gets the label for this option.

通过 preventFocus 以前的状态，来把元素恢复为不可获得焦点的状态。

Reverts elements made unfocusable by preventFocus to their previous state.

使 focusTrap 之外的所有元素都无法获得焦点。

Makes all elements outside focusTrap unfocusable.

Gets whether an event could be a faked mousedown event dispatched by a screen reader.

Gets whether an event could be a faked touchstart event dispatched by a screen reader.