Add optional flag to determine assertiveness level in aria announcement for flutter web #107568

nbayati · 2022-07-13T18:04:51Z

Add an optional flag to Flutter's accessibility announcer service to support two different modes of aria announcements in flutter web. Developers can make the announcement assertive or polite using this flag. The change on the web engine side is tracked here: flutter/engine#34640

Fixes #104109

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…nts for flutter web

packages/flutter/lib/src/semantics/semantics_event.dart

packages/flutter/lib/src/semantics/semantics_service.dart

packages/flutter/lib/src/semantics/semantics_event.dart

packages/flutter/lib/src/semantics/semantics_service.dart

packages/flutter/lib/src/semantics/semantics_event.dart

packages/flutter/test/semantics/semantics_service_test.dart

…ocumentation

…tter web

packages/flutter/lib/src/semantics/semantics_event.dart

packages/flutter/lib/src/semantics/semantics_service.dart

goderbauer · 2022-07-21T16:48:02Z

packages/flutter/lib/src/semantics/semantics_service.dart

-    final AnnounceSemanticsEvent event = AnnounceSemanticsEvent(message, textDirection);
+  ///
+  /// The assertiveness level of the announcement can be determined by setting [assertivenessSetting].
+  /// Currently, this is only supported by the web engine and has no effect on other platforms.


What do you get on other platforms? Always assertive? Always polite? Is it platform dependent?

According to @chunhtai's comment above:

Android does not have such setting, it will always interrupt. iOS has two different politeness, always gets interrupted or queue after current announcement.

yjbanov

packages/flutter/lib/src/semantics/semantics_event.dart

packages/flutter/lib/src/semantics/semantics_service.dart

yjbanov · 2022-07-22T19:44:49Z

packages/flutter/lib/src/semantics/semantics_service.dart

