Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in
Toggle navigation
F
Front-End
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
abdullh.alsoleman
Front-End
Commits
b1094788
Unverified
Commit
b1094788
authored
Sep 09, 2022
by
Greg Spencer
Committed by
GitHub
Sep 09, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix documentation for InputDecoration.focusColor (#111290)
parent
80711d1e
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
48 additions
and
52 deletions
+48
-52
input_decorator.dart
packages/flutter/lib/src/material/input_decorator.dart
+48
-52
No files found.
packages/flutter/lib/src/material/input_decorator.dart
View file @
b1094788
...
@@ -2663,7 +2663,7 @@ class InputDecoration {
...
@@ -2663,7 +2663,7 @@ class InputDecoration {
/// When the [InputDecoration.labelText] is on top of the input field, the
/// When the [InputDecoration.labelText] is on top of the input field, the
/// text uses the [labelStyle] instead.
/// text uses the [labelStyle] instead.
///
///
/// If
[floatingLabelStyle]
is a [MaterialStateTextStyle], then the effective
/// If
`floatingLabelStyle`
is a [MaterialStateTextStyle], then the effective
/// text style can depend on the [MaterialState.focused] state, i.e.
/// text style can depend on the [MaterialState.focused] state, i.e.
/// if the [TextField] is focused or not.
/// if the [TextField] is focused or not.
///
///
...
@@ -2677,7 +2677,7 @@ class InputDecoration {
...
@@ -2677,7 +2677,7 @@ class InputDecoration {
/// It's possible to override the label style for just the error state, or
/// It's possible to override the label style for just the error state, or
/// just the default state, or both.
/// just the default state, or both.
///
///
/// In this example the
[floatingLabelStyle]
is specified with a
/// In this example the
`floatingLabelStyle`
is specified with a
/// [MaterialStateProperty] which resolves to a text style whose color depends
/// [MaterialStateProperty] which resolves to a text style whose color depends
/// on the decorator's error state.
/// on the decorator's error state.
///
///
...
@@ -2696,7 +2696,7 @@ class InputDecoration {
...
@@ -2696,7 +2696,7 @@ class InputDecoration {
/// The style to use for the [helperText].
/// The style to use for the [helperText].
///
///
/// If
[helperStyle]
is a [MaterialStateTextStyle], then the effective
/// If
`helperStyle`
is a [MaterialStateTextStyle], then the effective
/// text style can depend on the [MaterialState.focused] state, i.e.
/// text style can depend on the [MaterialState.focused] state, i.e.
/// if the [TextField] is focused or not.
/// if the [TextField] is focused or not.
final
TextStyle
?
helperStyle
;
final
TextStyle
?
helperStyle
;
...
@@ -2724,7 +2724,7 @@ class InputDecoration {
...
@@ -2724,7 +2724,7 @@ class InputDecoration {
/// The style to use for the [hintText].
/// The style to use for the [hintText].
///
///
/// If
[hintStyle]
is a [MaterialStateTextStyle], then the effective
/// If
`hintStyle`
is a [MaterialStateTextStyle], then the effective
/// text style can depend on the [MaterialState.focused] state, i.e.
/// text style can depend on the [MaterialState.focused] state, i.e.
/// if the [TextField] is focused or not.
/// if the [TextField] is focused or not.
///
///
...
@@ -2838,9 +2838,7 @@ class InputDecoration {
...
@@ -2838,9 +2838,7 @@ class InputDecoration {
/// The padding for the input decoration's container.
/// The padding for the input decoration's container.
///
///
/// The decoration's container is the area which is filled if [filled] is true
/// {@macro flutter.material.input_decorator.container_description}
/// and bordered per the [border]. It's the area adjacent to [icon] and above
/// the widgets that contain [helperText], [errorText], and [counterText].
///
///
/// By default the `contentPadding` reflects [isDense] and the type of the
/// By default the `contentPadding` reflects [isDense] and the type of the
/// [border].
/// [border].
...
@@ -2887,10 +2885,7 @@ class InputDecoration {
...
@@ -2887,10 +2885,7 @@ class InputDecoration {
/// )
/// )
/// ```
/// ```
///
///
/// The decoration's container is the area which is filled if [filled] is
/// {@macro flutter.material.input_decorator.container_description}
/// true and bordered per the [border]. It's the area adjacent to
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
///
///
/// The prefix icon alignment can be changed using [Align] with a fixed `widthFactor` and
/// The prefix icon alignment can be changed using [Align] with a fixed `widthFactor` and
/// `heightFactor`.
/// `heightFactor`.
...
@@ -2923,7 +2918,7 @@ class InputDecoration {
...
@@ -2923,7 +2918,7 @@ class InputDecoration {
///
///
/// {@tool dartpad}
/// {@tool dartpad}
/// This example shows the differences between two `TextField` widgets when
/// This example shows the differences between two `TextField` widgets when
///
[prefixIconConstraints]
is set to the default value and when one is not.
///
`prefixIconConstraints`
is set to the default value and when one is not.
///
///
/// Note that [isDense] must be set to true to be able to
/// Note that [isDense] must be set to true to be able to
/// set the constraints smaller than 48px.
/// set the constraints smaller than 48px.
...
@@ -2942,9 +2937,9 @@ class InputDecoration {
...
@@ -2942,9 +2937,9 @@ class InputDecoration {
/// front of the input. The widget's baseline is lined up with the input
/// front of the input. The widget's baseline is lined up with the input
/// baseline.
/// baseline.
///
///
/// Only one of
[prefix]
and [prefixText] can be specified.
/// Only one of
`prefix`
and [prefixText] can be specified.
///
///
/// The
[prefix]
appears after the [prefixIcon], if both are specified.
/// The
`prefix`
appears after the [prefixIcon], if both are specified.
///
///
/// See also:
/// See also:
///
///
...
@@ -2957,9 +2952,9 @@ class InputDecoration {
...
@@ -2957,9 +2952,9 @@ class InputDecoration {
/// The prefix text is not returned as part of the user's input.
/// The prefix text is not returned as part of the user's input.
///
///
/// If a more elaborate prefix is required, consider using [prefix] instead.
/// If a more elaborate prefix is required, consider using [prefix] instead.
/// Only one of [prefix] and
[prefixText]
can be specified.
/// Only one of [prefix] and
`prefixText`
can be specified.
///
///
/// The
[prefixText]
appears after the [prefixIcon], if both are specified.
/// The
`prefixText`
appears after the [prefixIcon], if both are specified.
///
///
/// See also:
/// See also:
///
///
...
@@ -2968,7 +2963,7 @@ class InputDecoration {
...
@@ -2968,7 +2963,7 @@ class InputDecoration {
/// The style to use for the [prefixText].
/// The style to use for the [prefixText].
///
///
/// If
[prefixStyle]
is a [MaterialStateTextStyle], then the effective
/// If
`prefixStyle`
is a [MaterialStateTextStyle], then the effective
/// text style can depend on the [MaterialState.focused] state, i.e.
/// text style can depend on the [MaterialState.focused] state, i.e.
/// if the [TextField] is focused or not.
/// if the [TextField] is focused or not.
///
///
...
@@ -2983,7 +2978,7 @@ class InputDecoration {
...
@@ -2983,7 +2978,7 @@ class InputDecoration {
///
///
/// Defaults to [iconColor]
/// Defaults to [iconColor]
///
///
/// If
[prefixIconColor]
is a [MaterialStateColor], then the effective
/// If
`prefixIconColor`
is a [MaterialStateColor], then the effective
/// color can depend on the [MaterialState.focused] state, i.e.
/// color can depend on the [MaterialState.focused] state, i.e.
/// if the [TextField] is focused or not.
/// if the [TextField] is focused or not.
final
Color
?
prefixIconColor
;
final
Color
?
prefixIconColor
;
...
@@ -3040,9 +3035,9 @@ class InputDecoration {
...
@@ -3040,9 +3035,9 @@ class InputDecoration {
/// otherwise be specified using [suffixText], or to add a custom widget after
/// otherwise be specified using [suffixText], or to add a custom widget after
/// the input. The widget's baseline is lined up with the input baseline.
/// the input. The widget's baseline is lined up with the input baseline.
///
///
/// Only one of
[suffix]
and [suffixText] can be specified.
/// Only one of
`suffix`
and [suffixText] can be specified.
///
///
/// The
[suffix]
appears before the [suffixIcon], if both are specified.
/// The
`suffix`
appears before the [suffixIcon], if both are specified.
///
///
/// See also:
/// See also:
///
///
...
@@ -3055,9 +3050,9 @@ class InputDecoration {
...
@@ -3055,9 +3050,9 @@ class InputDecoration {
/// The suffix text is not returned as part of the user's input.
/// The suffix text is not returned as part of the user's input.
///
///
/// If a more elaborate suffix is required, consider using [suffix] instead.
/// If a more elaborate suffix is required, consider using [suffix] instead.
/// Only one of [suffix] and
[suffixText]
can be specified.
/// Only one of [suffix] and
`suffixText`
can be specified.
///
///
/// The
[suffixText]
appears before the [suffixIcon], if both are specified.
/// The
`suffixText`
appears before the [suffixIcon], if both are specified.
///
///
/// See also:
/// See also:
///
///
...
@@ -3066,9 +3061,9 @@ class InputDecoration {
...
@@ -3066,9 +3061,9 @@ class InputDecoration {
/// The style to use for the [suffixText].
/// The style to use for the [suffixText].
///
///
/// If
[suffixStyle] is a [MaterialStateTextStyle], then the effective
/// If
`suffixStyle` is a [MaterialStateTextStyle], then the effective text
///
text style can depend on the [MaterialState.focused] state, i.e.
///
style can depend on the [MaterialState.focused] state, i.e. if the
///
if the
[TextField] is focused or not.
/// [TextField] is focused or not.
///
///
/// If null, defaults to the [hintStyle].
/// If null, defaults to the [hintStyle].
///
///
...
@@ -3077,7 +3072,7 @@ class InputDecoration {
...
@@ -3077,7 +3072,7 @@ class InputDecoration {
/// * [prefixStyle], the equivalent but on the leading edge.
/// * [prefixStyle], the equivalent but on the leading edge.
final
TextStyle
?
suffixStyle
;
final
TextStyle
?
suffixStyle
;
/// Optional color of the
suffixIcon
/// Optional color of the
[suffixIcon].
///
///
/// Defaults to [iconColor]
/// Defaults to [iconColor]
///
///
...
@@ -3130,7 +3125,7 @@ class InputDecoration {
...
@@ -3130,7 +3125,7 @@ class InputDecoration {
/// The style to use for the [counterText].
/// The style to use for the [counterText].
///
///
/// If
[counterStyle]
is a [MaterialStateTextStyle], then the effective
/// If
`counterStyle`
is a [MaterialStateTextStyle], then the effective
/// text style can depend on the [MaterialState.focused] state, i.e.
/// text style can depend on the [MaterialState.focused] state, i.e.
/// if the [TextField] is focused or not.
/// if the [TextField] is focused or not.
///
///
...
@@ -3142,52 +3137,53 @@ class InputDecoration {
...
@@ -3142,52 +3137,53 @@ class InputDecoration {
/// When [InputDecorator.isHovering] is true, the [hoverColor] is also blended
/// When [InputDecorator.isHovering] is true, the [hoverColor] is also blended
/// into the final fill color.
/// into the final fill color.
///
///
/// Typically this field set to true if [border] is an
/// Typically this field set to true if [border] is an [UnderlineInputBorder].
/// [UnderlineInputBorder].
///
///
/// The decoration's container is the area which is filled if [filled] is
/// {@template flutter.material.input_decorator.container_description}
/// true and bordered per the [border]. It's the area adjacent to
/// The decoration's container is the area which is filled if `filled` is true
/// [icon] and above the widgets that contain [helperText],
/// and bordered per the [border]. It's the area adjacent to [icon] and above
/// [errorText], and [counterText].
/// the widgets that contain [helperText], [errorText], and [counterText].
/// {@endtemplate}
///
///
/// This property is false by default.
/// This property is false by default.
final
bool
?
filled
;
final
bool
?
filled
;
/// The base fill color of the decoration's container color.
/// The base fill color of the decoration's container color.
///
///
/// When [InputDecorator.isHovering] is true, the
/// When [InputDecorator.isHovering] is true, the
[hoverColor] is also blended
///
[hoverColor] is also blended
into the final fill color.
/// into the final fill color.
///
///
/// By default the fillColor is based on the current [Theme].
/// By default the `fillColor` is based on the current
/// [InputDecorationTheme.fillColor].
///
///
/// The decoration's container is the area which is filled if [filled] is true
/// {@macro flutter.material.input_decorator.container_description}
/// and bordered per the [border]. It's the area adjacent to [icon] and above
/// the widgets that contain [helperText], [errorText], and [counterText].
final
Color
?
fillColor
;
final
Color
?
fillColor
;
///
By default the [focusColor] is based on the current [Theme]
.
///
The fill color of the decoration's container when it has the input focus
.
///
///
/// The decoration's container is the area which is filled if [filled] is
/// By default the `focusColor` is based on the current
/// true and bordered per the [border]. It's the area adjacent to
/// [InputDecorationTheme.focusColor].
/// [icon] and above the widgets that contain [helperText],
///
/// [errorText], and [counterText].
/// This `focusColor` is ignored by [TextField] and [TextFormField] because
/// they don't respond to focus changes by changing their decorator's
/// container color, they respond by changing their border to the
/// [focusedBorder], which you can change the color of.
///
/// {@macro flutter.material.input_decorator.container_description}
final
Color
?
focusColor
;
final
Color
?
focusColor
;
/// The color of the
focus
highlight for the decoration shown if the container
/// The color of the highlight for the decoration shown if the container
/// is being hovered over by a mouse.
/// is being hovered over by a mouse.
///
///
/// If [filled] is true, the
color is blended with [fillColor] and fills the
/// If [filled] is true, the
`hoverColor` is blended with [fillColor] and
/// decoration's container.
///
fills the
decoration's container.
///
///
/// If [filled] is false, and [InputDecorator.isFocused] is false, the color
/// If [filled] is false, and [InputDecorator.isFocused] is false, the color
/// is blended over the [enabledBorder]'s color.
/// is blended over the [enabledBorder]'s color.
///
///
/// By default the
[hoverColor]
is based on the current [Theme].
/// By default the
`hoverColor`
is based on the current [Theme].
///
///
/// The decoration's container is the area which is filled if [filled] is
/// {@macro flutter.material.input_decorator.container_description}
/// true and bordered per the [border]. It's the area adjacent to
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
final
Color
?
hoverColor
;
final
Color
?
hoverColor
;
/// The border to display when the [InputDecorator] does not have the focus and
/// The border to display when the [InputDecorator] does not have the focus and
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment