flutter / flutter

Flutter makes it easy and fast to build beautiful apps for mobile and beyond
https://flutter.dev
BSD 3-Clause "New" or "Revised" License
165.16k stars 27.24k forks source link

[a11y] TalkBack announces an IconButton incorrectly #147045

Open scopendo opened 5 months ago

scopendo commented 5 months ago

Steps to reproduce

On Android 13+, when an IconButton does not have semantics, TalkBack tries to detect and announce the icon. This announcement is overly verbose. When the IconButton is within a semantics node, the app behaves as though there is another semantics node leading to an unwanted announcement.

In the example below, the scaffold body contains a first IconButton with the icon Icons.person without explicit semantics, and a second IconButton with the icon Icons.group wrapped in a Semantics widget that has a label and button role.


(Aside – this GitHub issue form/template is a bit odd in that it starts with "Steps to reproduce" rather than a description of the problem)

Expected results

The first IconButton should be announced as "detected, icon, person, button".

The second IconButton button should be announced per the semantics as "group, button". Then moving the accessibility focus to the next element should move to the next widget (the SegmentedButton widget in the example).

Actual results

The first IconButton is announced as "detected, icon, people, button, double tap to activate". The phrase "double tap to activate" should not be included in this announcement, which is inconsistent with other buttons.

The second IconButton is correctly announced when it receives the accessibility focus as "group, button". However, moving the accessibility focus to the next element keeps the focus rect on the button and announces "detected, icon, people, button, double tap to activate". This detected additional announcement for the second icon button should not occur as that icon button has explicit semantics.

Of course, the issue with the second button can be avoided by setting excludeSemantics: true but that seems like a workaround for what is incorrect behaviour.

Code sample

Code sample ```dart import 'package:flutter/material.dart'; void main() { runApp(const MyApp()); } class MyApp extends StatelessWidget { const MyApp({super.key}); // This widget is the root of your application. @override Widget build(BuildContext context) { return const MaterialApp( title: 'Bug Demo', home: HomePage(title: 'Bug Demo'), ); } } class HomePage extends StatefulWidget { const HomePage({super.key, required this.title}); final String title; @override State createState() => _HomePageState(); } class _HomePageState extends State { var _themeMode = ThemeMode.light; @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( backgroundColor: Theme.of(context).colorScheme.inversePrimary, title: Text(widget.title), actions: [ PopupMenuButton( position: PopupMenuPosition.under, itemBuilder: (_) => const [ PopupMenuItem( child: Text('Menu item 1'), ), PopupMenuDivider(), PopupMenuItem( child: Text('Menu item 2'), ), ], ), ], ), body: Center( child: Column( mainAxisSize: MainAxisSize.min, children: [ IconButton( onPressed: () {}, icon: const Icon(Icons.person), ), Semantics( label: 'group', button: true, //excludeSemantics: true, child: IconButton( onPressed: () {}, icon: const Icon(Icons.group), ), ), const Divider(height: 40), SegmentedButton( showSelectedIcon: false, segments: const [ ButtonSegment( icon: Icon(Icons.light_mode), label: Text('Light mode'), value: ThemeMode.light, ), ButtonSegment( icon: Icon(Icons.dark_mode), label: Text('Dark mode'), value: ThemeMode.dark, ), ], selected: {_themeMode}, onSelectionChanged: (selected) { setState(() { _themeMode = selected.first; }); }, ), ], ), ), ); } } ```

Screenshots or Video

No response

Logs

No response

Flutter Doctor output

Doctor output ```console Doctor summary (to see all details, run flutter doctor -v): [✓] Flutter (Channel stable, 3.19.5, on macOS 14.4.1 23E224 darwin-arm64, locale en-GB) [✓] Android toolchain - develop for Android devices (Android SDK version 34.0.0) [✓] Xcode - develop for iOS and macOS (Xcode 15.3) [✓] Chrome - develop for the web [✓] Android Studio (version 2023.2) [✓] IntelliJ IDEA Ultimate Edition (version 2024.1) [✓] Connected device (4 available) [✓] Network resources • No issues found! ```
darshankawar commented 5 months ago

Thanks for the report. Seeing the same behavior as reported running on Android.

