Added a clarification on scrollBehaviour in BoxScroll and ListView #107738
Conversation
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
Piinks
reviewed
Jul 15, 2022
Comment on lines
626
to
628
| /// [ScrollBehavior] cannot be provided because it is only exposed | ||
| /// in widgets where the scrolling is hard-coded due to scrollbars and | ||
| /// overscroll indicators, or widget-specific [ScrollPhysics]. |
There was a problem hiding this comment.
This kind of assumes the user is aware that other types of scrollable widgets can have a ScrollBehavior provided. If I do not know this, I read this and wonder, what do you mean scroll behavior?
Also, I realized mentioning physics here doesn't make sense since `physics' is a parameter that is already available.
What about something like...
Suggested change
| /// [ScrollBehavior] cannot be provided because it is only exposed | |
| /// in widgets where the scrolling is hard-coded due to scrollbars and | |
| /// overscroll indicators, or widget-specific [ScrollPhysics]. | |
| /// [ScrollView]s are often decorated with [Scrollbar]s and overscroll indicators, which are managed by the inherited [ScrollBehavior]. Placing a [ScrollConfiguration] above a ScrollView can modify these behaviors for that ScrollView, or can be managed app-wide by providing a ScrollBehavior to [MaterialApp.scrollBehavior] or [CupertinoApp.scrollBehavior]. |
Feel free to adjust. Thanks for using a template!
| @@ -620,6 +620,14 @@ class CustomScrollView extends ScrollView { | |||
|
|
|||
| /// A [ScrollView] that uses a single child layout model. | |||
| /// | |||
| /// {@template flutter.widgets.BoxScroll.scrollBehaviour} | |||
| /// ## Scrolling Behaviour | |||
There was a problem hiding this comment.
Nit:
Suggested change
| /// ## Scrolling Behaviour | |
| /// ## Scrolling Behavior |
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/plugins
that referenced
this pull request
Jul 28, 2022
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jul 28, 2022
camsim99
pushed a commit
to camsim99/flutter
that referenced
this pull request
Aug 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added a clarification on the docs of BoxScroll and ListView about the access that you have to ScrollBehavior. It seems that
List which issues are fixed by this PR. You must list at least one issue.
Fixes #98003
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.