Add support for setting the heading level for web semantics (#97894) #41435

victorgalo · 2023-04-23T16:22:09Z

This change adds a new property in Semantics widget that would take an integer value corresponding to the heading levels defined by the ARIA heading role. This is necessary in order to get proper accessibility and usability in a website for users who rely on screen readers and other assistive technologies.

Issue fixed by this PR:
flutter/flutter#97894

Framework part:
flutter/flutter#125771

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] and the [C++, Objective-C, Java style guides].
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See [testing the engine] for instructions on writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the [CLA].
All existing and new tests are passing.

victorgalo · 2023-04-30T18:44:27Z

The build is failing because some integration tests are failing in the framework side, I need to integrate both changes together (framework and engine part) for integration tests to pass. Please, someone can tell me how I should deal with this?.

Maybe @yjbanov can shed some light?

flutter-dashboard · 2023-05-20T18:47:25Z

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.

yjbanov · 2023-06-26T23:13:30Z

It's a tough one. We might have to temporarily disable the test, wait for the engine change to roll, then enable it again.

yjbanov · 2023-06-26T23:14:55Z

Would you be willing to wait for #43159 to land before landing this PR? Currently LabelAndValue is broken in that it steals the ARIA role attribute from more specific roles. After I land that, we can introduce a secondary RoleManager that would manage aria-level without touching the role attribute.

yjbanov · 2023-06-27T20:57:51Z

Update: #43159 has landed.

yjbanov · 2023-06-27T21:02:31Z

Here's what I'd recommend doing given the framework established in #43159.

We create a new class Heading extends RoleManager. This role manager is responsible for the aria-level attribute.
PrimaryRoleManager.withBasics constructor adds the Heading role manager if applicable. The Heading role is applicable if headingLevel != -1.

Alternatively, we can give the task of setting aria-level to LabelAndValue. I'm not sure if the two are orthogonal to each other 🤔

Let's keep LabelAndValue as is. In a separate PR we can fix the "header" vs "heading" vs "banner" situation.

odrya12 · 2023-07-26T10:49:21Z

hi there is any progress with the last checks?

victorgalo · 2023-09-03T23:30:57Z

Here's what I'd recommend doing given the framework established in #43159.

We create a new class Heading extends RoleManager. This role manager is responsible for the aria-level attribute.

PrimaryRoleManager.withBasics constructor adds the Heading role manager if applicable. The Heading role is applicable if headingLevel != -1.

Alternatively, we can give the task of setting aria-level to LabelAndValue. I'm not sure if the two are orthogonal to each other 🤔

Let's keep LabelAndValue as is. In a separate PR we can fix the "header" vs "heading" vs "banner" situation.

Nice ideas!, thank you very much. I will create a Heading class extending RoleManager as you proposed. Sorry for my late response, I will try to implement it during this week.

# Conflicts: # lib/ui/semantics.dart # lib/web_ui/lib/src/engine/semantics/label_and_value.dart # lib/web_ui/lib/src/engine/semantics/semantics.dart

lib/ui/semantics.dart

lib/web_ui/lib/semantics.dart

lib/web_ui/lib/src/engine/semantics/heading.dart

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

yjbanov · 2023-09-18T21:56:19Z

lib/web_ui/test/engine/semantics/semantics_test.dart

+      label: 'Header of the page',
+      transform: Matrix4.identity().toFloat64(),
+      rect: const ui.Rect.fromLTRB(0, 0, 100, 50),
+    );


Let's also test that we can update it and clear aria-level when it's gone (assuming having the heading role without aria-level is a meaningful state).

Hey @yjbanov, I'd say i's not a meaningful state, aria-level is required for "heading" role. Do you think I still should add it?.

Nope, if it's not an expected state, we don't need to test it.

chunhtai · 2024-05-14T22:08:48Z

Hi @victorgalo can you fix the ci so that we can merge this pr?

auto-submit · 2024-05-16T20:23:12Z

auto label is removed for flutter/engine/41435, due to - The status or check suite Linux linux_web_engine has failed. Please fix the issues identified (or deflake) before re-applying this label.

chunhtai · 2024-05-16T20:52:15Z

Hi @victorgalo there is some analyzer warning

Analyzing web_ui...

info - lib/src/engine/semantics/semantics.dart:1659:27 - This case is covered by the previous cases. Try removing the case clause, or restructuring the preceding patterns. - unreachable_switch_case

1 issue found.

Since this have been open for a while, I can also take over if you want. let me know how you want to proceed

auto-submit · 2024-05-17T22:53:08Z

auto label is removed for flutter/engine/41435, due to - The status or check suite Linux Web Framework tests has failed. Please fix the issues identified (or deflake) before re-applying this label.

victorgalo · 2024-05-18T09:27:05Z

Hi @victorgalo there is some analyzer warning

Analyzing web_ui...

info - lib/src/engine/semantics/semantics.dart:1659:27 - This case is covered by the previous cases. Try removing the case clause, or restructuring the preceding patterns. - unreachable_switch_case

1 issue found.

Since this have been open for a while, I can also take over if you want. let me know how you want to proceed

