Skip to content

Commit

Permalink
fix(material/menu): focus the first item when opening menu on iOS Voi…
Browse files Browse the repository at this point in the history
…ceOver (#24733)

When opening the menu using the iOS VoiceOver screen reader, focus the first item in the menu.
Previously, the first menu item would focus on other screen readers like desktop VoiceOver but
not with iOS VoiceOver.

Waiting until `onStable` seems to fix this.

Fixes #24735

(cherry picked from commit f76103d)
  • Loading branch information
zarend committed May 6, 2022
1 parent 0bede63 commit e486ed9
Showing 1 changed file with 21 additions and 32 deletions.
53 changes: 21 additions & 32 deletions src/material/menu/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -409,42 +409,31 @@ export class _MatMenuBase
* @param origin Action from which the focus originated. Used to set the correct styling.
*/
focusFirstItem(origin: FocusOrigin = 'program'): void {
// When the content is rendered lazily, it takes a bit before the items are inside the DOM.
if (this.lazyContent) {
this._ngZone.onStable.pipe(take(1)).subscribe(() => this._focusFirstItem(origin));
} else {
this._focusFirstItem(origin);
}
}
// Wait for `onStable` to ensure iOS VoiceOver screen reader focuses the first item (#24735).
this._ngZone.onStable.pipe(take(1)).subscribe(() => {
let menuPanel: HTMLElement | null = null;

if (this._directDescendantItems.length) {
// Because the `mat-menuPanel` is at the DOM insertion point, not inside the overlay, we don't
// have a nice way of getting a hold of the menuPanel panel. We can't use a `ViewChild` either
// because the panel is inside an `ng-template`. We work around it by starting from one of
// the items and walking up the DOM.
menuPanel = this._directDescendantItems.first!._getHostElement().closest('[role="menu"]');
}

/**
* Actual implementation that focuses the first item. Needs to be separated
* out so we don't repeat the same logic in the public `focusFirstItem` method.
*/
private _focusFirstItem(origin: FocusOrigin) {
const manager = this._keyManager;
// If an item in the menuPanel is already focused, avoid overriding the focus.
if (!menuPanel || !menuPanel.contains(document.activeElement)) {
const manager = this._keyManager;
manager.setFocusOrigin(origin).setFirstItemActive();

manager.setFocusOrigin(origin).setFirstItemActive();

// If there's no active item at this point, it means that all the items are disabled.
// Move focus to the menu panel so keyboard events like Escape still work. Also this will
// give _some_ feedback to screen readers.
if (!manager.activeItem && this._directDescendantItems.length) {
let element = this._directDescendantItems.first!._getHostElement().parentElement;

// Because the `mat-menu` is at the DOM insertion point, not inside the overlay, we don't
// have a nice way of getting a hold of the menu panel. We can't use a `ViewChild` either
// because the panel is inside an `ng-template`. We work around it by starting from one of
// the items and walking up the DOM.
while (element) {
if (element.getAttribute('role') === 'menu') {
element.focus();
break;
} else {
element = element.parentElement;
// If there's no active item at this point, it means that all the items are disabled.
// Move focus to the menuPanel panel so keyboard events like Escape still work. Also this will
// give _some_ feedback to screen readers.
if (!manager.activeItem && menuPanel) {
menuPanel.focus();
}
}
}
});
}

/**
Expand Down

0 comments on commit e486ed9

Please sign in to comment.