Skip to content

Add InkWell docs on transitions and ink splash clipping#31316

Merged
shihaohong merged 10 commits intoflutter:masterfrom
shihaohong:inkwell-docs
Apr 26, 2019
Merged

Add InkWell docs on transitions and ink splash clipping#31316
shihaohong merged 10 commits intoflutter:masterfrom
shihaohong:inkwell-docs

Conversation

@shihaohong
Copy link
Contributor

Description

Added a section to the InkWell documentation highlighting that widget transitions within an InkWell widget may cause clipping or unpleasant rippling effects.

Related Issues

Fixes #5211

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require Flutter developers to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (Please read Handling breaking changes). Replace this with a link to the e-mail where you asked for input on this proposed change.
  • No, this is not a breaking change.

@shihaohong shihaohong added d: api docs Issues with https://api.flutter.dev/ f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. labels Apr 19, 2019
@shihaohong
Copy link
Contributor Author

Had an offline discussion with @HansMuller, we had misunderstood the actual source of the clipping, so I'll be playing around InkWell and an animated child that changes size before I come up with an updated description of the issue

Copy link
Contributor

@HansMuller HansMuller left a comment

Choose a reason for hiding this comment

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

LGTM with just a little more tweaking.

Incorporated code review feedback to clarify that clipping cannot be
avoided with growing animated containers. Further correct grammar.
@shihaohong shihaohong merged commit 14f2f98 into flutter:master Apr 26, 2019
@shihaohong shihaohong deleted the inkwell-docs branch May 14, 2019 17:39
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

d: api docs Issues with https://api.flutter.dev/ f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

InkWell doesn't work well in AnimatedContainer.

3 participants