Update DraggableScrollableSheet docs to reflect API change #136471

huycozy · 2023-10-12T17:53:12Z

Description

This PR intends to update DraggableScrollableSheet docs for Web and Desktop platforms. On these platforms, the vertical dragging gesture does not provide natural behavior similar to other desktop applications.

By adding a note before the sample code so users are aware that the sample code will not work as expected on Desktop and Web. Also, refer to the instructions if they still want to implement it on these platforms.

Related issue

Fixes #111372

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.
All existing and new tests are passing.

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

huycozy · 2023-10-13T12:18:02Z

Hi @Piinks, could you please help to review this? :)

Piinks

Hey @huycozy thanks for continuing to contribute!

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

examples/api/lib/widgets/draggable_scrollable_sheet/draggable_scrollable_sheet.0.dart

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

Piinks

This is great! It does make me wonder if we should have drag handles built into the DraggableScrollableSheet, but that would likely entail a design discussion first. Can you file an issue if one does not already exist?
In the meantime, this is a really great example folks can use. :)
Would you like to add tests so we can get this in? Thank you again for you patience!

Signed-off-by: Nguyen Huy <[email protected]>

huycozy · 2023-11-05T17:36:50Z

Thanks for your review, Kate

It does make me wonder if we should have drag handles built into the DraggableScrollableSheet, but that would likely entail a design discussion first. Can you file an issue if one does not already exist?

I've searched but haven't found any similar one. Do you mind if I bring this topic to Discord for further discussion? (Because I'm still a bit vague on how it should work if it's a built-in feature)

Would you like to add tests so we can get this in?

I added tests :)

Piinks

Piinks · 2023-11-13T21:47:40Z

I've searched but haven't found any similar one. Do you mind if I bring this topic to Discord for further discussion? (Because I'm still a bit vague on how it should work if it's a built-in feature)

I don't mind at all, you are welcome to take it to discord or a new issue. :) I think that could be a fun feature.
I found these issues that are sort of related, one of them may be closed by this PR since it adds docs on ScrollBehavior and drag devices. Take a look at these, and if they don't seem quite right, file a new one and we can go from there!

…lutter/flutter#136471)

