Sitelet https://github.com/flutter/flutter/pull/189692
Skip to content

Clarify CustomScrollView use cases - #189692

Merged
auto-submit[bot] merged 4 commits into
flutter:masterfrom
awnoa:docs/custom-scroll-view-use-case
Jul 29, 2026
Merged

auto-submit[bot] merged 4 commits into
flutter:masterfrom
awnoa:docs/custom-scroll-view-use-case

Conversation

@awnoa

@awnoa awnoa commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

This updates the CustomScrollView API documentation to describe its common use case more directly: combining different kinds of scrollable content. The introduction now also calls out SliverToBoxAdapter, so readers can see how regular box widgets fit alongside lists, grids, and expanding headers.

Fixes #142673.

Tests: not run (documentation-only change; comment-only changes are automatically test-exempt).

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

@google-cla

google-cla Bot commented Jul 18, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions Bot added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. labels Jul 18, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for CustomScrollView to describe it as combining and scrolling multiple kinds of content together, specifically adding a reference to wrapping box widgets in a SliverToBoxAdapter. Feedback suggests using the singular form 'a box widget' to prevent the implication that a single SliverToBoxAdapter can accept multiple child widgets.

Comment thread packages/flutter/lib/src/widgets/scroll_view.dart Outdated
@Piinks
Piinks requested review from Piinks and victorsanni July 21, 2026 22:17
Comment thread packages/flutter/lib/src/widgets/scroll_view.dart Outdated
Comment thread packages/flutter/lib/src/widgets/scroll_view.dart Outdated
Comment thread packages/flutter/lib/src/widgets/scroll_view.dart Outdated
@victorsanni victorsanni added the CICD Run CI/CD label Jul 23, 2026

@Piinks Piinks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

stuartmorgan-g pushed a commit to flutter/packages that referenced this pull request Jul 30, 2026
…12325)

Manual roll requested by stuartmorgan@google.com

flutter/flutter@c83f80b...2a230d1

2026-07-29 zerouali.bardai.omar@gmail.com Clarify CustomScrollView use
cases (flutter/flutter#189692)
2026-07-29 brunocorona.alcantar@gmail.com Fix TreeSliver first node
clipping during expand/collapse animation (flutter/flutter#188626)
2026-07-29 chris@bracken.jp iOS: Migrate VSyncClient tests to Swift
Testing (flutter/flutter#190054)
2026-07-29 32538273+ValentinVignal@users.noreply.github.com Remove no
shuffle from flutter_driver extension_test.dart and mock flutter.process
channel (flutter/flutter#187559)
2026-07-29 52160996+FMorschel@users.noreply.github.com Adds missing
await on `instantiateImageCodecFromBuffer` (flutter/flutter#188910)
2026-07-29 1961493+harryterkelsen@users.noreply.github.com [web] Provide
Content-Length header for CanvasKit files in flutter test
(flutter/flutter#190155)

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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] CustomScrollView's documentation should be more clear on its use case

3 participants