Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docs for [PageStorage] #63634

Merged
merged 3 commits into from Aug 21, 2020
Merged

Improve docs for [PageStorage] #63634

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0c9fde
Improve docs for [PageStorage] #62332
xu-baolin Aug 13, 2020
b42b8e9
Improve docs
xu-baolin Aug 14, 2020
e14d521
Merge branch 'master' of github.com:flutter/flutter into 0812
xu-baolin Aug 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/flutter/lib/src/widgets/page_storage.dart
View file
Open in desktop
Expand Up @@ -130,8 +130,12 @@ class PageStorageBucket {
/// Usually you don't need to explicitly use a [PageStorage], since it's already
/// included in routes.
///
/// [PageStorageKey] is used by [Scrollable] if
/// `keepScrollOffset` is enabled to save their [ScrollPosition]s.
/// [PageStorageKey] is used by [Scrollable] if [ScrollController.keepScrollOffset]
/// is enabled to save their [ScrollPosition]s. When more than one
/// scrollable ([ListView], [SingleChildScrollView], [TextField], etc.) appears
/// in the same route, if you want to save all of their positions,
Copy link
Contributor

Choose a reason for hiding this comment

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

Are you sure if it's only when they appear in the same route, or should it be global unique?

Copy link
Member Author

@xu-baolin xu-baolin Aug 14, 2020 •
edited

Choose a reason for hiding this comment

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

Not need global unique, but should be equal between rebuilding.

Copy link
Member Author

Choose a reason for hiding this comment

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

If you like you can give them the same key, it works well. Because the identifier is a key chain

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, "in the same route" is not precise enough, isn't it?

Suggested change
/// in the same route, if you want to save all of their positions,
/// within the widget's closest ancestor [PageStorage] (such as within the same route), if you want to save all of their positions,

Copy link
Contributor

Choose a reason for hiding this comment

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

Also "if you want to save all of their positions" should be "if you want to save all of their positions independently" followed by "unique [PageStorageKey]s". Otherwise, their positions ARE stored, but overridden by each other.

Copy link
Member Author

Choose a reason for hiding this comment

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

NICE suggesting.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

/// you should give each of them a [PageStorageKey], or set some of their
/// `keepScrollOffset` false to prevent saving.
///
/// {@tool dartpad --template=freeform}
///
Expand Down