Roll Flutter from f662150 to e8c2bb1 (66 revisions) flutter/flutter@f662150...e8c2bb1 2023-11-14 [email protected] Reland "Update `framework_test.dart` to remove `ButtonBar` usage and remove references from other clases (#137550) (flutter/flutter#137753) 2023-11-14 [email protected] Consume flutter.js from the engine artifacts. (flutter/flutter#137113) 2023-11-14 [email protected] Roll Flutter Engine from 995ebcefb0d4 to 1b3fd80812c3 (1 revision) (flutter/flutter#138415) 2023-11-14 [email protected] Roll Packages from 17bd92e to 428ba3e (2 revisions) (flutter/flutter#138412) 2023-11-14 [email protected] Roll Flutter Engine from 712094481217 to 995ebcefb0d4 (1 revision) (flutter/flutter#138409) 2023-11-14 [email protected] Roll Flutter Engine from 2c54b5f70c94 to 712094481217 (1 revision) (flutter/flutter#138401) 2023-11-14 [email protected] Roll Flutter Engine from d100e8912eb0 to 2c54b5f70c94 (4 revisions) (flutter/flutter#138399) 2023-11-14 [email protected] Roll Flutter Engine from 74a9de45f128 to d100e8912eb0 (3 revisions) (flutter/flutter#138383) 2023-11-14 [email protected] Roll Flutter Engine from 77b952f3add4 to 74a9de45f128 (3 revisions) (flutter/flutter#138382) 2023-11-14 [email protected] Fixing typo (flutter/flutter#138253) 2023-11-14 [email protected] Roll Flutter Engine from 046ec85dffc6 to 77b952f3add4 (1 revision) (flutter/flutter#138377) 2023-11-13 [email protected] Roll Flutter Engine from db6da000a17e to 046ec85dffc6 (5 revisions) (flutter/flutter#138375) 2023-11-13 [email protected] Finally remove analysis_options_user.yaml (flutter/flutter#138261) 2023-11-13 [email protected] Add a DevTools section to CONTRIBUTING.md (flutter/flutter#137193) 2023-11-13 [email protected] Update DraggableScrollableSheet docs to reflect API change (flutter/flutter#136471) 2023-11-13 [email protected] Clean up synonyms, key code generation. (flutter/flutter#138192) 2023-11-13 [email protected] Roll Flutter Engine from 74ba6c17a488 to db6da000a17e (2 revisions) (flutter/flutter#138364) 2023-11-13 [email protected] Roll Flutter Engine from 5d62f1a2392a to 74ba6c17a488 (1 revision) (flutter/flutter#138362) 2023-11-13 [email protected] Roll Flutter Engine from 7de793d2bb68 to 5d62f1a2392a (1 revision) (flutter/flutter#138358) 2023-11-13 [email protected] Upgrade leak tracker. (flutter/flutter#138283) 2023-11-13 [email protected] Roll Flutter Engine from fe11f3a46bac to 7de793d2bb68 (2 revisions) (flutter/flutter#138353) 2023-11-13 [email protected] Roll Packages from a682189 to 17bd92e (2 revisions) (flutter/flutter#138347) 2023-11-13 [email protected] Roll Flutter Engine from a18ee3c7f57a to fe11f3a46bac (2 revisions) (flutter/flutter#138344) 2023-11-12 [email protected] Roll Flutter Engine from 828e4dbf6693 to a18ee3c7f57a (7 revisions) (flutter/flutter#138332) 2023-11-11 [email protected] Roll Flutter Engine from e2e07eab35ec to 828e4dbf6693 (1 revision) (flutter/flutter#138282) 2023-11-11 [email protected] Roll Flutter Engine from 1c29ce15c528 to e2e07eab35ec (1 revision) (flutter/flutter#138280) 2023-11-11 [email protected] Roll Flutter Engine from aa6753fdbb51 to 1c29ce15c528 (1 revision) (flutter/flutter#138277) 2023-11-11 [email protected] Roll Flutter Engine from 00db306f6f7b to aa6753fdbb51 (1 revision) (flutter/flutter#138269) 2023-11-11 [email protected] Roll Flutter Engine from 9d8a1125640d to 00db306f6f7b (7 revisions) (flutter/flutter#138266) 2023-11-10 [email protected] Only run tests on macOS 12 (flutter/flutter#138260) 2023-11-10 [email protected] Fixes vscode path installed via snap (flutter/flutter#136997) 2023-11-10 [email protected] Docs typo: comprised -> composed (flutter/flutter#137896) 2023-11-10 [email protected] Deprecates onWillAccept and onAccept callbacks in DragTarget. (flutter/flutter#133691) 2023-11-10 [email protected] [macOS] Suppress Xcode 15 createItemModels warning (flutter/flutter#138243) 2023-11-10 [email protected] Roll Flutter Engine from 275ddb296ec9 to 9d8a1125640d (1 revision) (flutter/flutter#138252) 2023-11-10 [email protected] GestureRecognizer should dispatch creation and disposal events. (flutter/flutter#138223) 2023-11-10 [email protected] Roll Flutter Engine from 5c2e16c5a95a to 275ddb296ec9 (1 revision) (flutter/flutter#138249) 2023-11-10 [email protected] Roll Packages from b69f54e to a682189 (3 revisions) (flutter/flutter#138239) 2023-11-10 [email protected] Roll Flutter Engine from e5b75177ac8e to 5c2e16c5a95a (1 revision) (flutter/flutter#138247) 2023-11-10 [email protected] `CommandResultEvent` migrated (flutter/flutter#138165) 2023-11-10 [email protected] Fix #128925 by properly setting the Android Event Source (flutter/flutter#138241) 2023-11-10 [email protected] Roll Flutter Engine from 77349dc8e27b to e5b75177ac8e (2 revisions) (flutter/flutter#138244) 2023-11-10 [email protected] Roll Flutter Engine from a5eab0d281fe to 77349dc8e27b (4 revisions) (flutter/flutter#138237) 2023-11-10 [email protected] Update analytics constructor to include `FLUTTER_HOST` (flutter/flutter#138107) 2023-11-10 [email protected] Prepare the analyze_once test for removal of analysis_options_user support (flutter/flutter#138229) 2023-11-10 [email protected] Roll Flutter Engine from b020893cba29 to a5eab0d281fe (5 revisions) (flutter/flutter#138231) ...

…lutter/flutter#136471)

huycozy self-assigned this Oct 12, 2023

huycozy force-pushed the update_draggablescrollablesheet_docs branch from 542ba46 to 4c7286f Compare October 13, 2023 08:31

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. labels Oct 13, 2023

huycozy requested a review from Piinks October 13, 2023 12:16

Piinks reviewed Oct 13, 2023

View reviewed changes

packages/flutter/lib/src/widgets/draggable_scrollable_sheet.dart Outdated Show resolved Hide resolved

