Repository navigation
Conversation
TextField.decoration's dartdoc did not mention that the decoration passed here is combined with the ambient InputDecorationTheme via InputDecoration.applyDefaults, rather than replacing it. That makes it non-obvious why, for example, a theme-provided border survives an InputDecoration that simply omits one. Document the merge and point at the explicit opt-out. Addresses the documentation half of flutter#159629
|
This pull request contains changes to Material or Cupertino, which are currently frozen in this repository. Changes should be made in Please refer to #188444 for instructions. |
github-actions
Bot
added
a: text input
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the decoration property of TextField to clarify how it merges with the ambient InputDecorationTheme. Feedback was provided to correct an inaccurate reference to a non-existent InputDecorationTheme.of method, suggesting instead to refer directly to the ambient ThemeData.inputDecorationTheme.
Comment on lines
+427
to
+433
| /// This decoration does not replace the ambient [InputDecorationTheme], it is | ||
| /// merged with it by [InputDecoration.applyDefaults]. Only the properties | ||
| /// that are left null here take their value from [InputDecorationTheme.of], | ||
| /// which in turn defaults to [ThemeData.inputDecorationTheme]. So, for | ||
| /// example, when the theme specifies a border, passing an [InputDecoration] | ||
| /// that leaves [InputDecoration.border] null does not remove that border; | ||
| /// pass `border: InputBorder.none` to opt out of it explicitly. |
Contributor
There was a problem hiding this comment.
There is no InputDecorationTheme.of method in Flutter. The ambient input decoration theme is retrieved via Theme.of(context).inputDecorationTheme. It is clearer and more accurate to refer directly to the ambient [ThemeData.inputDecorationTheme].
/// This decoration does not replace the ambient [InputDecorationTheme], it is
/// merged with it by [InputDecoration.applyDefaults]. Only the properties
/// that are left null here take their value from the ambient
/// [ThemeData.inputDecorationTheme]. So, for example, when the theme specifies
/// a border, passing an [InputDecoration] that leaves [InputDecoration.border]
/// null does not remove that border; pass `border: InputBorder.none` to opt
/// out of it explicitly.
10 tasks done
Author
|
Closing in favour of flutter/packages#12493 — as the code-freeze bot notes, Material changes now belong in |
auto-submit Bot
pushed a commit
to flutter/packages
that referenced
this pull request
Sep 29, 2026
…DecorationTheme (#12493) `TextField.decoration`'s dartdoc describes what the decoration draws, but never mentions that the value passed here is *combined* with the ambient `InputDecorationTheme` rather than replacing it. `TextField` builds its effective decoration with `InputDecoration.applyDefaults` (`packages/material_ui/lib/src/text_field.dart`), and `applyDefaults` only substitutes properties that are null on the incoming `InputDecoration` — including `border: border ?? theme.border` (`packages/material_ui/lib/src/input_decorator.dart`). So a theme-provided border survives an `InputDecoration` that simply omits one, which is surprising if you read the property docs alone. That confusion is what flutter/flutter#159629 reports. This adds a paragraph to the `decoration` property documenting the merge and pointing at the explicit opt-out (`InputBorder.none`). This covers the documentation half of flutter/flutter#159629. The issue also proposes a `mergeWithTheme`-style flag on `InputDecoration`; that is an API proposal and is deliberately left out of this PR, so the issue should stay open. Originally opened against `flutter/flutter` as flutter/flutter#191260, and moved here after the code-freeze bot pointed out that Material changes now belong in `material_ui`. *Documentation-only change; no behavior change and no new tests.*
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
TextField.decoration's dartdoc describes what the decoration draws, but never mentions that the value passed here is combined with the ambientInputDecorationThemerather than replacing it.TextFieldbuilds its effective decoration withInputDecoration.applyDefaults:https://github.com/flutter/flutter/blob/7deb8a4d/packages/flutter/lib/src/material/text_field.dart#L1208-L1210
and
applyDefaultsonly substitutes properties that are null on the incomingInputDecoration(includingborder: border ?? theme.border). So a theme-provided border survives anInputDecorationthat simply omits one, which is surprising if you read the property docs alone — that confusion is what #159629 reports.This adds a paragraph to the
decorationproperty documenting the merge and pointing at the explicit opt-out (border: InputBorder.none).This covers the documentation half of #159629. The issue also proposes a
mergeWithTheme-style flag onInputDecoration; that is an API proposal and is deliberately left out of this PR, so the issue should stay open.Documentation-only change; no behavior change and no new tests.
Pre-launch Checklist
///).