Hi @chunhtai. Oh right, sorry I missed that warning after the rebase I did. Now it's fixed and I'm at the point where I was stuck, can you please help me understand why it's failing now?, I'd rather finish it myself but may need some guidance on this last step if you don't mind, sorry for the trouble!

Thank you!

kevmoo · 2024-05-22T20:42:37Z

Are we getting close here? I'd LOVE to get this landed.

auto-submit · 2024-05-28T17:09:47Z

auto label is removed for flutter/engine/41435, due to - The status or check suite Linux Web Framework tests has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2024-05-28T22:39:18Z

auto label is removed for flutter/engine/41435, due to - The status or check suite Linux Web Framework tests has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2024-05-29T17:10:20Z

auto label is removed for flutter/engine/41435, due to - The status or check suite Linux Web Framework tests has failed. Please fix the issues identified (or deflake) before re-applying this label.

chunhtai · 2024-05-30T16:37:30Z

Hi @victorgalo
looks like the parameter can't be required until we migrate framework

le:///b/s/w/ir/x/w/recipe_cleanup/builder/src/out/wasm_release/flutter_web_sdk/kernel/ddc_outline_sound.dill --verbosity=error --sound-null-safety
[  +13 ms] <- compile org-dartlang-app:///main.dart
[+7088 ms] lib/src/semantics/semantics.dart:2782:23: Error: Required named parameter 'headingLevel' must be provided.
[   +1 ms]     builder.updateNode(
[        ]                       ^
[+20417 ms] "flutter test" took 34,678ms.
[   +4 ms] Failed to compile
[        ] 
           #0      throwToolExit (package:flutter_tools/src/base/common.dart:10:3)
           #1      WebTestCompiler._compileJS (package:flutter_tools/src/test/web_test_compiler.dart:194:7)
           <asynchronous suspension>
           #2      _FlutterTestRunnerImpl.runTests (package:flutter_tools/src/test/runner.dart:176:34)
           <asynchronous suspension>
           #3      TestCommand.runCommand (package:flutter_tools/src/commands/test.dart:585:16)
           <asynchronous suspension>
           #4      FlutterCommand.run.<anonymous closure> (package:flutter_tools/src/runner/flutter_command.dart:1396:27)
           <asynchronous suspension>
           #5      AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:153:19)
           <asynchronous suspension>
           #6      CommandRunner.runCommand (package:args/command_runner.dart:212:13)
           <asynchronous suspension>
           #7      FlutterCommandRunner.runCommand.<anonymous closure> (package:flutter_tools/src/runner/flutter_command_runner.dart:372:9)
           <asynchronous suspension>
           #8      AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:153:19)
           <asynchronous suspension>
           #9      FlutterCommandRunner.runCommand (package:flutter_tools/src/runner/flutter_command_runner.dart:308:5)
           <asynchronous suspension>
           #10     run.<anonymous closure>.<anonymous closure> (package:flutter_tools/runner.dart:130:9)
           <asynchronous suspension>
           #11     AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:153:19)
           <asynchronous suspension>
           #12     main (package:flutter_tools/executable.dart:93:3)
           <asynchronous suspension>

can you update the code?

chunhtai

The ci failure is bury deep in the code, It took me a while to understand it is not a flaky infra. Sorry for the delay

chunhtai · 2024-05-30T16:38:11Z

lib/ui/semantics.dart

@@ -823,6 +835,7 @@ abstract class SemanticsUpdateBuilder {
    required Int32List childrenInTraversalOrder,
    required Int32List childrenInHitTestOrder,
    required Int32List additionalActions,
+    required int headingLevel,


let's make this not required and give it a default value of 0

chunhtai · 2024-05-30T16:38:26Z

lib/ui/semantics.dart

@@ -893,8 +906,13 @@ base class _NativeSemanticsUpdateBuilder extends NativeFieldWrapperClass1 implem
    required Int32List childrenInTraversalOrder,
    required Int32List childrenInHitTestOrder,
    required Int32List additionalActions,
+    required int headingLevel,


chunhtai · 2024-05-30T16:38:55Z

lib/web_ui/lib/semantics.dart

@@ -283,6 +283,7 @@ class SemanticsUpdateBuilder {
    required Int32List childrenInTraversalOrder,
    required Int32List childrenInHitTestOrder,
    required Int32List additionalActions,
+    required int headingLevel,


Add support for setting the heading level for web semantics (#97894)

a341b26

flutter-dashboard bot added embedder Related to the embedder API platform-web Code specifically for the web engine labels Apr 23, 2023

victorgalo added 4 commits April 24, 2023 19:25

Add support for setting the heading level for web semantics (#97894)

eff0206

Merge branch 'main' into add-semantics-heading-level

7f8ef2c

Add support for setting the heading level for web semantics (#97894)

9029d63

Add support for setting the heading level for web semantics (#97894)

260d4bd

victorgalo mentioned this pull request Apr 30, 2023

Add support for setting the heading level for web semantics (#97894) flutter/flutter#125771

Open

8 tasks

Merge branch 'main' into add-semantics-heading-level

baea4c1

victorgalo marked this pull request as ready for review April 30, 2023 18:44

victorgalo added 3 commits September 9, 2023 16:25

Merge branch 'main' into add-semantics-heading-level

bf0fe7f

# Conflicts: # lib/ui/semantics.dart # lib/web_ui/lib/src/engine/semantics/label_and_value.dart # lib/web_ui/lib/src/engine/semantics/semantics.dart

Merge branch 'main' into add-semantics-heading-level

b773f81

Remove trailing spaces

90de9fc

github-actions bot removed the embedder Related to the embedder API label Sep 9, 2023

victorgalo added 4 commits September 10, 2023 00:38

Merge branch 'main' into add-semantics-heading-level

c9ac350

Add export for new Heading role

c8ccd31

Fix references for new Heading role

0241f07

Remove unused import

6298a5f

yjbanov reviewed Sep 18, 2023

View reviewed changes

victorgalo added 2 commits September 20, 2023 01:15

Fix PR comments (41435)

36c5fd6

Remove trailing whitespace

30153e0

victorgalo mentioned this pull request Sep 19, 2023

Skip test temporarily until headingLevel is added in engine (issue 41… flutter/flutter#135077

Merged

8 tasks

victorgalo mentioned this pull request May 12, 2024

Add support for setting the heading level for web semantics (#97894) flutter/flutter#148195

Draft

8 tasks

Merge branch 'main' into add-semantics-heading-level

2586dbc

Merge branch 'main' into add-semantics-heading-level

fc0a3a5

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label May 16, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 16, 2024

victorgalo added 2 commits May 17, 2024 20:21

Remove duplicated case in switch statement

ca2d289

Merge branch 'main' into add-semantics-heading-level

5e05f24

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label May 17, 2024

Merge branch 'main' into add-semantics-heading-level

9231840

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 17, 2024

victorgalo added 2 commits May 18, 2024 01:45

Merge branch 'main' into add-semantics-heading-level

c52b545

Merge branch 'main' into add-semantics-heading-level

33a246c

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label May 28, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 28, 2024

goderbauer added the autosubmit Merge PR when tree becomes green via auto submit App label May 28, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 28, 2024

Merge branch 'main' into add-semantics-heading-level

1b0e241

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label May 29, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 29, 2024

chunhtai reviewed May 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for setting the heading level for web semantics (#97894) #41435

Add support for setting the heading level for web semantics (#97894) #41435

victorgalo commented Apr 23, 2023 •

edited

victorgalo commented Apr 30, 2023

flutter-dashboard bot commented May 20, 2023

yjbanov commented Jun 26, 2023

yjbanov commented Jun 26, 2023 •

edited

yjbanov commented Jun 27, 2023

yjbanov commented Jun 27, 2023

odrya12 commented Jul 26, 2023

victorgalo commented Sep 3, 2023

yjbanov Sep 18, 2023

victorgalo Sep 22, 2023

yjbanov Nov 27, 2023

chunhtai commented May 14, 2024

auto-submit bot commented May 16, 2024

chunhtai commented May 16, 2024

auto-submit bot commented May 17, 2024

victorgalo commented May 18, 2024

kevmoo commented May 22, 2024

auto-submit bot commented May 28, 2024

auto-submit bot commented May 28, 2024

auto-submit bot commented May 29, 2024

chunhtai commented May 30, 2024 •

edited

chunhtai left a comment

chunhtai May 30, 2024

chunhtai May 30, 2024

chunhtai May 30, 2024

Add support for setting the heading level for web semantics (#97894) #41435

Are you sure you want to change the base?

Add support for setting the heading level for web semantics (#97894) #41435

Conversation

victorgalo commented Apr 23, 2023 • edited

Pre-launch Checklist

victorgalo commented Apr 30, 2023

flutter-dashboard bot commented May 20, 2023

yjbanov commented Jun 26, 2023

yjbanov commented Jun 26, 2023 • edited

yjbanov commented Jun 27, 2023

yjbanov commented Jun 27, 2023

odrya12 commented Jul 26, 2023

victorgalo commented Sep 3, 2023

yjbanov Sep 18, 2023

Choose a reason for hiding this comment

victorgalo Sep 22, 2023

Choose a reason for hiding this comment

yjbanov Nov 27, 2023

Choose a reason for hiding this comment

chunhtai commented May 14, 2024

auto-submit bot commented May 16, 2024

chunhtai commented May 16, 2024

auto-submit bot commented May 17, 2024

victorgalo commented May 18, 2024

kevmoo commented May 22, 2024

auto-submit bot commented May 28, 2024

auto-submit bot commented May 28, 2024

auto-submit bot commented May 29, 2024

chunhtai commented May 30, 2024 • edited

chunhtai left a comment

Choose a reason for hiding this comment

chunhtai May 30, 2024

Choose a reason for hiding this comment

chunhtai May 30, 2024

Choose a reason for hiding this comment

chunhtai May 30, 2024

Choose a reason for hiding this comment

victorgalo commented Apr 23, 2023 •

edited

yjbanov commented Jun 26, 2023 •

edited

chunhtai commented May 30, 2024 •

edited