Skip to content

fix(material/bottom-sheet): focus first tabbable element by default #30549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 26, 2025
Merged

fix(material/bottom-sheet): focus first tabbable element by default #30549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions src/material/bottom-sheet/bottom-sheet-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,12 @@ export class MatBottomSheetConfig<D = any> {
*/
closeOnNavigation?: boolean = true;

// Note that this is set to 'dialog' by default, because while the a11y recommendations
// are to focus the first focusable element, doing so prevents screen readers from reading out the
// rest of the bottom sheet content.
/**
* Where the bottom sheet should focus on open.
* @breaking-change 14.0.0 Remove boolean option from autoFocus. Use string or
* AutoFocusTarget instead.
*/
autoFocus?: AutoFocusTarget | string | boolean = 'dialog';
autoFocus?: AutoFocusTarget | string | boolean = 'first-tabbable';

/**
* Whether the bottom sheet should restore focus to the
Expand Down
6 changes: 0 additions & 6 deletions src/material/bottom-sheet/bottom-sheet-container.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,17 +137,11 @@ export class MatBottomSheetContainer extends CdkDialogContainer implements OnDes
const isEnter = animationName === ENTER_ANIMATION;
const isExit = animationName === EXIT_ANIMATION;

if (isEnter) {
this._trapFocus();
}

if (isEnter || isExit) {
this._animationStateChanged.emit({
toState: isEnter ? 'visible' : 'hidden',
phase: isStart ? 'start' : 'done',
});
}
}

protected override _captureInitialFocus(): void {}
}
106 changes: 47 additions & 59 deletions src/material/bottom-sheet/bottom-sheet.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ describe('MatBottomSheet', () => {
beforeEach(() => document.body.appendChild(overlayContainerElement));
afterEach(() => overlayContainerElement.remove());

it('should focus the bottom sheet container by default', fakeAsync(() => {
it('should focus the first tabbable element by default', fakeAsync(() => {
bottomSheet.open(PizzaMsg, {
viewContainerRef: testViewContainerRef,
});
Expand All @@ -631,9 +631,7 @@ describe('MatBottomSheet', () => {
flush();
viewContainerFixture.detectChanges();

expect(document.activeElement!.tagName)
.withContext('Expected bottom sheet container to be focused.')
.toBe('MAT-BOTTOM-SHEET-CONTAINER');
expect(document.activeElement!.tagName).toBe('INPUT');
}));

it('should create a focus trap if autoFocus is disabled', fakeAsync(() => {
Expand Down Expand Up @@ -669,72 +667,62 @@ describe('MatBottomSheet', () => {
},
);

it(
'should focus the bottom sheet element on open when autoFocus is set to ' +
'"dialog" (the default)',
fakeAsync(() => {
bottomSheet.open(PizzaMsg, {
viewContainerRef: testViewContainerRef,
});
it('should focus the bottom sheet element on open when autoFocus is set to "dialog"', fakeAsync(() => {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes below are mostly formatting.

bottomSheet.open(PizzaMsg, {
viewContainerRef: testViewContainerRef,
autoFocus: 'dialog',
});

viewContainerFixture.detectChanges();
flush();
viewContainerFixture.detectChanges();
viewContainerFixture.detectChanges();
flush();
viewContainerFixture.detectChanges();

let container = overlayContainerElement.querySelector(
'.mat-bottom-sheet-container',
) as HTMLInputElement;
let container = overlayContainerElement.querySelector(
'.mat-bottom-sheet-container',
) as HTMLInputElement;

expect(document.activeElement)
.withContext('Expected container to be focused on open')
.toBe(container);
}),
);
expect(document.activeElement)
.withContext('Expected container to be focused on open')
.toBe(container);
}));

it(
'should focus the bottom sheet element on open when autoFocus is set to ' + '"first-heading"',
fakeAsync(() => {
bottomSheet.open(ContentElementDialog, {
viewContainerRef: testViewContainerRef,
autoFocus: 'first-heading',
});
it('should focus the bottom sheet element on open when autoFocus is set to "first-heading"', fakeAsync(() => {
bottomSheet.open(ContentElementDialog, {
viewContainerRef: testViewContainerRef,
autoFocus: 'first-heading',
});

viewContainerFixture.detectChanges();
flush();
viewContainerFixture.detectChanges();
viewContainerFixture.detectChanges();
flush();
viewContainerFixture.detectChanges();

let firstHeader = overlayContainerElement.querySelector(
'h1[tabindex="-1"]',
) as HTMLInputElement;
let firstHeader = overlayContainerElement.querySelector(
'h1[tabindex="-1"]',
) as HTMLInputElement;

expect(document.activeElement)
.withContext('Expected first header to be focused on open')
.toBe(firstHeader);
}),
);
expect(document.activeElement)
.withContext('Expected first header to be focused on open')
.toBe(firstHeader);
}));

it(
'should focus the first element that matches the css selector on open when ' +
'autoFocus is set to a css selector',
fakeAsync(() => {
bottomSheet.open(ContentElementDialog, {
viewContainerRef: testViewContainerRef,
autoFocus: 'p',
});
it('should focus the first element that matches the css selector on open when autoFocus is set to a css selector', fakeAsync(() => {
bottomSheet.open(ContentElementDialog, {
viewContainerRef: testViewContainerRef,
autoFocus: 'p',
});

viewContainerFixture.detectChanges();
flush();
viewContainerFixture.detectChanges();
viewContainerFixture.detectChanges();
flush();
viewContainerFixture.detectChanges();

let firstParagraph = overlayContainerElement.querySelector(
'p[tabindex="-1"]',
) as HTMLInputElement;
let firstParagraph = overlayContainerElement.querySelector(
'p[tabindex="-1"]',
) as HTMLInputElement;

expect(document.activeElement)
.withContext('Expected first paragraph to be focused on open')
.toBe(firstParagraph);
}),
);
expect(document.activeElement)
.withContext('Expected first paragraph to be focused on open')
.toBe(firstParagraph);
}));

it('should re-focus trigger element when bottom sheet closes', fakeAsync(() => {
const button = document.createElement('button');
Expand Down
2 changes: 0 additions & 2 deletions tools/public_api_guard/material/bottom-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ export class MatBottomSheetContainer extends CdkDialogContainer implements OnDes
toState: "visible" | "hidden";
phase: "start" | "done";
}>;
// (undocumented)
protected _captureInitialFocus(): void;
enter(): void;
exit(): void;
// (undocumented)
Expand Down
Loading