This repository was archived by the owner on Feb 25, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6k
Use announce function in live region #38084
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1743,12 +1743,38 @@ void _testImage() { | |
}); | ||
} | ||
|
||
class MockAccessibilityAnnouncements implements AccessibilityAnnouncements { | ||
int announceInvoked = 0; | ||
|
||
@override | ||
void announce(String message, Assertiveness assertiveness) { | ||
announceInvoked += 1; | ||
} | ||
|
||
@override | ||
DomHTMLElement ariaLiveElementFor(Assertiveness assertiveness) { | ||
return createDomHTMLDivElement(); | ||
} | ||
|
||
@override | ||
void dispose() { | ||
} | ||
|
||
@override | ||
void handleMessage(StandardMessageCodec codec, ByteData? data) { | ||
} | ||
} | ||
|
||
void _testLiveRegion() { | ||
test('renders a live region if there is a label', () async { | ||
test('announces the label after an update', () async { | ||
semantics() | ||
..debugOverrideTimestampFunction(() => _testTime) | ||
..semanticsEnabled = true; | ||
|
||
final MockAccessibilityAnnouncements mockAccessibilityAnnouncements = | ||
MockAccessibilityAnnouncements(); | ||
debugOverrideAccessibilityAnnouncements(mockAccessibilityAnnouncements); | ||
|
||
final ui.SemanticsUpdateBuilder builder = ui.SemanticsUpdateBuilder(); | ||
updateNode( | ||
builder, | ||
|
@@ -1758,19 +1784,20 @@ void _testLiveRegion() { | |
rect: const ui.Rect.fromLTRB(0, 0, 100, 50), | ||
); | ||
semantics().updateSemantics(builder.build()); | ||
|
||
expectSemanticsTree(''' | ||
<sem aria-label="This is a snackbar" aria-live="polite" style="$rootSemanticStyle"></sem> | ||
'''); | ||
expect(mockAccessibilityAnnouncements.announceInvoked, 1); | ||
|
||
semantics().semanticsEnabled = false; | ||
}); | ||
|
||
test('does not render a live region if there is no label', () async { | ||
test('does not announce anything if there is no label', () async { | ||
semantics() | ||
..debugOverrideTimestampFunction(() => _testTime) | ||
..semanticsEnabled = true; | ||
|
||
final MockAccessibilityAnnouncements mockAccessibilityAnnouncements = | ||
MockAccessibilityAnnouncements(); | ||
debugOverrideAccessibilityAnnouncements(mockAccessibilityAnnouncements); | ||
|
||
final ui.SemanticsUpdateBuilder builder = ui.SemanticsUpdateBuilder(); | ||
updateNode( | ||
builder, | ||
|
@@ -1779,10 +1806,40 @@ void _testLiveRegion() { | |
rect: const ui.Rect.fromLTRB(0, 0, 100, 50), | ||
); | ||
semantics().updateSemantics(builder.build()); | ||
expect(mockAccessibilityAnnouncements.announceInvoked, 0); | ||
|
||
expectSemanticsTree(''' | ||
<sem style="$rootSemanticStyle"></sem> | ||
'''); | ||
semantics().semanticsEnabled = false; | ||
}); | ||
|
||
test('does not announce the same label over and over', () async { | ||
semantics() | ||
..debugOverrideTimestampFunction(() => _testTime) | ||
..semanticsEnabled = true; | ||
|
||
final MockAccessibilityAnnouncements mockAccessibilityAnnouncements = | ||
MockAccessibilityAnnouncements(); | ||
debugOverrideAccessibilityAnnouncements(mockAccessibilityAnnouncements); | ||
|
||
ui.SemanticsUpdateBuilder builder = ui.SemanticsUpdateBuilder(); | ||
updateNode( | ||
builder, | ||
label: 'This is a snackbar', | ||
flags: 0 | ui.SemanticsFlag.isLiveRegion.index, | ||
transform: Matrix4.identity().toFloat64(), | ||
rect: const ui.Rect.fromLTRB(0, 0, 100, 50), | ||
); | ||
semantics().updateSemantics(builder.build()); | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: I'd add There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good point! Done! |
||
builder = ui.SemanticsUpdateBuilder(); | ||
updateNode( | ||
builder, | ||
label: 'This is a snackbar', | ||
flags: 0 | ui.SemanticsFlag.isLiveRegion.index, | ||
transform: Matrix4.identity().toFloat64(), | ||
rect: const ui.Rect.fromLTRB(0, 0, 100, 50), | ||
); | ||
semantics().updateSemantics(builder.build()); | ||
expect(mockAccessibilityAnnouncements.announceInvoked, 1); | ||
|
||
semantics().semanticsEnabled = false; | ||
}); | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 logic that protects us from announcing the same message again is missing a test. It can be tested by clearing the contents of
ariaLiveElementFor(Assertiveness.polite)
after the first announcement, issuing an update with the same message, and verifying that the element remains empty.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.
Based on our conversation, I implemented a mock class for
AccessibilityAnnouncements
and added this test case.