-  static Future<void> announce(String message, TextDirection textDirection) async {
-    final AnnounceSemanticsEvent event = AnnounceSemanticsEvent(message, textDirection);
+  ///
+  /// The assertiveness level of the announcement can be determined by [assertiveness].


nit: I'd replace "can be" with "is"

This paragraph does not add any more information other than the parameter name.

Maybe mention why developer would want to use this parameter? maybe give an example situation and which enum value you can use?

goderbauer

LGTM

packages/flutter/lib/src/semantics/semantics_event.dart

packages/flutter/lib/src/semantics/semantics_service.dart

chunhtai

LGTM, left some minor comments on doc string

chunhtai · 2022-07-22T21:42:13Z

packages/flutter/lib/src/semantics/semantics_event.dart

+  /// Determines whether the announcement should interrupt any existing announcement,
+  /// or queue after it.
+  ///
+  /// On the web this option uses the aria-live level to set the assertiveness


I will probably remove anything related to aria-live in the doc string. It is an implementation detail and will probably confuse reader

chunhtai · 2022-07-22T21:46:33Z

packages/flutter/lib/src/semantics/semantics_service.dart

-  static Future<void> announce(String message, TextDirection textDirection) async {
-    final AnnounceSemanticsEvent event = AnnounceSemanticsEvent(message, textDirection);
+  ///
+  /// The assertiveness level of the announcement can be determined by [assertiveness].


This paragraph does not add any more information other than the parameter name.

Maybe mention why developer would want to use this parameter? maybe give an example situation and which enum value you can use?

…nouncement for flutter web (flutter/flutter#107568)

…nt for flutter web (flutter#107568)

Add optional flag to determine assertiveness level in aria announceme…

af1119d

…nts for flutter web

nbayati requested a review from yjbanov July 13, 2022 18:04

flutter-dashboard bot added a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) framework flutter/packages/flutter repository. See also f: labels. labels Jul 13, 2022

goderbauer reviewed Jul 13, 2022

View reviewed changes

nbayati added 4 commits July 15, 2022 15:52

Merge branch 'main' into aria-assertive

d20539a

Merge branch 'main' into aria-assertive

364f8a1

Merge branch 'main' into aria-assertive

11621dc

Change aria politeness setting from a boolean to an enum

40dc853

nbayati requested a review from goderbauer July 19, 2022 21:37

yjbanov reviewed Jul 20, 2022

View reviewed changes

packages/flutter/test/semantics/semantics_service_test.dart Outdated Show resolved Hide resolved

nbayati added 3 commits July 20, 2022 15:38

Merge branch 'main' into aria-assertive

f8ee22f

change politeness setting to a named optional parameter and improve d…

e0d7254

…ocumentation

Specify in documentation that this is currently only supported on flu…

b9f9b90

…tter web

nbayati requested review from chunhtai and yjbanov July 21, 2022 02:08

goderbauer reviewed Jul 21, 2022

View reviewed changes

nbayati requested a review from goderbauer July 21, 2022 17:44

nbayati added 2 commits July 21, 2022 16:52

Merge branch 'main' into aria-assertive

3a4ae30

change default assertive setting to

4fd00fb

yjbanov approved these changes Jul 22, 2022

View reviewed changes

goderbauer approved these changes Jul 22, 2022

View reviewed changes

packages/flutter/lib/src/semantics/semantics_event.dart Outdated Show resolved Hide resolved

packages/flutter/lib/src/semantics/semantics_service.dart Outdated Show resolved Hide resolved

chunhtai approved these changes Jul 22, 2022

View reviewed changes

nbayati added 2 commits July 22, 2022 16:29

Merge branch 'main' into aria-assertive

5ab256d

make assertiveness an optional named parameter

c8b474f

nbayati added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 23, 2022

auto-submit bot merged commit 74ea713 into flutter:master Jul 23, 2022

engine-flutter-autoroll mentioned this pull request Jul 23, 2022

Roll Flutter from 096bbbe2fcbf to fa42451a2596 (19 revisions) flutter/plugins#6136

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Jul 23, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

0d2ee7b

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to 2142b2ecff0e (175 revisions) flutter/packages#2371

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

0b7d04a

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to 178e4447305b (176 revisions) flutter/packages#2372

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

b2f611c

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to 8a7b35933c5d (177 revisions) flutter/packages#2373

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

02635f9

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to b3f5d3f854b7 (178 revisions) flutter/packages#2374

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

204cfe7

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to 2f4299ad354d (179 revisions) flutter/packages#2375

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

40b7ded

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to e74b9b5bef46 (180 revisions) flutter/packages#2376

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

c937ef0

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to e3b851a63413 (181 revisions) flutter/packages#2378

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

cd75af3

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 25, 2022

Roll Flutter from bbec650b64bc to 43d6e2b11385 (182 revisions) flutter/packages#2379

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 25, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

1145c1f

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 26, 2022

Roll Flutter from bbec650b64bc to e3d08fb6d325 (197 revisions) flutter/packages#2383

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

9998e80

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 26, 2022

Roll Flutter from bbec650b64bc to 2f551d30086a (198 revisions) flutter/packages#2384

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

22ec1ce

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll mentioned this pull request Jul 26, 2022

Roll Flutter from bbec650b64bc to 527ee1d7286e (199 revisions) flutter/packages#2387

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

46907c3

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

2472e7d

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

b8900af

…nouncement for flutter web (flutter/flutter#107568)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2022

74ea713 Add optional flag to determine assertiveness level in aria an…

e9b21b8

…nouncement for flutter web (flutter/flutter#107568)

This was referenced Jul 26, 2022

Modify dataMap to include assertiveness only if it's not set to polite #108396

Merged

Provide a testing API for the announce functionality #108495

Closed

camsim99 pushed a commit to camsim99/flutter that referenced this pull request Aug 10, 2022

Add optional flag to determine assertiveness level in aria announceme…

a45a94e

…nt for flutter web (flutter#107568)

nbayati mentioned this pull request Aug 20, 2022

Provide test API for accessibility announcements #109661

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add optional flag to determine assertiveness level in aria announcement for flutter web #107568

Add optional flag to determine assertiveness level in aria announcement for flutter web #107568

nbayati commented Jul 13, 2022

goderbauer Jul 21, 2022

nbayati Jul 21, 2022

yjbanov left a comment

yjbanov Jul 22, 2022

chunhtai Jul 22, 2022

goderbauer left a comment

chunhtai left a comment

chunhtai Jul 22, 2022

chunhtai Jul 22, 2022

Add optional flag to determine assertiveness level in aria announcement for flutter web #107568

Add optional flag to determine assertiveness level in aria announcement for flutter web #107568

Conversation

nbayati commented Jul 13, 2022

Pre-launch Checklist

goderbauer Jul 21, 2022

Choose a reason for hiding this comment

nbayati Jul 21, 2022

Choose a reason for hiding this comment

yjbanov left a comment

Choose a reason for hiding this comment

yjbanov Jul 22, 2022

Choose a reason for hiding this comment

chunhtai Jul 22, 2022

Choose a reason for hiding this comment

goderbauer left a comment

Choose a reason for hiding this comment

chunhtai left a comment

Choose a reason for hiding this comment

chunhtai Jul 22, 2022

Choose a reason for hiding this comment

chunhtai Jul 22, 2022

Choose a reason for hiding this comment