Skip to content

Commit be64cac

Browse files
authored
[VPAT] Keep a11y_assessments snackbars open until closed (flutter#13451)
## Problem Six a11y_assessments demos show a `SnackBar` without an action. Those snack bars auto-dismiss after four seconds and offer no way to keep or reopen them, so users who need more time to read lose the message. ## Fix The snack bars set `persist: true` and `showCloseIcon: true`, so they stay until the user closes them. A snack bar with an action already persists by default. New tests on the snack bar, text button and app bar pages check that the snack bar outlasts its timeout and closes from the close icon. ## Demo Run the test app on web, open #/snack-bar, #/text-button or #/app-bar, show a snack bar, and wait more than four seconds.
1 parent a378299 commit be64cac

10 files changed

Lines changed: 70 additions & 14 deletions

File tree

‎packages/material_ui/test_apps/a11y_assessments/lib/use_cases/app_bar.dart‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,13 @@ class MainWidgetState extends State<MainWidget> {
5050
icon: const Icon(Icons.add_alert),
5151
tooltip: 'Show Snackbar',
5252
onPressed: () {
53-
ScaffoldMessenger.of(
54-
context,
55-
).showSnackBar(const SnackBar(content: Text('This is a snackbar')));
53+
ScaffoldMessenger.of(context).showSnackBar(
54+
const SnackBar(
55+
content: Text('This is a snackbar'),
56+
persist: true,
57+
showCloseIcon: true,
58+
),
59+
);
5660
},
5761
),
5862
IconButton(

‎packages/material_ui/test_apps/a11y_assessments/lib/use_cases/bottom_app_bar.dart‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ class MainWidgetState extends State<MainWidget> {
3939
_selectedAction = action;
4040
});
4141
ScaffoldMessenger.of(context).hideCurrentSnackBar();
42-
ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Tapped: $action')));
42+
ScaffoldMessenger.of(
43+
context,
44+
).showSnackBar(SnackBar(content: Text('Tapped: $action'), persist: true, showCloseIcon: true));
4345
}
4446

4547
@override

‎packages/material_ui/test_apps/a11y_assessments/lib/use_cases/search_bar.dart‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ class _MainWidgetState extends State<_MainWidget> {
6464
setState(() {
6565
_statusMessage = 'Searched for "$value"';
6666
});
67-
ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Searched for "$value"')));
67+
ScaffoldMessenger.of(context).showSnackBar(
68+
SnackBar(content: Text('Searched for "$value"'), persist: true, showCloseIcon: true),
69+
);
6870
}
6971

