Skip to content

Commit

Permalink
Reland "Use semantics label for backbutton and closebutton for Androi…
Browse files Browse the repository at this point in the history
…d" (#115776)

* Reland "Use semantics label for backbutton and closebutton for Android"

This reverts commit 20a78ed.

* change to default target platform
  • Loading branch information
chunhtai committed Dec 7, 2022
1 parent 7673108 commit 68ce1ae
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 12 deletions.
51 changes: 42 additions & 9 deletions packages/flutter/lib/src/material/back_button.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';

import 'debug.dart';
Expand All @@ -27,22 +28,39 @@ class BackButtonIcon extends StatelessWidget {
/// the current platform (as obtained from the [Theme]).
const BackButtonIcon({ super.key });

/// Returns the appropriate "back" icon for the given `platform`.
static IconData _getIconData(TargetPlatform platform) {
switch (platform) {
@override
Widget build(BuildContext context) {
final String? semanticsLabel;
final IconData data;
switch (Theme.of(context).platform) {
case TargetPlatform.android:
case TargetPlatform.fuchsia:
case TargetPlatform.linux:
case TargetPlatform.windows:
return Icons.arrow_back;
data = Icons.arrow_back;
break;
case TargetPlatform.iOS:
case TargetPlatform.macOS:
return Icons.arrow_back_ios;
data = Icons.arrow_back_ios;
break;
}
// This can't use the platform from Theme because it is the Android OS that
// expects the duplicated tooltip and label.
switch (defaultTargetPlatform) {
case TargetPlatform.android:
semanticsLabel = MaterialLocalizations.of(context).backButtonTooltip;
break;
case TargetPlatform.fuchsia:
case TargetPlatform.linux:
case TargetPlatform.windows:
case TargetPlatform.iOS:
case TargetPlatform.macOS:
semanticsLabel = null;
break;
}
}

@override
Widget build(BuildContext context) => Icon(_getIconData(Theme.of(context).platform));
return Icon(data, semanticLabel: semanticsLabel);
}
}

/// A Material Design back button.
Expand Down Expand Up @@ -149,8 +167,23 @@ class CloseButton extends StatelessWidget {
@override
Widget build(BuildContext context) {
assert(debugCheckHasMaterialLocalizations(context));
final String? semanticsLabel;
// This can't use the platform from Theme because it is the Android OS that
// expects the duplicated tooltip and label.
switch (defaultTargetPlatform) {
case TargetPlatform.android:
semanticsLabel = MaterialLocalizations.of(context).closeButtonTooltip;
break;
case TargetPlatform.fuchsia:
case TargetPlatform.linux:
case TargetPlatform.windows:
case TargetPlatform.iOS:
case TargetPlatform.macOS:
semanticsLabel = null;
break;
}
return IconButton(
icon: const Icon(Icons.close),
icon: Icon(Icons.close, semanticLabel: semanticsLabel),
color: color,
tooltip: MaterialLocalizations.of(context).closeButtonTooltip,
onPressed: () {
Expand Down
6 changes: 5 additions & 1 deletion packages/flutter/lib/src/widgets/semantics_debugger.dart
Original file line number Diff line number Diff line change
Expand Up @@ -288,10 +288,14 @@ class _SemanticsDebuggerPainter extends CustomPainter {

assert(data.attributedLabel != null);
final String message;
// Android will avoid pronouncing duplicating tooltip and label.
// Therefore, having two identical strings is the same as having a single
// string.
final bool shouldIgnoreDuplicatedLabel = defaultTargetPlatform == TargetPlatform.android && data.attributedLabel.string == data.tooltip;
final String tooltipAndLabel = <String>[
if (data.tooltip.isNotEmpty)
data.tooltip,
if (data.attributedLabel.string.isNotEmpty)
if (data.attributedLabel.string.isNotEmpty && !shouldIgnoreDuplicatedLabel)
data.attributedLabel.string,
].join('\n');
if (tooltipAndLabel.isEmpty) {
Expand Down
61 changes: 59 additions & 2 deletions packages/flutter/test/material/back_button_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';

Expand Down Expand Up @@ -152,17 +153,73 @@ void main() {
tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');

await tester.pumpAndSettle();

final String? expectedLabel;
switch(defaultTargetPlatform) {
case TargetPlatform.android:
expectedLabel = 'Back';
break;
case TargetPlatform.fuchsia:
case TargetPlatform.iOS:
case TargetPlatform.linux:
case TargetPlatform.macOS:
case TargetPlatform.windows:
expectedLabel = null;
}
expect(tester.getSemantics(find.byType(BackButton)), matchesSemantics(
tooltip: 'Back',
label: expectedLabel,
isButton: true,
hasEnabledState: true,
isEnabled: true,
hasTapAction: true,
isFocusable: true,
));
handle.dispose();
});
}, variant: TargetPlatformVariant.all());

testWidgets('CloseButton semantics', (WidgetTester tester) async {
final SemanticsHandle handle = tester.ensureSemantics();
await tester.pumpWidget(
MaterialApp(
home: const Material(child: Text('Home')),
routes: <String, WidgetBuilder>{
'/next': (BuildContext context) {
return const Material(
child: Center(
child: CloseButton(),
),
);
},
},
),
);

tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');

await tester.pumpAndSettle();
final String? expectedLabel;
switch(defaultTargetPlatform) {
case TargetPlatform.android:
expectedLabel = 'Close';
break;
case TargetPlatform.fuchsia:
case TargetPlatform.iOS:
case TargetPlatform.linux:
case TargetPlatform.macOS:
case TargetPlatform.windows:
expectedLabel = null;
}
expect(tester.getSemantics(find.byType(CloseButton)), matchesSemantics(
tooltip: 'Close',
label: expectedLabel,
isButton: true,
hasEnabledState: true,
isEnabled: true,
hasTapAction: true,
isFocusable: true,
));
handle.dispose();
}, variant: TargetPlatformVariant.all());

testWidgets('CloseButton color', (WidgetTester tester) async {
await tester.pumpWidget(
Expand Down
28 changes: 28 additions & 0 deletions packages/flutter/test/widgets/semantics_debugger_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';

Expand Down Expand Up @@ -438,6 +439,33 @@ void main() {
);
});

testWidgets('SemanticsDebugger ignores duplicated label and tooltip for Android', (WidgetTester tester) async {
final Key child = UniqueKey();
final Key debugger = UniqueKey();
final bool isPlatformAndroid = defaultTargetPlatform == TargetPlatform.android;
await tester.pumpWidget(
Directionality(
textDirection: TextDirection.ltr,
child: SemanticsDebugger(
key: debugger,
child: Material(
child: Semantics(
container: true,
key: child,
label: 'text',
tooltip: 'text',
),
),
),
),
);

expect(
_getMessageShownInSemanticsDebugger(widgetKey: child, debuggerKey: debugger, tester: tester),
isPlatformAndroid ? 'text' : 'text\ntext',
);
}, variant: TargetPlatformVariant.all());

testWidgets('SemanticsDebugger textfield', (WidgetTester tester) async {
final UniqueKey textField = UniqueKey();
final UniqueKey debugger = UniqueKey();
Expand Down

0 comments on commit 68ce1ae

Please sign in to comment.