GrxInputDecoration class

Inheritance

Constructors

GrxInputDecoration({String? labelText, String? hintText, bool? alignLabelWithHint = false, EdgeInsetsGeometry? contentPadding, int? hintMaxLines, String? errorText, Widget? prefix, BoxConstraints? suffixIconConstraints, void onClear()?, bool enabled = true, bool showClearButton = false, Widget? suffix})

Properties

alignLabelWithHint → bool?
Typically set to true when the InputDecorator contains a multiline TextField (TextField.maxLines is null or > 1) to override the default behavior of aligning the label with the center of the TextField.
finalinherited
border → InputBorder?
The shape of the border to draw around the decoration's container.
finalinherited
constraints → BoxConstraints?
Defines minimum and maximum sizes for the InputDecorator.
finalinherited
contentPadding → EdgeInsetsGeometry?
The padding for the input decoration's container.
finalinherited
counter → Widget?
Optional custom counter widget to go in the place otherwise occupied by counterText. If this property is non null, then counterText is ignored.
finalinherited
counterStyle → TextStyle?
The style to use for the counterText.
finalinherited
counterText → String?
Optional text to place below the line as a character count.
finalinherited
disabledBorder → InputBorder?
The border to display when the InputDecorator is disabled and is not showing an error.
finalinherited
enabled → bool
If false the opacity of the visual elements is reduced, including helperText,errorText, and counterText.
finalinherited
enabledBorder → InputBorder?
The border to display when the InputDecorator is enabled and is not showing an error.
finalinherited
error → Widget?
Optional widget that appears below the InputDecorator.child and the border.
finalinherited
errorBorder → InputBorder?
The border to display when the InputDecorator does not have the focus and is showing an error.
finalinherited
errorMaxLines → int?
The maximum number of lines the errorText can occupy.
finalinherited
errorStyle → TextStyle?
The style to use for the InputDecoration.errorText.
finalinherited
errorText → String?
Text that appears below the InputDecorator.child and the border.
finalinherited
fillColor → Color?
The base fill color of the decoration's container color.
finalinherited
filled → bool?
If true the decoration's container is filled with fillColor.
finalinherited
floatingLabelAlignment → FloatingLabelAlignment?
Defines where the floating label should be displayed.
finalinherited
floatingLabelBehavior → FloatingLabelBehavior?
Defines how the floating label should behave.
finalinherited
floatingLabelStyle → TextStyle?
The style to use for InputDecoration.labelText when the label is above (i.e., vertically adjacent to) the input field.
finalinherited
focusColor → Color?
The fill color of the decoration's container when it has the input focus.
finalinherited
focusedBorder → InputBorder?
The border to display when the InputDecorator has the focus and is not showing an error.
finalinherited
focusedErrorBorder → InputBorder?
The border to display when the InputDecorator has the focus and is showing an error.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
helper → Widget?
Optional widget that appears below the InputDecorator.child.
finalinherited
helperMaxLines → int?
The maximum number of lines the helperText can occupy.
finalinherited
helperStyle → TextStyle?
The style to use for the helperText.
finalinherited
helperText → String?
Text that provides context about the InputDecorator.child's value, such as how the value will be used.
finalinherited
hint → Widget?
The widget to use in place of the hintText.
finalinherited
hintFadeDuration → Duration?
The duration of the hintText fade in and fade out animations.
finalinherited
hintMaxLines → int?
The maximum number of lines the hintText can occupy.
finalinherited
hintStyle → TextStyle?
The style to use for the hintText.
finalinherited
hintText → String?
Text that suggests what sort of input the field accepts.
finalinherited
hintTextDirection → TextDirection?
The direction to use for the hintText.
finalinherited
hoverColor → Color?
The color of the highlight for the decoration shown if the container is being hovered over by a mouse.
finalinherited
icon → Widget?
An icon to show before the input field and outside of the decoration's container.
finalinherited
iconColor → Color?
The color of the icon.
finalinherited
isCollapsed → bool?
Whether the decoration is the same size as the input field.
finalinherited
isDense → bool?
Whether the InputDecorator.child is part of a dense form (i.e., uses less vertical space).
finalinherited
label → Widget?
Optional widget that describes the input field.
finalinherited
labelStyle → TextStyle?
The style to use for InputDecoration.labelText when the label is on top of the input field.
finalinherited
labelText → String?
Optional text that describes the input field.
finalinherited
maintainHintHeight → bool
Whether the input field's height should always be greater than or equal to the height of the hintText, even if the hintText is not visible.
finalinherited
maintainHintSize → bool
Whether the input field's size should always be greater than or equal to the size of the hintText, even if the hintText is not visible.
finalinherited
onClear → void Function()?
final
prefix → Widget?
Optional widget to place on the line before the input.
finalinherited
prefixIcon → Widget?
An icon that appears before the prefix or prefixText and before the editable part of the text field, within the decoration's container.
finalinherited
prefixIconColor → Color?
Optional color of the prefixIcon
finalinherited
prefixIconConstraints → BoxConstraints?
The constraints for the prefix icon.
finalinherited
prefixStyle → TextStyle?
The style to use for the prefixText.
finalinherited
prefixText → String?
Optional text prefix to place on the line before the input.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticCounterText → String?
A semantic label for the counterText.
finalinherited
showClearButton → bool
final
suffix → Widget?
Optional widget to place on the line after the input.
finalinherited
suffixIcon → Widget?
An icon that appears after the editable part of the text field and after the suffix or suffixText, within the decoration's container.
finalinherited
suffixIconColor → Color?
Optional color of the suffixIcon.
finalinherited
suffixIconConstraints → BoxConstraints?
The constraints for the suffix icon.
finalinherited
suffixStyle → TextStyle?
The style to use for the suffixText.
finalinherited
suffixText → String?
Optional text suffix to place on the line after the input.
finalinherited
visualDensity → VisualDensity?
Defines how compact the decoration's layout will be.
finalinherited

