Skip to content

[Docs] Clarify that Flex does not wrap #113404

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.

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

Merged
merged 1 commit into from
Oct 17, 2022
Merged

Conversation

TzviPM
Copy link
Contributor

@TzviPM TzviPM commented Oct 13, 2022

The Flex widget, despite its name, differs from the behaviour of flexbox in a web setting. In particular, people coming from a web background may be used to using flex-wrap: wrap from CSS, which Flex does not support. This PR attempts to elide this confusion by pointing to the Wrap widget from the documentation for Flex.

Although these additions are aiming to avoid confusion with flexbox, I was careful not to specifically mention the web use case, so as not to further confuse anyone who wouldn't have otherwise been confused.

Fixes #113403 113403

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.

@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@flutter-dashboard flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Oct 13, 2022
@TzviPM
Copy link
Contributor Author

TzviPM commented Oct 13, 2022

My editor seems to have auto formatted the code here. If desired, I will amend this tomorrow using "save without formatting"

@TzviPM
Copy link
Contributor Author

TzviPM commented Oct 13, 2022

Also, re:tests, these changes are docs-only.

Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

@TzviPM TzviPM merged commit 5d078ba into flutter:master Oct 17, 2022
@TzviPM TzviPM deleted the docs-flex-wrap branch October 17, 2022 21:07
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Oct 18, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Oct 18, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Oct 18, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework flutter/packages/flutter repository. See also f: labels.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flex widget can be confusing when coming from a web background
2 participants