Feat: Add a11y for loading indicators by rkishan516 · Pull Request #165173 · flutter/flutter

rkishan516 · 2025-03-14T07:10:06Z

Feat: Add a11y for loading indicators
fixes: #161631

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].
I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
All existing and new tests are passing.

chunhtai · 2025-03-19T18:55:32Z

engine/src/flutter/lib/ui/semantics.dart

  static const int _kHasRequiredStateIndex = 1 << 29;
  static const int _kIsRequiredIndex = 1 << 30;
+  static const int _kIsProgressBarIndex = 1 << 31;
+  static const int _kIsLoadingSpinnerIndex = 1 << 32;


This flag can at most fit 32 bit, so this is likely not going to work for platform that uses 32 bit int.

Also we already have progress bar and loadingspinner in https://main-api.flutter.dev/flutter/dart-ui/SemanticsRole.html
you can directly use that.

However these 2 enums are currently not wired up engine, so we will need to update the engine still

actually do we need these flags in this pr? it looks like they are not used

Sure, I can remove these.

chunhtai · 2025-03-19T19:01:40Z

engine/src/flutter/lib/web_ui/lib/src/engine/semantics/progress_bar.dart

+        semanticsObject,
+        preferredLabelRepresentation: LabelRepresentation.ariaLabel,
+      ) {
+    setAriaRole('loadingSpinner');


there is no loading spiner role in web

Sure, I will remove this.

engine/src/flutter/lib/web_ui/lib/src/engine/semantics/progress_bar.dart

chunhtai · 2025-03-19T19:03:51Z

packages/flutter/lib/src/material/progress_indicator.dart

-        return _buildIndicator(context, _controller.value, textDirection);
-      },
+    return Semantics(
+      role: SemanticsRole.loadingSpinner,


this is not a spinner, right?

It is. Because if value is not given, it will be in loading mode else it will be in progreessbar mode.

chunhtai · 2025-03-19T19:04:31Z

packages/flutter/lib/src/material/progress_indicator.dart

+      enabled: widget.value != null,
+      role: SemanticsRole.progressBar,
+      child: Semantics(
+        enabled: widget.value == null,


we should probably only assign progressbar or loadingspinner but not both

At a time, it only assign one.
Because if value is not given its loadingSpinner else its progressBar.

dkwingsmt · 2025-04-02T18:29:22Z

Is this PR ready for another round of review? (from triage)

rkishan516 · 2025-04-03T01:06:57Z

Is this PR ready for another round of review? (from triage)

Yes @dkwingsmt.

chunhtai · 2025-04-03T20:57:36Z

packages/flutter/lib/src/material/progress_indicator.dart

-        }
-    }
+    return Semantics(
+      value: widget.value != null ? '${(widget.value ?? 0) * 100}%' : null,


Suggested change

value: widget.value != null ? '${(widget.value ?? 0) * 100}%' : null,

value: widget.value != null ? '${widget.value! * 100}%' : null,

also should it have the % after the number?

I have removed this.

chunhtai · 2025-04-03T21:02:33Z

engine/src/flutter/lib/web_ui/lib/src/engine/semantics/progress_bar.dart

+    setAriaRole('progressbar');
+
+    // Progress indicators in Flutter use values between 0.0 and 1.0
+    setAttribute('aria-valuemin', "0");


we may need a a new property for maxValue and minValue to propergate the value range. Hardcoded to 0 and 100 may be too opinionated

Add new properties maxValue and minValue.

rkishan516 · 2025-08-19T03:02:44Z

@chunhtai I checked the tests, but couldn't figure out issue. Can you please help me with this?

flutter-dashboard · 2025-09-09T21:48:32Z

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Piinks · 2025-09-26T22:05:23Z

Hey @rkishan516 it looks like you made some updates here, but there are some failing tests. Do you plan to continue with this change?

rkishan516 · 2025-09-27T03:36:55Z

Hey @rkishan516 it looks like you made some updates here, but there are some failing tests. Do you plan to continue with this change?

Yes, this is around the corner for landing, just few tests are failing. Will give a try over weekend.

rkishan516 · 2025-10-10T20:51:07Z

@chunhtai, @hannah-hyj can you do a last review? all tests are fixed now.

dkwingsmt · 2025-10-29T18:17:45Z

Gentle nudge @chunhtai (from triage)

chunhtai

LGTM

auto-submit · 2025-10-30T21:37:16Z

autosubmit label was removed for flutter/flutter/165173, because - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

chunhtai · 2025-10-30T22:02:07Z

the google test is a valid failure, but the actual bug is in tab widget. will have to fix it before merging this

i will put up a pr to fix the tab first, then we can merge this pr after that

Piinks · 2025-11-10T22:59:29Z

It looks like there are some merge conflicts here, but once those are sorted I think the blocking issue has been resolved here.

chingjun · 2025-11-11T19:01:13Z

Reason for revert: The PR did not finish "Google Testing", and actually caused several failures in Google

Piinks · 2025-11-11T19:04:12Z

@rkishan516 please do not manually put PRs in the queue, the autosubmit label should be used. We have to revert this for failing tests that did not complete before it was put in the queue.

rkishan516 · 2025-11-12T01:18:59Z

@rkishan516 please do not manually put PRs in the queue, the autosubmit label should be used. We have to revert this for failing tests that did not complete before it was put in the queue.

Sure, I will keep in mind.

rkishan516 force-pushed the a11y-loading-indicator branch 2 times, most recently from a4da150 to f6e5619 Compare March 15, 2025 08:09

github-actions bot added the a: tests "flutter test", flutter_test, or one of our tests label Mar 15, 2025

dkwingsmt requested a review from chunhtai March 19, 2025 18:30

chunhtai reviewed Mar 19, 2025

View reviewed changes

rkishan516 force-pushed the a11y-loading-indicator branch from f6e5619 to 0034f92 Compare March 20, 2025 03:27

github-actions bot removed the a: tests "flutter test", flutter_test, or one of our tests label Mar 20, 2025

chunhtai self-requested a review April 2, 2025 18:33

rkishan516 force-pushed the a11y-loading-indicator branch from 0034f92 to b7a864f Compare April 3, 2025 01:06

chunhtai reviewed Apr 3, 2025

View reviewed changes

rkishan516 force-pushed the a11y-loading-indicator branch from b7a864f to 3f35fa6 Compare April 4, 2025 01:30

github-actions bot added a: tests "flutter test", flutter_test, or one of our tests platform-windows Building on or for Windows specifically a: desktop Running on desktop labels Apr 4, 2025

rkishan516 force-pushed the a11y-loading-indicator branch 6 times, most recently from d61aae5 to 050ace5 Compare April 5, 2025 01:42

rkishan516 force-pushed the a11y-loading-indicator branch from 050ace5 to cf1d583 Compare April 22, 2025 13:14

chunhtai self-requested a review April 22, 2025 16:54

rkishan516 force-pushed the a11y-loading-indicator branch from cf1d583 to 99965e8 Compare April 23, 2025 01:09

rkishan516 force-pushed the a11y-loading-indicator branch 2 times, most recently from c0881c1 to 4661a35 Compare August 18, 2025 01:57

chunhtai approved these changes Oct 30, 2025

View reviewed changes

chunhtai mentioned this pull request Oct 30, 2025

Fixes tab to allow child to have semantics role #177809

Merged

9 tasks

Feat: Add a11y for loading indicators

48e2af0

auto-submit bot mentioned this pull request Nov 11, 2025

Reverts "Feat: Add a11y for loading indicators (#165173)" #178316

Merged

9 tasks

chunhtai mentioned this pull request Nov 12, 2025

Relands "Feat: Add a11y for loading indicators (#165173)" #178402

Merged

9 tasks

	value: widget.value != null ? '${(widget.value ?? 0) * 100}%' : null,
	value: widget.value != null ? '${widget.value! * 100}%' : null,

Conversation

rkishan516 commented Mar 14, 2025

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dkwingsmt commented Apr 2, 2025

Uh oh!

rkishan516 commented Apr 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rkishan516 commented Aug 19, 2025

Uh oh!

flutter-dashboard bot commented Sep 9, 2025

Uh oh!

Piinks commented Sep 26, 2025

Uh oh!

rkishan516 commented Sep 27, 2025

Uh oh!

rkishan516 commented Oct 10, 2025

Uh oh!

dkwingsmt commented Oct 29, 2025

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Oct 30, 2025

Uh oh!

chunhtai commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Piinks commented Nov 10, 2025

Uh oh!

chingjun commented Nov 11, 2025

Uh oh!

Piinks commented Nov 11, 2025

Uh oh!

rkishan516 commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

chunhtai commented Oct 30, 2025 •

edited

Loading