Accessibility

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

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.

Removes the host element's aria-describedby reference to the message element.

Creates a focus-trapped region around the given element.

Creates a focus-trapped region around the given element.

Gets whether an element is disabled.

Gets whether an element can be focused by the user.

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

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

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.

Announces a message to screenreaders.

Announces a message to screenreaders.

Announces a message to screenreaders.

Announces a message to screenreaders.

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.

Focuses the element via the specified focus origin.

Monitors focus on an element and applies appropriate CSS classes.

Monitors focus on an element and applies appropriate CSS classes.

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.

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.

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.

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

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

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

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.

Allows setting the active without any other effects.

Allows setting the active item without any other effects.

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.

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

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

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

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

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.

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.

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

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

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

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

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

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

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.

Allows setting the active without any other effects.

Allows setting the active item without any other effects.

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.

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

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

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

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

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.

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.

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

Sets the active item to the specified item.

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

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

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

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.

Allows setting the active without any other effects.

Allows setting the active item without any other effects.

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.

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

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

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

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

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.

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

Notifies the FocusTrapManager that this FocusTrap will be destroyed.

Focuses the first tabbable element within the focus trap region.

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

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

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

Focuses the last tabbable element within the focus trap region.

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

Checks whether the focus trap has successfuly been attached.

Removes the event listener added in preventFocus.

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

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

Destroys the focus trap by cleaning up the anchors.

Focuses the first tabbable element within the focus trap region.

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

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

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

Focuses the last tabbable element within the focus trap region.

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

Checks whether the focus trap has successfuly been attached.

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

Applies the styles for an active item to this item.

Applies the styles for an inactive item to this item.

Focuses the FocusableOption.

Gets the label for this option.

Reverts elements made unfocusable by preventFocus to their previous state.

Makes all elements outside focusTrap unfocusable.

Screenreaders will often fire fake mousedown events when a focusable element is activated using the keyboard. We can typically distinguish between these faked mousedown events and real mousedown events using the "buttons" property. While real mousedowns will indicate the mouse button that was pressed (e.g. "1" for the left mouse button), faked mousedowns will usually set the property value to 0.