SliverSemantics #167300

Renzo-Olivares · 2025-04-16T19:53:34Z

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.

Renzo-Olivares · 2025-06-06T17:54:10Z

packages/flutter/test/widgets/sliversemantics_test.dart

+  });
+
+  testWidgets(
+    'does not merge conflicting actions even if one of them is blocked with Semantics widget',


I'm not too sure if the expected explicitChildNodes: true is the way to solve the issues with this test.

For context this test comes from:

flutter/packages/flutter/test/widgets/semantics_test.dart

Lines 1588 to 1622 in 48c6ef2

testWidgets('does not merge conflicting actions even if one of them is blocked', (

WidgetTester tester,

) async {

final UniqueKey key = UniqueKey();

await tester.pumpWidget(

MaterialApp(

home: Semantics(

key: key,

container: true,

child: Column(

children: <Widget>[

Semantics(

blockUserActions: true,

label: 'label1',

onTap: () {},

child: const SizedBox(width: 10, height: 10),

),

Semantics(

label: 'label2',

onTap: () {},

child: const SizedBox(width: 10, height: 10),

),

],

),

),

),

);

final SemanticsNode node = tester.getSemantics(find.byKey(key));

expect(

node,

matchesSemantics(

children: <Matcher>[containsSemantics(label: 'label1'), containsSemantics(label: 'label2')],

),

);

});

In the test above the nodes under Column are not merged, but in this sliver test, the nodes under SliverList are merged, unless I use explicitChildNodes true in the SliverSemantics widget above the SliverList. I debugged and found that the cause for this is because SliverList adds semantics indexes with IndexedSemantics. If we do addSemanticIndexes: false, then this test also passes.

In the original test from semantics_test.dart if I add an IndexedSemantics around each child of the Column then we run into the same issue where the nodes under the Column are merged.

Created an issue #170485 and updated test to use SliverToBoxAdapter -> Column for now.

Renzo-Olivares · 2025-06-06T17:55:34Z

Google testing is failing because there already exists a SliverSemantics, I think I will try to migrate those uses to use the frameworks SliverSemantics.

chunhtai

overall approach LGTM, just some suggestions to make code a bit cleaner

chunhtai · 2025-06-06T18:12:17Z

packages/flutter/lib/src/rendering/object.dart

+/// for their subtree.
+mixin SemanticsAnnotationsMixin on RenderObject {
+  /// Initializes the semantics annotations for this mixin.
+  void initSemanticsAnnotations({


If this is not meant to be developer facing API. I will turn all the parameter to be required just so that one day we add parameter to the list, we won't forget to update all the internal reference

chunhtai · 2025-06-06T18:15:29Z

packages/flutter/lib/src/widgets/basic.dart

+/// A sliver that annotates its subtree with a description of the meaning of
+/// the slivers.
+///
+/// Used by assistive technologies, search engines, and other semantic analysis


can this use template to deduplicate the doc between this and Semantics widget

I think so, but do you think both should point to the same youtube video since the video talks about the Semantics widget. They're essentially used the same way, but it may be confusing to some? What do you think?

yes, I think this is confusing. I think we should exclude the video out of sliver version of doc

chunhtai · 2025-06-06T18:15:53Z

packages/flutter/lib/src/widgets/basic.dart

+///
+/// See also:
+///
+///  * [SemanticsProperties], which contains a complete documentation for each


maybe add a link to Semantics widget

same for the breadcumb in Semantics widget.

chunhtai · 2025-06-06T18:16:39Z

packages/flutter/lib/src/widgets/basic.dart

+  /// to create semantic boundaries that are either writable or not for children.
+  final bool explicitChildNodes;
+
+  /// Whether to replace all child semantics with this node.


most of this can be doc string

chunhtai · 2025-06-06T18:18:24Z

packages/flutter/lib/src/widgets/basic.dart

+
+  /// Contains properties used by assistive technologies to make the application
+  /// more accessible.
+  final SemanticsProperties properties;


can any of these and the Semantics counter part to be factored out into a mixin. Asking this because adding a flag/property in semantics is already cumbersome, would appreciate we don't add another place that needs to be updated...

Good point! I'll look into ways we can do this.

What do you think about this approach? f22a87a (#167300)

A base class used by both Semantics and SliverSemantics called SemanticsBase where SemanticsBase has its own constructor with every field marked as required. This enforces its subclasses to add that field to their constructor whenever a new one is added to SemanticsBase.

In this world, when we add a new field to SemanticsBase and mark it required, an analyzer error will appear pointing us to add the same field to its subclasses Semantics and SliverSemantics.

chunhtai

LGTM, would be good if we can make it private, but not blocking the pr merge

chunhtai · 2025-06-11T16:39:22Z

packages/flutter/lib/src/widgets/basic.dart

+///    be enabled using [WidgetsApp.showSemanticsDebugger],
+///    [MaterialApp.showSemanticsDebugger], or [CupertinoApp.showSemanticsDebugger].
+/// {@endtemplate}
+sealed class SemanticsBase extends SingleChildRenderObjectWidget {


Thanks for refactor this out it is a lot less duplicated code now, I wonder if this can be private? not sure whether the api doc still work if we make it private though.

Confirmed the API docs still work even if we make it private.

Renzo-Olivares · 2025-06-17T21:03:56Z

Didn't change too much besides making SemanticsBase private, and small language tweaks, API docs still work. I mainly kept the language "widgets" to be more concise, I think it still makes sense.

chunhtai

still LGTM

flutter/flutter@adffe24...ac12f66 2025-07-09 engine-flutter-autoroll@skia.org Roll Packages from cba2e90 to 4a231ae (5 revisions) (flutter/flutter#171879) 2025-07-09 ahmedsameha1@gmail.com Replace [FinderBase] with [Finder] in the documentation of Matchers (flutter/flutter#168279) 2025-07-09 mdebbar@google.com Revert "Mark web_long_running_tests_2_5 as bringup" (flutter/flutter#171872) 2025-07-09 bruno.leroux@gmail.com Apply normalization to TimePickerThemeData.inputDecorationTheme (flutter/flutter#171584) 2025-07-09 bruno.leroux@gmail.com Fix InputDecorationThemeData.activeIndicatorBorder is not applied (flutter/flutter#171764) 2025-07-09 robert.ancell@canonical.com Fix multi-view GL rendering not working since software rendering was added (flutter/flutter#171409) 2025-07-09 fluttergithubbot@gmail.com Marks Linux_android_emu android_engine_vulkan_tests to be unflaky (flutter/flutter#171141) 2025-07-08 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from AinHuT0vgOelA1g7_... to 0-xqmXWc4cXzw3tfe... (flutter/flutter#171823) 2025-07-08 fluttergithubbot@gmail.com Marks Linux_android_emu android_display_cutout to be unflaky (flutter/flutter#171140) 2025-07-08 1063596+reidbaker@users.noreply.github.com [Documentation] When updating kgp minimum document additional changes that are required (flutter/flutter#171819) 2025-07-08 fluttergithubbot@gmail.com Marks Linux_android_emu android_engine_opengles_tests to be unflaky (flutter/flutter#171142) 2025-07-08 biggs0125@gmail.com Add support for running dart2wasm in dry run mode on js compilations (flutter/flutter#171682) 2025-07-08 matanlurey@users.noreply.github.com Remove now duplicate un-forward ports for Android (flutter/flutter#171473) 2025-07-08 kjlubick@users.noreply.github.com [skia] Update usage of removed gn flag (flutter/flutter#171800) 2025-07-08 mdebbar@google.com [web] Disable auto-formatting for the stack_trace.dart test file (flutter/flutter#171801) 2025-07-08 1063596+reidbaker@users.noreply.github.com Bump warn and error versions of agp, kotlin and gradle versions in preparation for gradle 9 (flutter/flutter#171776) 2025-07-08 63253361+Phantom-101@users.noreply.github.com Removed string keys (flutter/flutter#171293) 2025-07-08 32538273+ValentinVignal@users.noreply.github.com Add `radioSide` to `RadioListTile` (flutter/flutter#171318) 2025-07-08 engine-flutter-autoroll@skia.org Roll Fuchsia Test Scripts from ZpnML-jis0gVIvtx5... to MnFlN7VWM_7h7EmBV... (flutter/flutter#171787) 2025-07-08 matanlurey@users.noreply.github.com Add/use `addMachineOutputFlag`/`outputsMachineFormat` instead of strings (flutter/flutter#171459) 2025-07-08 36861262+QuncCccccc@users.noreply.github.com Update translation from console (flutter/flutter#171556) 2025-07-08 bkonyi@google.com [ Tool ] Support upgrading to a new Flutter version pointing to the same revision as a previous version (flutter/flutter#171783) 2025-07-08 matej.knopp@gmail.com Multi-window support (engine) (flutter/flutter#168728) 2025-07-08 34269530+PrimaelQuemerais@users.noreply.github.com Fixes an issue where TapRegion would consume taps regardless of navigation state (flutter/flutter#169067) 2025-07-08 rmolivares@renzo-olivares.dev SliverSemantics (flutter/flutter#167300) 2025-07-08 engine-flutter-autoroll@skia.org Roll Skia from e159882c6ce0 to 0fef076beec3 (3 revisions) (flutter/flutter#171779) 2025-07-08 mdebbar@google.com Run hot_restart_web_amd_test.dart on Mac/Windows (flutter/flutter#171281) 2025-07-08 engine-flutter-autoroll@skia.org Roll Packages from 2c52f24 to cba2e90 (2 revisions) (flutter/flutter#171775) 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 louisehsu@google.com,stuartmorgan@google.com 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 To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

Fixes flutter#166785 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. --------- Co-authored-by: Renzo Olivares <roliv@google.com>

…r#9584) flutter/flutter@adffe24...ac12f66 2025-07-09 engine-flutter-autoroll@skia.org Roll Packages from cba2e90 to 4a231ae (5 revisions) (flutter/flutter#171879) 2025-07-09 ahmedsameha1@gmail.com Replace [FinderBase] with [Finder] in the documentation of Matchers (flutter/flutter#168279) 2025-07-09 mdebbar@google.com Revert "Mark web_long_running_tests_2_5 as bringup" (flutter/flutter#171872) 2025-07-09 bruno.leroux@gmail.com Apply normalization to TimePickerThemeData.inputDecorationTheme (flutter/flutter#171584) 2025-07-09 bruno.leroux@gmail.com Fix InputDecorationThemeData.activeIndicatorBorder is not applied (flutter/flutter#171764) 2025-07-09 robert.ancell@canonical.com Fix multi-view GL rendering not working since software rendering was added (flutter/flutter#171409) 2025-07-09 fluttergithubbot@gmail.com Marks Linux_android_emu android_engine_vulkan_tests to be unflaky (flutter/flutter#171141) 2025-07-08 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from AinHuT0vgOelA1g7_... to 0-xqmXWc4cXzw3tfe... (flutter/flutter#171823) 2025-07-08 fluttergithubbot@gmail.com Marks Linux_android_emu android_display_cutout to be unflaky (flutter/flutter#171140) 2025-07-08 1063596+reidbaker@users.noreply.github.com [Documentation] When updating kgp minimum document additional changes that are required (flutter/flutter#171819) 2025-07-08 fluttergithubbot@gmail.com Marks Linux_android_emu android_engine_opengles_tests to be unflaky (flutter/flutter#171142) 2025-07-08 biggs0125@gmail.com Add support for running dart2wasm in dry run mode on js compilations (flutter/flutter#171682) 2025-07-08 matanlurey@users.noreply.github.com Remove now duplicate un-forward ports for Android (flutter/flutter#171473) 2025-07-08 kjlubick@users.noreply.github.com [skia] Update usage of removed gn flag (flutter/flutter#171800) 2025-07-08 mdebbar@google.com [web] Disable auto-formatting for the stack_trace.dart test file (flutter/flutter#171801) 2025-07-08 1063596+reidbaker@users.noreply.github.com Bump warn and error versions of agp, kotlin and gradle versions in preparation for gradle 9 (flutter/flutter#171776) 2025-07-08 63253361+Phantom-101@users.noreply.github.com Removed string keys (flutter/flutter#171293) 2025-07-08 32538273+ValentinVignal@users.noreply.github.com Add `radioSide` to `RadioListTile` (flutter/flutter#171318) 2025-07-08 engine-flutter-autoroll@skia.org Roll Fuchsia Test Scripts from ZpnML-jis0gVIvtx5... to MnFlN7VWM_7h7EmBV... (flutter/flutter#171787) 2025-07-08 matanlurey@users.noreply.github.com Add/use `addMachineOutputFlag`/`outputsMachineFormat` instead of strings (flutter/flutter#171459) 2025-07-08 36861262+QuncCccccc@users.noreply.github.com Update translation from console (flutter/flutter#171556) 2025-07-08 bkonyi@google.com [ Tool ] Support upgrading to a new Flutter version pointing to the same revision as a previous version (flutter/flutter#171783) 2025-07-08 matej.knopp@gmail.com Multi-window support (engine) (flutter/flutter#168728) 2025-07-08 34269530+PrimaelQuemerais@users.noreply.github.com Fixes an issue where TapRegion would consume taps regardless of navigation state (flutter/flutter#169067) 2025-07-08 rmolivares@renzo-olivares.dev SliverSemantics (flutter/flutter#167300) 2025-07-08 engine-flutter-autoroll@skia.org Roll Skia from e159882c6ce0 to 0fef076beec3 (3 revisions) (flutter/flutter#171779) 2025-07-08 mdebbar@google.com Run hot_restart_web_amd_test.dart on Mac/Windows (flutter/flutter#171281) 2025-07-08 engine-flutter-autoroll@skia.org Roll Packages from 2c52f24 to cba2e90 (2 revisions) (flutter/flutter#171775) 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 louisehsu@google.com,stuartmorgan@google.com 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 To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

Fixes flutter#166785 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. --------- Co-authored-by: Renzo Olivares <roliv@google.com>

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. labels Apr 16, 2025

Renzo-Olivares force-pushed the sliver-semantics branch from cd37169 to b42e20d Compare May 8, 2025 21:07

github-actions bot added a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels May 8, 2025

Renzo-Olivares force-pushed the sliver-semantics branch 4 times, most recently from 02769d5 to 7202c32 Compare May 10, 2025 00:32

Renzo-Olivares force-pushed the sliver-semantics branch from 7202c32 to ad7e10d Compare May 19, 2025 20:35

Renzo-Olivares force-pushed the sliver-semantics branch 3 times, most recently from 432ea93 to 88b0c8a Compare June 4, 2025 20:25

Renzo-Olivares force-pushed the sliver-semantics branch from 152fe42 to 172f614 Compare June 6, 2025 17:44

Renzo-Olivares changed the title ~~[WIP] SliverSemantics~~ SliverSemantics Jun 6, 2025

Renzo-Olivares marked this pull request as ready for review June 6, 2025 17:45

Renzo-Olivares force-pushed the sliver-semantics branch from 172f614 to 763928e Compare June 6, 2025 17:46

Renzo-Olivares requested a review from chunhtai June 6, 2025 17:47

Renzo-Olivares commented Jun 6, 2025

View reviewed changes

chunhtai reviewed Jun 6, 2025

View reviewed changes

Renzo-Olivares force-pushed the sliver-semantics branch 2 times, most recently from 3e881a7 to 5587ac5 Compare June 9, 2025 22:05

Renzo-Olivares requested a review from chunhtai June 11, 2025 16:26

chunhtai approved these changes Jun 11, 2025

View reviewed changes

Renzo-Olivares force-pushed the sliver-semantics branch from 2d91c2e to 547697a Compare June 17, 2025 21:00

Renzo-Olivares requested a review from chunhtai June 17, 2025 21:02

chunhtai approved these changes Jun 23, 2025

View reviewed changes

Renzo Olivares added 4 commits July 7, 2025 18:27

make SemanticsBase private

28bdba5

docs update

fab80d4

fix analyzer

b73f4c4

format

9aa3fe3

Renzo-Olivares force-pushed the sliver-semantics branch from 49452e1 to 9aa3fe3 Compare July 8, 2025 01:27

empty commit

687cf49

Renzo-Olivares added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 8, 2025

auto-submit bot added this pull request to the merge queue Jul 8, 2025

Merged via the queue into flutter:master with commit 220477f Jul 8, 2025
70 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 8, 2025

ash2moon mentioned this pull request Jul 9, 2025

flutter build apk to use aab then generate apks from aab behind --from-app-bundle #171877

Draft

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

220477fc2 SliverSemantics (flutter/flutter#167300)

816ec9b

engine-flutter-autoroll mentioned this pull request Jul 9, 2025

Roll Flutter from adffe244f3f1 to 41c21bbf927d (25 revisions) flutter/packages#9582

Closed

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

220477fc2 SliverSemantics (flutter/flutter#167300)

639a1fa

engine-flutter-autoroll mentioned this pull request Jul 9, 2025

Roll Flutter from adffe244f3f1 to 55af36a3d506 (27 revisions) flutter/packages#9583

Closed

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

220477fc2 SliverSemantics (flutter/flutter#167300)

f52f5f9

engine-flutter-autoroll mentioned this pull request Jul 9, 2025

Roll Flutter from adffe244f3f1 to ac12f66681f1 (28 revisions) flutter/packages#9584

Merged

Piinks mentioned this pull request Jul 19, 2025

Flutter Notable Commits - 2025 #161460

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

220477fc2 SliverSemantics (flutter/flutter#167300)

f0206e6

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

220477fc2 SliverSemantics (flutter/flutter#167300)

63b227c

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

220477fc2 SliverSemantics (flutter/flutter#167300)

cad8a84

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

220477fc2 SliverSemantics (flutter/flutter#167300)

85a7450

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

220477fc2 SliverSemantics (flutter/flutter#167300)

d304c33

	testWidgets('does not merge conflicting actions even if one of them is blocked', (
	WidgetTester tester,
	) async {
	final UniqueKey key = UniqueKey();
	await tester.pumpWidget(
	MaterialApp(
	home: Semantics(
	key: key,
	container: true,
	child: Column(
	children: <Widget>[
	Semantics(
	blockUserActions: true,
	label: 'label1',
	onTap: () {},
	child: const SizedBox(width: 10, height: 10),
	),
	Semantics(
	label: 'label2',
	onTap: () {},
	child: const SizedBox(width: 10, height: 10),
	),
	],
	),
	),
	),
	);
	final SemanticsNode node = tester.getSemantics(find.byKey(key));
	expect(
	node,
	matchesSemantics(
	children: <Matcher>[containsSemantics(label: 'label1'), containsSemantics(label: 'label2')],
	),
	);
	});

SliverSemantics #167300

SliverSemantics #167300

Uh oh!

Conversation

Renzo-Olivares commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Renzo-Olivares commented Jun 6, 2025

Uh oh!

chunhtai left a comment

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!

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!

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

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!

chunhtai left a comment

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!

Renzo-Olivares commented Jun 17, 2025

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Renzo-Olivares commented Apr 16, 2025 •

edited

Loading

chunhtai Jun 6, 2025 •

edited

Loading