huycozy force-pushed the update_draggablescrollablesheet_docs branch 2 times, most recently from ad1732d to f4674e0 Compare October 15, 2023 12:09

Piinks reviewed Oct 16, 2023

View reviewed changes

packages/flutter/lib/src/widgets/draggable_scrollable_sheet.dart Outdated Show resolved Hide resolved

huycozy force-pushed the update_draggablescrollablesheet_docs branch from f4674e0 to 9ef78ca Compare October 19, 2023 19:24

github-actions bot added d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Oct 19, 2023

huycozy force-pushed the update_draggablescrollablesheet_docs branch 2 times, most recently from bed4a1a to 6661bfa Compare October 26, 2023 15:47

goderbauer requested a review from Piinks October 31, 2023 22:05

Piinks reviewed Nov 2, 2023

View reviewed changes

huycozy force-pushed the update_draggablescrollablesheet_docs branch from 6661bfa to 1b97b87 Compare November 4, 2023 18:20

Update DraggableScrollableSheet docs and example to reflect API change

d448a60

Signed-off-by: Nguyen Huy <[email protected]>

huycozy force-pushed the update_draggablescrollablesheet_docs branch from 1b97b87 to d448a60 Compare November 4, 2023 18:29

goderbauer requested a review from Piinks November 7, 2023 23:16

Piinks approved these changes Nov 13, 2023

View reviewed changes

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 13, 2023

auto-submit bot merged commit 61c007a into flutter:master Nov 13, 2023

engine-flutter-autoroll mentioned this pull request Nov 14, 2023

Roll Flutter from f66215027e14 to b356bb387fc3 (62 revisions) flutter/packages#5395

Closed

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

61c007a Update DraggableScrollableSheet docs to reflect API change (f…

bb6c978

…lutter/flutter#136471)

engine-flutter-autoroll mentioned this pull request Nov 14, 2023

Roll Flutter from f66215027e14 to ff72804498e3 (63 revisions) flutter/packages#5396

Closed

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

61c007a Update DraggableScrollableSheet docs to reflect API change (f…

76c76f9

…lutter/flutter#136471)

engine-flutter-autoroll mentioned this pull request Nov 14, 2023

Roll Flutter from f66215027e14 to 463c02daafa5 (64 revisions) flutter/packages#5397

Closed

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

61c007a Update DraggableScrollableSheet docs to reflect API change (f…

7aab32c

…lutter/flutter#136471)

engine-flutter-autoroll mentioned this pull request Nov 14, 2023

Roll Flutter from f66215027e14 to 07d73630fbdb (65 revisions) flutter/packages#5398

Closed

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

61c007a Update DraggableScrollableSheet docs to reflect API change (f…

0a93f21

…lutter/flutter#136471)

engine-flutter-autoroll mentioned this pull request Nov 14, 2023

Roll Flutter from f66215027e14 to e8c2bb135659 (66 revisions) flutter/packages#5399

Merged

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

61c007a Update DraggableScrollableSheet docs to reflect API change (f…

a3bb413

…lutter/flutter#136471)

HansMuller mentioned this pull request Nov 17, 2023

Flutter Framework Team: Notable Commits #121415

Closed

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

61c007a Update DraggableScrollableSheet docs to reflect API change (f…

2e50c2f

…lutter/flutter#136471)

huycozy deleted the update_draggablescrollablesheet_docs branch November 26, 2025 10:12

huycozy mentioned this pull request Nov 26, 2025

DraggableScrollableSheet drag speed is off #179102

Closed

huycozy mentioned this pull request Dec 9, 2025

Fix draggable scrollable sheet example drag speed is off #179179

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update DraggableScrollableSheet docs to reflect API change #136471

Update DraggableScrollableSheet docs to reflect API change #136471

Uh oh!

huycozy commented Oct 12, 2023

Uh oh!

huycozy commented Oct 13, 2023

Uh oh!

Piinks left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Piinks left a comment

Uh oh!

huycozy commented Nov 5, 2023

Uh oh!

Piinks left a comment

Uh oh!

Piinks commented Nov 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update DraggableScrollableSheet docs to reflect API change #136471

Update DraggableScrollableSheet docs to reflect API change #136471

Uh oh!

Conversation

huycozy commented Oct 12, 2023

Description

Related issue

Pre-launch Checklist

Uh oh!

huycozy commented Oct 13, 2023

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

huycozy commented Nov 5, 2023

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Piinks commented Nov 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants