Updated document to clarify Clip Behaviour #157719

Neutrino2711 · 2024-10-28T13:58:41Z

Revised comments to clarify that clipping of child depends on clipBehavior of the parent widget, typically scrollable widgets that default to Clips.hard.
Noted that decoration features such as shadows , which render outside the widget boundary, may lead to undesirable effects.
Recommended using Clips.none in scenarios where shadow effects are used to avoid clipping issues.
Fixing Issue #156819

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.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

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

Neutrino2711 · 2024-10-30T14:50:08Z

19-54-04.mp4

I created this please do review @nate-thegrate

nate-thegrate · 2024-10-30T21:26:11Z

That looks awesome!

Currently we have a decorated_sliver.0.dart file, which is referenced in the documentation:

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

Lines 31 to 35 in ec04707

    
           /// {@tool dartpad} 
        
           /// This sample shows a radial gradient that draws a moon on a night sky: 
        
           /// 
        
           /// ** See code in examples/api/lib/widgets/sliver/decorated_sliver.0.dart ** 
        
           /// {@end-tool}

Would you be able to add a decorated_sliver.1.dart file with this example, and reference it here too?

Neutrino2711 · 2024-10-31T01:05:56Z

Thanks for the review. Yes I will be doing that.

nate-thegrate

Love this example, especially the color scheme you chose!

I have a lot of suggestions; most of which are whitespace-related.

One other thing that needs to be done: create a decorated_sliver.1_test.dart file based on decorated_sliver.0_test.dart, and add maybe 1 or 2 simple tests.

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

Neutrino2711 · 2024-11-01T08:17:35Z

I have a query why decorated_sliver.0.dart is imported like this "import 'package:flutter_api_samples/widgets/sliver/decorated_sliver.0.dart' as example;" in decorated_sliver.0_test.dart file can I import it like this
"import 'package:flutter/examples/api/lib/widgets/sliver/decorated_sliver.0.dart"

…1/flutter into update-documentation

nate-thegrate

Thanks for the update!

I believe this should be the last round of suggestions, though the autoformatter might make some of the whitespace changes difficult to perform.

You could get around this by committing via the GitHub site:

head over to the files tab
click Add suggestion to batch for all of them
then there will be a button to commit the batch at the top of the screen

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

examples/api/test/widgets/sliver/decorated_sliver.1_test.dart

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

examples/api/test/widgets/sliver/decorated_sliver.1_test.dart

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

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

Co-authored-by: Nate Wilson <[email protected]>

Neutrino2711 · 2024-11-01T18:46:47Z

@nate-thegrate Thank you for your guidance.

nate-thegrate

LGTM, thanks for the contribution!

There were just a few analysis problems I missed previously, so go ahead and apply the suggestions when you get a chance. Then we'll be able to merge once the PR has 2 approvals.

There's a wiki page that goes over how to set up your IDE so these linter rules are active while you're editing the file; feel free to check it out when you have a chance!

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

Co-authored-by: Nate Wilson <[email protected]>

nate-thegrate · 2024-11-02T00:25:35Z

I have a query why decorated_sliver.0.dart is imported like this "import 'package:flutter_api_samples/widgets/sliver/decorated_sliver.0.dart' as example;" in decorated_sliver.0_test.dart file can I import it like this "import 'package:flutter/examples/api/lib/widgets/sliver/decorated_sliver.0.dart"

Oh, forgot to answer your question, sorry! Specifying a namespace this way makes it easy to tell which classes are from the example and which ones aren't, and it's a convention followed consistently throughout example test files.

Neutrino2711 · 2024-11-04T20:53:16Z

@nate-thegrate one last help how can I ask for review or how does it work I am new to this.

nate-thegrate · 2024-11-04T21:30:45Z

Sure, no prob!

The Tree Hygiene wiki page has some info on this:

PRs are assigned reviewers weekly. The precise process varies by team but tends to be combined with issue triage.

The next team-framework triage is tomorrow, so we'll figure out a second reviewer then :)

chunhtai

LGTM, just one nitpicking

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

Co-authored-by: chunhtai <[email protected]>

chunhtai · 2024-11-13T21:01:51Z

examples/api/lib/widgets/sliver/decorated_sliver.1.dart

+                activeColor: Colors.pink,
+                onChanged: (bool value) {
+                  setState(() {
+                    isClipped = value;


All reference will need to be changed too

…57719)

Roll Flutter from ed553d1 to 0e2d55e (40 revisions) flutter/flutter@ed553d1...0e2d55e 2024-11-15 [email protected] Roll Packages from b9ac917 to b164be3 (4 revisions) (flutter/flutter#158986) 2024-11-15 [email protected] Label PRs with gradle and Android paths "platform-android" (flutter/flutter#158970) 2024-11-15 [email protected] Fix code asset copying logic in native asset code (flutter/flutter#158984) 2024-11-15 [email protected] Fix duplicate work in native assets release builds (flutter/flutter#158980) 2024-11-15 [email protected] Stop generate both `.kts` and non-`.kts` gradle files for a test project. (flutter/flutter#158965) 2024-11-15 [email protected] Further skip `native_assets_test`(s) that runs `flutter build apk`. (flutter/flutter#158966) 2024-11-15 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 4.2.1 to 4.2.2 (flutter/flutter#157473) 2024-11-15 [email protected] Try running historically flaky tests first to make `flutter build apk` health tests time out more often? (flutter/flutter#158967) 2024-11-15 [email protected] [ tool ] Don't throw StateError when DDS fails to start (flutter/flutter#158744) 2024-11-14 [email protected] Create merge_queue.md (flutter/flutter#158959) 2024-11-14 [email protected] Marks Mac_x64 hot_mode_dev_cycle_macos_target__benchmark to be flaky (flutter/flutter#158569) 2024-11-14 [email protected] Marks Mac_arm64 mac_desktop_impeller to be unflaky (flutter/flutter#158564) 2024-11-14 [email protected] [gen_l10n] When localizing a message, prefer placeholder definitions defined by the current locale rather than the template locale (flutter/flutter#153459) 2024-11-14 [email protected] feat: Include web 1.x.x in plugin template (flutter/flutter#156947) 2024-11-14 [email protected] hide members where possible (flutter/flutter#158492) 2024-11-14 [email protected] Move platform-specific log-reading implementation details from `ResidentRunner`/`FlutterDevice` to `DeviceLogReader` implementations (flutter/flutter#156181) 2024-11-14 [email protected] Updated document to clarify Clip Behaviour (flutter/flutter#157719) 2024-11-14 [email protected] Enable --verbose for android_plugin_skip_unsupported_test tests (flutter/flutter#158933) 2024-11-14 [email protected] Roll Packages from 26e123a to b9ac917 (5 revisions) (flutter/flutter#158938) 2024-11-14 [email protected] Add `dev_dependency` attribute to plugins in `.flutter-plugins-dependencies` (flutter/flutter#158009) 2024-11-14 [email protected] No longer pass `--verbose` to implicit `pub` calls when `flutter --verbose` is set. (flutter/flutter#158898) 2024-11-14 [email protected] Update triage flow chart for SVG packages (flutter/flutter#158670) 2024-11-14 [email protected] Add one MenuAnchor alignment test (flutter/flutter#158915) 2024-11-14 [email protected] Reland Add test for dynamic_content_color.0.dart (flutter/flutter#158547) 2024-11-14 [email protected] Roll Flutter Engine from e97b148e796d to 619804c0fbb7 (1 revision) (flutter/flutter#158905) 2024-11-14 [email protected] Roll Flutter Engine from 82940a9aa714 to e97b148e796d (1 revision) (flutter/flutter#158901) 2024-11-14 [email protected] Move explicit package dependencies to a feature flag (flutter/flutter#158016) 2024-11-14 [email protected] Try with `bringup: true` debugging why `flutter build apk` often times out. (flutter/flutter#158895) 2024-11-14 [email protected] Add constraint options to `SearchAnchor` suggestions builder (flutter/flutter#148856) 2024-11-14 [email protected] Adjusts the Hindi TimeOfDayFormat to display in a LTR orientation in localizations. (flutter/flutter#157998) 2024-11-14 [email protected] Fix update order of SliverAppBar (flutter/flutter#158159) 2024-11-13 [email protected] #154792 - CupertinoActionSheetAction cursor doesn't change to clickable on desktop (flutter/flutter#158470) 2024-11-13 [email protected] Adds a skip message for analyzer (flutter/flutter#158890) 2024-11-13 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Marks Mac_arm64_ios hot_mode_dev_cycle_ios__benchmark to be flaky (#158242)" (flutter/flutter#158891) 2024-11-13 [email protected] [SwiftPM] Move the logic for SwiftPM enablement to the platform project (flutter/flutter#158213) 2024-11-13 [email protected] Temporarily skip flutter build apk for native_assets tests. (flutter/flutter#158880) 2024-11-13 [email protected] docs: include Human Interface haptic information in HapticFeedback (flutter/flutter#158587) 2024-11-13 [email protected] Roll Flutter Engine from db3e5af2ca22 to 82940a9aa714 (2 revisions) (flutter/flutter#158799) 2024-11-13 [email protected] Stream the output of `flutter build` for debugging. (flutter/flutter#158757) 2024-11-13 [email protected] "Fix failing checks" wiki page for new contributors (flutter/flutter#154629) 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. ...

…57719)

update documentation on clipBehavior

fd3b099

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

This comment was marked as resolved.

Sign in to view

added example on clipBehavior

5113336

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

Neutrino2711 and others added 4 commits October 31, 2024 12:20

Merge branch 'master' into update-documentation

69c23ef

Trigger CI

af772ab

added example

a7dc7e3

Merge branch 'master' into update-documentation

001cf0a

Neutrino2711 requested a review from nate-thegrate October 31, 2024 11:17

Merge branch 'master' into update-documentation

f3f9d86

nate-thegrate reviewed Oct 31, 2024

View reviewed changes

Neutrino2711 added 3 commits November 1, 2024 17:05

added test for clipping example

68de1c7

Merge remote-tracking branch 'upstream/master' into update-documentation

549912e

Merge branch 'update-documentation' of https://github.com/Neutrino271…

47268f2

…1/flutter into update-documentation

nate-thegrate reviewed Nov 1, 2024

View reviewed changes

Apply suggestions from code review

f6a1ce1

Co-authored-by: Nate Wilson <[email protected]>

Merge branch 'master' into update-documentation

6535d48

nate-thegrate approved these changes Nov 1, 2024

View reviewed changes

nate-thegrate reviewed Nov 1, 2024

View reviewed changes

examples/api/lib/widgets/sliver/decorated_sliver.1.dart Outdated Show resolved Hide resolved

Apply suggestions from code review

ba50b4d

Co-authored-by: Nate Wilson <[email protected]>

chunhtai self-requested a review November 5, 2024 23:13

chunhtai approved these changes Nov 13, 2024

View reviewed changes

examples/api/lib/widgets/sliver/decorated_sliver.1.dart Outdated Show resolved Hide resolved

Neutrino2711 and others added 2 commits November 14, 2024 01:28

Apply suggestions from code review

768a8b8

Co-authored-by: chunhtai <[email protected]>

Merge branch 'master' into update-documentation

7173b46

chunhtai reviewed Nov 13, 2024

View reviewed changes

added readability changes

7495c69

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 14, 2024

Merge branch 'master' into update-documentation

3f41392

auto-submit bot merged commit 4b818b5 into flutter:master Nov 14, 2024
78 checks passed

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 14, 2024

engine-flutter-autoroll mentioned this pull request Nov 15, 2024

Roll Flutter from ed553d10cf63 to 256359194e2b (37 revisions) flutter/packages#8104

Closed

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

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

9bcafd2

…57719)

engine-flutter-autoroll mentioned this pull request Nov 15, 2024

Roll Flutter from ed553d10cf63 to c4c8f6d2bd79 (39 revisions) flutter/packages#8105

Closed

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

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

05e1a69

…57719)

