Repository navigation
Clarify lazy scroll extent docs - #186864
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for ScrollController and ScrollMetrics to clarify that maxScrollExtent may be an estimate for lazy scrollables like ListView.builder. Feedback was provided to improve the precision of the documentation by explaining that animation targets are fixed at the start and clarifying that Scrollable.ensureVisible requires the target child to be built.
636a5ef to
c845d29
Compare
|
Updated the |
|
autosubmit label was removed for flutter/flutter/186864, because The base commit of the PR is older than 7 days and can not be merged. Please merge the latest changes from the main into this branch and resubmit the PR. |
|
auto label is removed for flutter/flutter/186864, Failed to enqueue flutter/flutter/186864 with HTTP 400: Pull request Required status check "Merge Queue Guard" is expected.. |
flutter/flutter@e70534d...b05a9d7 2026-05-29 [email protected] Roll Skia from 47155534833e to d9d6b440c4e7 (1 revision) (flutter/flutter#187301) 2026-05-29 [email protected] Roll Skia from f93ed13d77fb to 47155534833e (4 revisions) (flutter/flutter#187291) 2026-05-29 [email protected] [web_ui] Optimize skwasm text layout and path decoding to eliminate dynamic boxing churn under Wasm (flutter/flutter#186978) 2026-05-29 [email protected] Roll Fuchsia Linux SDK from SBpmmPxqx3lAvGojE... to jMR_VXQi07kAk8vbR... (flutter/flutter#187279) 2026-05-29 [email protected] Remove Material import from sliver tree rendering test (flutter/flutter#187000) 2026-05-29 [email protected] [Impeller] Remove the y_coord_scale Y-flip plumbing (flutter/flutter#187224) 2026-05-29 [email protected] Add/remove overlay child RenderObject from the tree in `attach`/`detach` (flutter/flutter#186564) 2026-05-29 [email protected] Roll Skia from fcfe5975c945 to f93ed13d77fb (4 revisions) (flutter/flutter#187273) 2026-05-28 [email protected] Handle complex RSE rendering in the uber SDF pipeline (flutter/flutter#186434) 2026-05-28 [email protected] Roll Dart SDK from 082191101fcc to 683322426411 (2 revisions) (flutter/flutter#187270) 2026-05-28 [email protected] Clarify route transition animations (flutter/flutter#186552) 2026-05-28 [email protected] document that the default Key is null and explain proper usage in list diffing (flutter/flutter#185197) 2026-05-28 [email protected] [flutter_tools] Use super parameters in missed spots (flutter/flutter#186197) 2026-05-28 [email protected] docs: Document MediaQueryData.alwaysUse24HourFormat on macOS, Windows, Linux, web (#160664) (flutter/flutter#186642) 2026-05-28 [email protected] Roll Skia from 5493e4c144cd to fcfe5975c945 (3 revisions) (flutter/flutter#187256) 2026-05-28 [email protected] Shares opengles golden context (flutter/flutter#187243) 2026-05-28 [email protected] Update the Curl CIPD package in .ci.yaml to version 8.20.0 (flutter/flutter#187133) 2026-05-28 [email protected] Improve SizedBox's docs (flutter/flutter#187208) 2026-05-28 [email protected] [Impeller] Support instanced rendering across all backends (flutter/flutter#186653) 2026-05-28 [email protected] [Android] Reset system UI visibility flags when setting edge-to-edge mode (flutter/flutter#187207) 2026-05-28 [email protected] Roll Skia from a38708fb7926 to 5493e4c144cd (7 revisions) (flutter/flutter#187241) 2026-05-28 [email protected] Turned on impeller by default on macos (flutter/flutter#186546) 2026-05-28 [email protected] Clarify lazy scroll extent docs (flutter/flutter#186864) 2026-05-28 [email protected] [web] Fix WebParagraph locales test (flutter/flutter#186813) 2026-05-28 [email protected] Roll Packages from 4b424d7 to 10cbdc5 (3 revisions) (flutter/flutter#187238) 2026-05-28 [email protected] Roll Dart SDK from f3db7b7d9801 to 082191101fcc (8 revisions) (flutter/flutter#187235) 2026-05-28 [email protected] Roll Skia from 32acea791248 to a38708fb7926 (1 revision) (flutter/flutter#187221) 2026-05-28 [email protected] [Flutter GPU] Add r32Float and remove Apple-only XR pixel formats (flutter/flutter#187069) 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 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
…r#11803) flutter/flutter@e70534d...b05a9d7 2026-05-29 [email protected] Roll Skia from 47155534833e to d9d6b440c4e7 (1 revision) (flutter/flutter#187301) 2026-05-29 [email protected] Roll Skia from f93ed13d77fb to 47155534833e (4 revisions) (flutter/flutter#187291) 2026-05-29 [email protected] [web_ui] Optimize skwasm text layout and path decoding to eliminate dynamic boxing churn under Wasm (flutter/flutter#186978) 2026-05-29 [email protected] Roll Fuchsia Linux SDK from SBpmmPxqx3lAvGojE... to jMR_VXQi07kAk8vbR... (flutter/flutter#187279) 2026-05-29 [email protected] Remove Material import from sliver tree rendering test (flutter/flutter#187000) 2026-05-29 [email protected] [Impeller] Remove the y_coord_scale Y-flip plumbing (flutter/flutter#187224) 2026-05-29 [email protected] Add/remove overlay child RenderObject from the tree in `attach`/`detach` (flutter/flutter#186564) 2026-05-29 [email protected] Roll Skia from fcfe5975c945 to f93ed13d77fb (4 revisions) (flutter/flutter#187273) 2026-05-28 [email protected] Handle complex RSE rendering in the uber SDF pipeline (flutter/flutter#186434) 2026-05-28 [email protected] Roll Dart SDK from 082191101fcc to 683322426411 (2 revisions) (flutter/flutter#187270) 2026-05-28 [email protected] Clarify route transition animations (flutter/flutter#186552) 2026-05-28 [email protected] document that the default Key is null and explain proper usage in list diffing (flutter/flutter#185197) 2026-05-28 [email protected] [flutter_tools] Use super parameters in missed spots (flutter/flutter#186197) 2026-05-28 [email protected] docs: Document MediaQueryData.alwaysUse24HourFormat on macOS, Windows, Linux, web (#160664) (flutter/flutter#186642) 2026-05-28 [email protected] Roll Skia from 5493e4c144cd to fcfe5975c945 (3 revisions) (flutter/flutter#187256) 2026-05-28 [email protected] Shares opengles golden context (flutter/flutter#187243) 2026-05-28 [email protected] Update the Curl CIPD package in .ci.yaml to version 8.20.0 (flutter/flutter#187133) 2026-05-28 [email protected] Improve SizedBox's docs (flutter/flutter#187208) 2026-05-28 [email protected] [Impeller] Support instanced rendering across all backends (flutter/flutter#186653) 2026-05-28 [email protected] [Android] Reset system UI visibility flags when setting edge-to-edge mode (flutter/flutter#187207) 2026-05-28 [email protected] Roll Skia from a38708fb7926 to 5493e4c144cd (7 revisions) (flutter/flutter#187241) 2026-05-28 [email protected] Turned on impeller by default on macos (flutter/flutter#186546) 2026-05-28 [email protected] Clarify lazy scroll extent docs (flutter/flutter#186864) 2026-05-28 [email protected] [web] Fix WebParagraph locales test (flutter/flutter#186813) 2026-05-28 [email protected] Roll Packages from 4b424d7 to 10cbdc5 (3 revisions) (flutter/flutter#187238) 2026-05-28 [email protected] Roll Dart SDK from f3db7b7d9801 to 082191101fcc (8 revisions) (flutter/flutter#187235) 2026-05-28 [email protected] Roll Skia from 32acea791248 to a38708fb7926 (1 revision) (flutter/flutter#187221) 2026-05-28 [email protected] [Flutter GPU] Add r32Float and remove Apple-only XR pixel formats (flutter/flutter#187069) 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 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
Issue: Fixes flutter#94925. `ScrollMetrics.maxScrollExtent` can be surprising for lazily built scrollables because it may be an estimate until more children are laid out, so animating to the current max extent after adding offscreen content may stop before the newly added child. Fix: Clarifies the `ScrollMetrics.maxScrollExtent` docs to call out lazy scrollable estimates, and adds a practical note to `ScrollController.animateTo` about using `Scrollable.ensureVisible` when the goal is to reveal a specific child. Tests: Documentation-only change. Verified with: - `./bin/dart format packages/flutter/lib/src/widgets/scroll_controller.dart packages/flutter/lib/src/widgets/scroll_metrics.dart` - `./bin/flutter analyze packages/flutter/lib/src/widgets/scroll_controller.dart packages/flutter/lib/src/widgets/scroll_metrics.dart` - `git diff --check` Risk: Limited to API documentation in two widgets library files. No behavior, generated output, or test fixture changes. Co-authored-by: Mohellebi Abdessalem <[email protected]>
Issue: Fixes #94925.
ScrollMetrics.maxScrollExtentcan be surprising for lazily built scrollables because it may be an estimate until more children are laid out, so animating to the current max extent after adding offscreen content may stop before the newly added child.Fix: Clarifies the
ScrollMetrics.maxScrollExtentdocs to call out lazy scrollable estimates, and adds a practical note toScrollController.animateToabout usingScrollable.ensureVisiblewhen the goal is to reveal a specific child.Tests: Documentation-only change. Verified with:
./bin/dart format packages/flutter/lib/src/widgets/scroll_controller.dart packages/flutter/lib/src/widgets/scroll_metrics.dart./bin/flutter analyze packages/flutter/lib/src/widgets/scroll_controller.dart packages/flutter/lib/src/widgets/scroll_metrics.dartgit diff --checkRisk: Limited to API documentation in two widgets library files. No behavior, generated output, or test fixture changes.