stable, master flutter doctor -v ``` [!] Flutter (Channel stable, 3.19.5, on macOS 12.2.1 21D62 darwin-x64, locale en-GB) • Flutter version 3.19.5 on channel stable at /Users/dhs/documents/fluttersdk/flutter ! Warning: `flutter` on your path resolves to /Users/dhs/Documents/Fluttersdk/flutter/bin/flutter, which is not inside your current Flutter SDK checkout at /Users/dhs/documents/fluttersdk/flutter. Consider adding /Users/dhs/documents/fluttersdk/flutter/bin to the front of your path. ! Warning: `dart` on your path resolves to /Users/dhs/Documents/Fluttersdk/flutter/bin/dart, which is not inside your current Flutter SDK checkout at /Users/dhs/documents/fluttersdk/flutter. Consider adding /Users/dhs/documents/fluttersdk/flutter/bin to the front of your path. • Upstream repository https://github.com/flutter/flutter.git • Framework revision 300451adae (4 days ago), 2024-03-27 21:54:07 -0500 • Engine revision e76c956498 • Dart version 3.3.3 • DevTools version 2.31.1 • If those were intentional, you can disregard the above warnings; however it is recommended to use "git" directly to perform update checks and upgrades. [!] Xcode - develop for iOS and macOS (Xcode 12.3) • Xcode at /Applications/Xcode.app/Contents/Developer ! Flutter recommends a minimum Xcode version of 13. Download the latest version or update via the Mac App Store. • CocoaPods version 1.11.2 [✓] Chrome - develop for the web • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome [✓] VS Code (version 1.62.0) • VS Code at /Applications/Visual Studio Code.app/Contents • Flutter extension version 3.21.0 [✓] Connected device (5 available) • SM G975F (mobile) • RZ8M802WY0X • android-arm64 • Android 11 (API 30) • Darshan's iphone (mobile) • 21150b119064aecc249dfcfe05e259197461ce23 • ios • iOS 14.4.1 18D61 • iPhone 12 Pro Max (mobile) • A5473606-0213-4FD8-BA16-553433949729 • ios • com.apple.CoreSimulator.SimRuntime.iOS-14-3 (simulator) • macOS (desktop) • macos • darwin-x64 • Mac OS X 10.15.4 19E2269 darwin-x64 • Chrome (web) • chrome • web-javascript • Google Chrome 98.0.4758.80 [✓] HTTP Host Availability • All required HTTP hosts are available ! Doctor found issues in 1 category. [!] Flutter (Channel master, 3.22.0-14.0.pre.32, on macOS 12.2.1 21D62 darwin-x64, locale en-GB) • Flutter version 3.22.0-14.0.pre.32 on channel master at /Users/dhs/documents/fluttersdk/flutter ! Warning: `flutter` on your path resolves to /Users/dhs/Documents/Fluttersdk/flutter/bin/flutter, which is not inside your current Flutter SDK checkout at /Users/dhs/documents/fluttersdk/flutter. Consider adding /Users/dhs/documents/fluttersdk/flutter/bin to the front of your path. ! Warning: `dart` on your path resolves to /Users/dhs/Documents/Fluttersdk/flutter/bin/dart, which is not inside your current Flutter SDK checkout at /Users/dhs/documents/fluttersdk/flutter. Consider adding /Users/dhs/documents/fluttersdk/flutter/bin to the front of your path. • Upstream repository https://github.com/flutter/flutter.git • Framework revision d4b42780ba (2 hours ago), 2024-04-19 00:21:25 -0400 • Engine revision b6234dd198 • Dart version 3.5.0 (build 3.5.0-76.0.dev) • DevTools version 2.35.0-dev.8 • If those were intentional, you can disregard the above warnings; however it is recommended to use "git" directly to perform update checks and upgrades. [!] Android toolchain - develop for Android devices (Android SDK version 30.0.3) • Android SDK at /Users/dhs/Library/Android/sdk ✗ cmdline-tools component is missing Run `path/to/sdkmanager --install "cmdline-tools;latest"` See https://developer.android.com/studio/command-line for more details. ✗ Android license status unknown. Run `flutter doctor --android-licenses` to accept the SDK licenses. See https://flutter.dev/docs/get-started/install/macos#android-setup for more details. [✓] Xcode - develop for iOS and macOS (Xcode 13.2.1) • Xcode at /Applications/Xcode.app/Contents/Developer • Build 13C100 • CocoaPods version 1.11.2 [✓] Chrome - develop for the web • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome [✓] IntelliJ IDEA Ultimate Edition (version 2021.3.2) • IntelliJ at /Applications/IntelliJ IDEA.app • Flutter plugin version 65.1.4 • Dart plugin version 213.7228 [✓] VS Code (version 1.62.0) • VS Code at /Applications/Visual Studio Code.app/Contents • Flutter extension version 3.29.0 [✓] Connected device (3 available) • Darshan's iphone (mobile) • 21150b119064aecc249dfcfe05e259197461ce23 • ios • iOS 15.3.1 19D52 • macOS (desktop) • macos • darwin-x64 • macOS 12.2.1 21D62 darwin-x64 • Chrome (web) • chrome • web-javascript • Google Chrome 109.0.5414.119 [✓] Network resources • All expected network resources are available. ! Doctor found issues in 1 category. [!] Xcode - develop for iOS and macOS (Xcode 12.3) • Xcode at /Applications/Xcode.app/Contents/Developer ! Flutter recommends a minimum Xcode version of 13. Download the latest version or update via the Mac App Store. • CocoaPods version 1.11.2 [✓] Chrome - develop for the web • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome [✓] VS Code (version 1.62.0) • VS Code at /Applications/Visual Studio Code.app/Contents • Flutter extension version 3.21.0 [✓] Connected device (5 available) • SM G975F (mobile) • RZ8M802WY0X • android-arm64 • Android 11 (API 30) • Darshan's iphone (mobile) • 21150b119064aecc249dfcfe05e259197461ce23 • ios • iOS 14.4.1 18D61 • iPhone 12 Pro Max (mobile) • A5473606-0213-4FD8-BA16-553433949729 • ios • com.apple.CoreSimulator.SimRuntime.iOS-14-3 (simulator) • macOS (desktop) • macos • darwin-x64 • Mac OS X 10.15.4 19E2269 darwin-x64 • Chrome (web) • chrome • web-javascript • Google Chrome 98.0.4758.80 [✓] HTTP Host Availability • All required HTTP hosts are available ! Doctor found issues in 1 category. ```