engine-flutter-autoroll mentioned this pull request Nov 15, 2024

Roll Flutter from ed553d10cf63 to 0e2d55e0e7b2 (40 revisions) flutter/packages#8106

Merged

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

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

e31754e

…57719)

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

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

47b3427

…57719)

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

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

96eaa16

…57719)

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

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

212ec96

…57719)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

3cc1c1a

…57719)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025

4b818b5 Updated document to clarify Clip Behaviour (flutter/flutter#1…

818e51b

…57719)

tirth-patel-nc mentioned this pull request May 12, 2025

DecoratedSliver could benefit from example that turns off clip behavior on parent scrollview #156819

Closed

Updated document to clarify Clip Behaviour #157719

Updated document to clarify Clip Behaviour #157719

Uh oh!

Conversation

Neutrino2711 commented Oct 28, 2024

Pre-launch Checklist

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Neutrino2711 commented Oct 30, 2024

Uh oh!

nate-thegrate commented Oct 30, 2024

Uh oh!

Neutrino2711 commented Oct 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nate-thegrate left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Neutrino2711 commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nate-thegrate left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Neutrino2711 commented Nov 1, 2024

Uh oh!

nate-thegrate left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nate-thegrate commented Nov 2, 2024

Uh oh!

Neutrino2711 commented Nov 4, 2024

Uh oh!

nate-thegrate commented Nov 4, 2024

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chunhtai Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Neutrino2711 commented Oct 31, 2024 •

edited

Loading

Neutrino2711 commented Nov 1, 2024 •

edited

Loading