Improve InputDecoration.errorMaxLines documentation #156468
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
justinmc
approved these changes
Oct 10, 2024
Contributor
justinmc
left a comment
There was a problem hiding this comment.
LGTM with nits 👍
Thanks for actually filing this PR after all the discussion in the issue.
| /// Defaults to null, which means that the [helperText] is not limited. | ||
| /// Defaults to null, which means that soft line breaks in [helperText] are | ||
| /// truncated with an ellipse while hard line breaks are respected. | ||
| /// For example, an [helperText] that overflows the width of the field will be |
| /// Defaults to null, which means that soft line breaks in [helperText] are | ||
| /// truncated with an ellipse while hard line breaks are respected. | ||
| /// For example, an [helperText] that overflows the width of the field will be | ||
| /// truncated with an ellipse. However, an [helperText] with explicit linebreak |
| /// | ||
| /// To get a long [helperText] wrapping, either set [helperMaxLines] or use | ||
| /// [helper] which offers more flexibility, for instance it can be set to a | ||
| /// Text widget with a specific overflow value. |
Contributor
There was a problem hiding this comment.
Nit: Maybe link Text: [Text].
| /// truncated with an ellipse. However, an [helperText] with explicit linebreak | ||
| /// characters (\n) will display on multiple lines. | ||
| /// | ||
| /// To get a long [helperText] wrapping, either set [helperMaxLines] or use |
Contributor
There was a problem hiding this comment.
Nit, maybe this sounds better: "To get a long [helperText] wrapping" => "To cause a long [helperText] to wrap"
Same for errorText below.
| /// characters (\n) will display on multiple lines. | ||
| /// | ||
| /// To get a long [helperText] wrapping, either set [helperMaxLines] or use | ||
| /// [helper] which offers more flexibility, for instance it can be set to a |
Contributor
There was a problem hiding this comment.
Nit: Just an idea to break up this long sentence: "which offers more flexibility, for instance it can" => "which offers more flexibility. For instance, it can"
406dc53 to
af90bfe
Compare
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 13, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 13, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 14, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 16, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 17, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Feb 12, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Feb 13, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Feb 13, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 6, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves the
InputDecoration.errorMaxLinesandInputDecoration.helperMaxLinesdocumentations to explain when wrapping and ellipsing are applied.Related Issue
Fixes InputDecoration.errorMaxLines's documentation does not match behavior.