7072
Iterable<Widget> _getSuggestions(SearchController controller) {

‎packages/material_ui/test_apps/a11y_assessments/lib/use_cases/snack_bar.dart‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,13 @@ class MainWidgetState extends State<MainWidget> {
4242
ElevatedButton(
4343
child: const Text('Show Snackbar'),
4444
onPressed: () {
45-
ScaffoldMessenger.of(
46-
context,
47-
).showSnackBar(const SnackBar(content: Text('Awesome Snackbar!')));
45+
ScaffoldMessenger.of(context).showSnackBar(
46+
const SnackBar(
47+
content: Text('Awesome Snackbar!'),
48+
persist: true,
49+
showCloseIcon: true,
50+
),
51+
);
4852
},
4953
),
5054
ElevatedButton(

‎packages/material_ui/test_apps/a11y_assessments/lib/use_cases/text_button.dart‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,13 @@ class MainWidgetState extends State<MainWidget> {
6464
if (_formKey.currentState!.validate()) {
6565
// If the form is valid, display a snackbar. In the real world,
6666
// this might also send a request to a server.
67-
ScaffoldMessenger.of(
68-
context,
69-
).showSnackBar(const SnackBar(content: Text('Form submitted')));
67+
ScaffoldMessenger.of(context).showSnackBar(
68+
const SnackBar(
69+
content: Text('Form submitted'),
70+
persist: true,
71+
showCloseIcon: true,
72+
),
73+
);
7074
}
7175
},
7276
child: const Text('Submit'),

‎packages/material_ui/test_apps/a11y_assessments/lib/use_cases/text_form_field.dart‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,13 @@ class _MainWidgetState extends State<_MainWidget> {
7979
setState(() {
8080
_statusMessage = 'Form submitted successfully!';
8181
});
82-
ScaffoldMessenger.of(
83-
context,
84-
).showSnackBar(const SnackBar(content: Text('Form submitted successfully!')));
82+
ScaffoldMessenger.of(context).showSnackBar(
83+
const SnackBar(
84+
content: Text('Form submitted successfully!'),
85+
persist: true,
86+
showCloseIcon: true,
87+
),
88+
);
8589
} else {
8690
setState(() {
8791
_statusMessage = 'Validation failed';

‎packages/material_ui/test_apps/a11y_assessments/test/app_bar_test.dart‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,12 @@ void main() {
1212
await pumpsUseCase(tester, AppBarUseCase());
1313
expect(find.text('AppBar'), findsOneWidget);
1414
});
15+
16+
testWidgets('app bar snackbar stays until closed', (WidgetTester tester) async {
17+
await pumpsUseCase(tester, AppBarUseCase());
18+
await tester.tap(find.text('2. App bar with actions'));
19+
await tester.pumpAndSettle();
20+
await tester.tap(find.byTooltip('Show Snackbar'));
21+
await expectSnackBarStaysUntilClosed(tester, 'This is a snackbar');
22+
});
1523
}

‎packages/material_ui/test_apps/a11y_assessments/test/snack_bar_test.dart‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ void main() {
1818
expect(find.text(snackBarText), findsOneWidget);
1919
});
2020

21+
testWidgets('snack bar stays until closed', (WidgetTester tester) async {
22+
await pumpsUseCase(tester, SnackBarUseCase());
23+
await tester.tap(find.text('Show Snackbar'));
24+
await expectSnackBarStaysUntilClosed(tester, 'Awesome Snackbar!');
25+
});
26+
2127
testWidgets('snack bar demo page has one h1 tag', (WidgetTester tester) async {
2228
await pumpsUseCase(tester, SnackBarUseCase());
2329
final Finder findHeadingLevelOnes = find.bySemanticsLabel('SnackBar Demo');

‎packages/material_ui/test_apps/a11y_assessments/test/test_utils.dart‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,18 @@ List<String> descendantSemanticsLabels(SemanticsNode node) {
2828
});
2929
return labels;
3030
}
31+
32+
// Expects the visible snack bar with [text] to stay past its timeout, and to
33+
// close when its close icon is tapped.
34+
Future<void> expectSnackBarStaysUntilClosed(WidgetTester tester, String text) async {
35+
await tester.pumpAndSettle();
36+
expect(find.text(text), findsOneWidget);
37+
final SnackBar snackBar = tester.widget<SnackBar>(find.byType(SnackBar));
38+
await tester.pump(snackBar.duration * 2);
39+
await tester.pumpAndSettle();
40+
expect(find.text(text), findsOneWidget);
41+
42+
await tester.tap(find.descendant(of: find.byType(SnackBar), matching: find.byIcon(Icons.close)));
43+
await tester.pumpAndSettle();
44+
expect(find.text(text), findsNothing);
45+
}

‎packages/material_ui/test_apps/a11y_assessments/test/text_button_test.dart‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ void main() {
3333
expect(find.text('Form submitted'), findsOneWidget);
3434
});
3535

36+
testWidgets('submit snackbar stays until closed', (WidgetTester tester) async {
37+
await pumpsUseCase(tester, TextButtonUseCase());
38+
await tester.enterText(find.byType(TextFormField), 'test text');
39+
await tester.tap(find.text('Submit'));
40+
await expectSnackBarStaysUntilClosed(tester, 'Form submitted');
41+
});
42+
3643
testWidgets('text button demo page has one h1 tag', (WidgetTester tester) async {
3744
await pumpsUseCase(tester, TextButtonUseCase());
3845
final Finder findHeadingLevelOnes = find.bySemanticsLabel('TextButton Demo');

0 commit comments

Comments
 (0)