-
Notifications
You must be signed in to change notification settings - Fork 28.6k
[a11y] add SemanticsValidationResult #165935
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the approach looks fine for the form widget. We have been relying on implicit merging to supplement semantics in container widget like this.
/// If [validationResult] is null, removes the `aria-invalid` attribute from | ||
/// the element. | ||
static void updateAriaInvalid(DomElement element, ui.SemanticsValidationResult validationResult) { | ||
if (validationResult != ui.SemanticsValidationResult.none) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should use switch case in case someone add a different enum in other platform without knowing how it is used here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. I inlined the switch from toAriaValue
here. That was a bit of an overarchitecture.
/// the element. | ||
static void updateAriaInvalid(DomElement element, ui.SemanticsValidationResult validationResult) { | ||
if (validationResult != ui.SemanticsValidationResult.none) { | ||
element.setAttribute('aria-invalid', validationResult.toAriaValue()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
isn't the aria-invalid a boolean value?
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-invalid
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See the "Values" section: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-invalid#values
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah, I should scroll it down further. thanks
// reversed. | ||
return 'true'; | ||
case ui.SemanticsValidationResult.grammar: | ||
return 'grammar'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does aria-invalid='grammar' actually work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It works in the sense that the screen reader still reads "invalid entry", but as of today all screen readers I tested on the result is no different from just doing aria-invalid="true"
.
@@ -3057,3 +3107,30 @@ enum EnabledState { | |||
/// The node is disabled. | |||
disabled, | |||
} | |||
|
|||
extension SemanticsValidationResultExtension on ui.SemanticsValidationResult { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why does this use an extension instead of directly in the enum class?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The enum class is public. We don't want web-specific details to be published through dart:ui
types. However, this is gone now. Originally, I had toAriaValue
used in multiple places, but then collapsed it to one, so I don't need it to be a shared function anymore.
@@ -3076,6 +3128,10 @@ class SemanticsNode with DiagnosticableTreeMixin { | |||
Set<String>? get controlsNodes => _controlsNodes; | |||
Set<String>? _controlsNodes = _kEmptyConfig.controlsNodes; | |||
|
|||
/// {@macro flutter.semantics.SemanticsProperties.validationResult} | |||
SemanticsValidationResult get validationResult => _validationResult; | |||
SemanticsValidationResult _validationResult = SemanticsValidationResult.none; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
_kEmptyConfig.validationResult is safer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
@@ -5778,6 +5857,11 @@ class SemanticsConfiguration { | |||
_controlsNodes = <String>{..._controlsNodes!, ...child._controlsNodes!}; | |||
} | |||
|
|||
if (_validationResult == SemanticsValidationResult.none && | |||
child._validationResult != _validationResult) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we do some kind of prioritize invalid similar to the getSemanticsData
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not even sure screen readers would support nested validation results. So maybe we should assert and throw if conflicting validation results are being merged?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
probably shouldn't throw. we can either generate separate node or have some merging strategy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Merged with invalid taking precedence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just some questions
// 'false' may seem counter-intuitive for a "valid" result, but it's | ||
// because the ARIA attribute is `aria-invalid`, so its value is | ||
// reversed. | ||
element.setAttribute('aria-invalid', 'false'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will there be a different between aria-invalid="false" vs not providing aria-invalid at all?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't not see a difference in the screen reader behavior.
Roll Flutter from a0b1b3253416 to 02f13c37841f (37 revisions) flutter/flutter@a0b1b32...02f13c3 2025-04-03 [email protected] Roll Packages from 07496eb to 4a36dc6 (3 revisions) (flutter/flutter#166542) 2025-04-03 [email protected] Roll Skia from b67e53719e78 to 5f65df75febd (2 revisions) (flutter/flutter#166538) 2025-04-03 [email protected] Update docs to debug the Android embedder (flutter/flutter#166170) 2025-04-03 [email protected] Roll Dart SDK from 72562ca93bb5 to d174ec16c3ea (1 revision) (flutter/flutter#166525) 2025-04-03 [email protected] [macOS] Implement merged UI and platform thread (flutter/flutter#162883) 2025-04-03 [email protected] Roll Skia from f91412f5d89d to b67e53719e78 (1 revision) (flutter/flutter#166527) 2025-04-03 [email protected] Roll Packages from 125c117 to 07496eb (31 revisions) (flutter/flutter#166457) 2025-04-03 [email protected] Roll Skia from 2be12bc2668b to f91412f5d89d (2 revisions) (flutter/flutter#166517) 2025-04-03 [email protected] Roll Dart SDK from 2a1a13cc3a91 to 72562ca93bb5 (2 revisions) (flutter/flutter#166514) 2025-04-03 [email protected] [native_assets] Roll dependencies (flutter/flutter#166282) 2025-04-03 [email protected] Fix read only TextField focus traversal on macOS (flutter/flutter#166056) 2025-04-03 [email protected] Roll Skia from c106d7831592 to 2be12bc2668b (1 revision) (flutter/flutter#166509) 2025-04-03 [email protected] Roll Fuchsia Linux SDK from v7PGvypiiWLO8PbsZ... to vYisSsIgqw0mqFRVJ... (flutter/flutter#166508) 2025-04-03 [email protected] Roll Dart SDK from b8b4076b1237 to 2a1a13cc3a91 (1 revision) (flutter/flutter#166504) 2025-04-03 [email protected] Roll Skia from 75a0ec473181 to c106d7831592 (1 revision) (flutter/flutter#166499) 2025-04-03 [email protected] Migrate to Theme.brightnessOf method (flutter/flutter#163950) 2025-04-03 [email protected] Fix: Range slider show overlay for both thumbs on hovering one (flutter/flutter#165393) 2025-04-03 [email protected] Deprecate ExpansionTileController (flutter/flutter#166368) 2025-04-03 [email protected] Add styling parameters in `PopupMenuDivider` (flutter/flutter#164790) 2025-04-03 [email protected] Fix ISSUE_TEMPLATE Ordering: `10 < 9`, but `10 > 09` (flutter/flutter#166455) 2025-04-03 [email protected] Skip flaking scheduler test (flutter/flutter#166471) 2025-04-02 [email protected] Roll pub packages (flutter/flutter#166043) 2025-04-02 [email protected] [a11y] add SemanticsValidationResult (flutter/flutter#165935) 2025-04-02 [email protected] Remove unnecessary cache busting mechanism in hot restart (flutter/flutter#166295) 2025-04-02 [email protected] Roll Skia from 52cbb917fffd to 75a0ec473181 (21 revisions) (flutter/flutter#166484) 2025-04-02 [email protected] Started pixel aligning hairlines (flutter/flutter#166351) 2025-04-02 [email protected] Adds semantics role and adjust semantics for navigation bar (flutter/flutter#162467) 2025-04-02 [email protected] Reland "[skwasm] Dynamic Threading" (flutter/flutter#166454) 2025-04-02 [email protected] [dart:ui] Add `Path.addRSuperellipse` (flutter/flutter#166045) 2025-04-02 [email protected] Fix: Hero animation for page transition (flutter/flutter#164469) 2025-04-02 [email protected] Fix: DelegateTransition for cupertino sheet route (flutter/flutter#164675) 2025-04-02 [email protected] Roll Fuchsia Test Scripts from AEdsljKmUiPk92Wvv... to FZdRtNwH7jmADecj6... (flutter/flutter#166383) 2025-04-02 [email protected] [Impeller] cache for text shadows. (flutter/flutter#166228) 2025-04-02 [email protected] Convert `AppPluginLoaderPlugin` to Kotlin, and add `NativePluginLoaderReflectionBridge` to expose it in Kotlin (flutter/flutter#166027) 2025-04-02 [email protected] Roll Dart SDK from 4e1f02bc704f to b8b4076b1237 (7 revisions) (flutter/flutter#166474) 2025-04-02 [email protected] Update Roadmap (flutter/flutter#166332) 2025-04-02 [email protected] Update `CODEOWNERS` (flutter/flutter#166444) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose ...
Roll Flutter from a0b1b3253416 to 02f13c37841f (37 revisions) flutter/flutter@a0b1b32...02f13c3 2025-04-03 [email protected] Roll Packages from d10d5af to 95f8e65 (3 revisions) (flutter/flutter#166542) 2025-04-03 [email protected] Roll Skia from b67e53719e78 to 5f65df75febd (2 revisions) (flutter/flutter#166538) 2025-04-03 [email protected] Update docs to debug the Android embedder (flutter/flutter#166170) 2025-04-03 [email protected] Roll Dart SDK from 72562ca93bb5 to d174ec16c3ea (1 revision) (flutter/flutter#166525) 2025-04-03 [email protected] [macOS] Implement merged UI and platform thread (flutter/flutter#162883) 2025-04-03 [email protected] Roll Skia from f91412f5d89d to b67e53719e78 (1 revision) (flutter/flutter#166527) 2025-04-03 [email protected] Roll Packages from 0d5d57b to d10d5af (31 revisions) (flutter/flutter#166457) 2025-04-03 [email protected] Roll Skia from 2be12bc2668b to f91412f5d89d (2 revisions) (flutter/flutter#166517) 2025-04-03 [email protected] Roll Dart SDK from 2a1a13cc3a91 to 72562ca93bb5 (2 revisions) (flutter/flutter#166514) 2025-04-03 [email protected] [native_assets] Roll dependencies (flutter/flutter#166282) 2025-04-03 [email protected] Fix read only TextField focus traversal on macOS (flutter/flutter#166056) 2025-04-03 [email protected] Roll Skia from c106d7831592 to 2be12bc2668b (1 revision) (flutter/flutter#166509) 2025-04-03 [email protected] Roll Fuchsia Linux SDK from v7PGvypiiWLO8PbsZ... to vYisSsIgqw0mqFRVJ... (flutter/flutter#166508) 2025-04-03 [email protected] Roll Dart SDK from b8b4076b1237 to 2a1a13cc3a91 (1 revision) (flutter/flutter#166504) 2025-04-03 [email protected] Roll Skia from 75a0ec473181 to c106d7831592 (1 revision) (flutter/flutter#166499) 2025-04-03 [email protected] Migrate to Theme.brightnessOf method (flutter/flutter#163950) 2025-04-03 [email protected] Fix: Range slider show overlay for both thumbs on hovering one (flutter/flutter#165393) 2025-04-03 [email protected] Deprecate ExpansionTileController (flutter/flutter#166368) 2025-04-03 [email protected] Add styling parameters in `PopupMenuDivider` (flutter/flutter#164790) 2025-04-03 [email protected] Fix ISSUE_TEMPLATE Ordering: `10 < 9`, but `10 > 09` (flutter/flutter#166455) 2025-04-03 [email protected] Skip flaking scheduler test (flutter/flutter#166471) 2025-04-02 [email protected] Roll pub packages (flutter/flutter#166043) 2025-04-02 [email protected] [a11y] add SemanticsValidationResult (flutter/flutter#165935) 2025-04-02 [email protected] Remove unnecessary cache busting mechanism in hot restart (flutter/flutter#166295) 2025-04-02 [email protected] Roll Skia from 52cbb917fffd to 75a0ec473181 (21 revisions) (flutter/flutter#166484) 2025-04-02 [email protected] Started pixel aligning hairlines (flutter/flutter#166351) 2025-04-02 [email protected] Adds semantics role and adjust semantics for navigation bar (flutter/flutter#162467) 2025-04-02 [email protected] Reland "[skwasm] Dynamic Threading" (flutter/flutter#166454) 2025-04-02 [email protected] [dart:ui] Add `Path.addRSuperellipse` (flutter/flutter#166045) 2025-04-02 [email protected] Fix: Hero animation for page transition (flutter/flutter#164469) 2025-04-02 [email protected] Fix: DelegateTransition for cupertino sheet route (flutter/flutter#164675) 2025-04-02 [email protected] Roll Fuchsia Test Scripts from AEdsljKmUiPk92Wvv... to FZdRtNwH7jmADecj6... (flutter/flutter#166383) 2025-04-02 [email protected] [Impeller] cache for text shadows. (flutter/flutter#166228) 2025-04-02 [email protected] Convert `AppPluginLoaderPlugin` to Kotlin, and add `NativePluginLoaderReflectionBridge` to expose it in Kotlin (flutter/flutter#166027) 2025-04-02 [email protected] Roll Dart SDK from 4e1f02bc704f to b8b4076b1237 (7 revisions) (flutter/flutter#166474) 2025-04-02 [email protected] Update Roadmap (flutter/flutter#166332) 2025-04-02 [email protected] Update `CODEOWNERS` (flutter/flutter#166444) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose ...
Add
SemanticsValidationResult
to semantics that maps ontoaria-invalid
.Fixes #162142