Methods

applyDefaults(Object inputDecorationTheme) → InputDecoration
Used by widgets like TextField and InputDecorator to create a new InputDecoration with default values taken from the inputDecorationTheme.
inherited
copyWith({Widget? icon, Color? iconColor, Widget? label, String? labelText, TextStyle? labelStyle, TextStyle? floatingLabelStyle, Widget? helper, String? helperText, TextStyle? helperStyle, int? helperMaxLines, String? hintText, Widget? hint, TextStyle? hintStyle, TextDirection? hintTextDirection, Duration? hintFadeDuration, int? hintMaxLines, bool? maintainHintHeight, bool? maintainHintSize, Widget? error, String? errorText, TextStyle? errorStyle, int? errorMaxLines, FloatingLabelBehavior? floatingLabelBehavior, FloatingLabelAlignment? floatingLabelAlignment, bool? isCollapsed, bool? isDense, EdgeInsetsGeometry? contentPadding, Widget? prefixIcon, Widget? prefix, String? prefixText, BoxConstraints? prefixIconConstraints, TextStyle? prefixStyle, Color? prefixIconColor, Widget? suffixIcon, Widget? suffix, String? suffixText, TextStyle? suffixStyle, Color? suffixIconColor, BoxConstraints? suffixIconConstraints, Widget? counter, String? counterText, TextStyle? counterStyle, bool? filled, Color? fillColor, Color? focusColor, Color? hoverColor, InputBorder? errorBorder, InputBorder? focusedBorder, InputBorder? focusedErrorBorder, InputBorder? disabledBorder, InputBorder? enabledBorder, InputBorder? border, bool? enabled, String? semanticCounterText, bool? alignLabelWithHint, BoxConstraints? constraints, VisualDensity? visualDensity, SemanticsService? semanticsService}) → InputDecoration
Creates a copy of this input decoration with the given fields replaced by the new values.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited