MoonTextInput class

Inheritance

Constructors

MoonTextInput({bool hasFloatingLabel = false, BorderRadiusGeometry? borderRadius, Color? backgroundColor, Color? activeBorderColor, Color? errorBorderColor, Color? inactiveBorderColor, Color? errorColor, Color? hoverBorderColor, Color? textColor, Color? hintTextColor, Decoration? decoration, double? gap, double? height, double? width, Duration? transitionDuration, Curve? transitionCurve, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? helperPadding, MoonTextInputSize? textInputSize, String? errorText, String? hintText, String? initialValue, TextStyle? helperTextStyle, MoonTextInputErrorBuilder? errorBuilder, Widget? leading, Widget? trailing, Widget? helper, Key? key, TextEditingController? controller, FocusNode? focusNode, UndoHistoryController? undoController, TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization = TextCapitalization.none, TextStyle? style, StrutStyle? strutStyle, TextAlign textAlign = TextAlign.start, TextAlignVertical? textAlignVertical, TextDirection? textDirection, bool readOnly = false, bool? showCursor, bool autofocus = false, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, int? maxLines = 1, int? minLines, bool expands = false, int? maxLength, MaxLengthEnforcement? maxLengthEnforcement, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, AppPrivateCommandCallback? onAppPrivateCommand, List<TextInputFormatter>? inputFormatters, bool enabled = true, double cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, bool? cursorOpacityAnimates, Color? cursorColor, Color? cursorErrorColor, BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? enableInteractiveSelection, TextSelectionControls? selectionControls, GestureTapCallback? onTap, bool onTapAlwaysCalled = false, TapRegionCallback? onTapOutside, MouseCursor? mouseCursor, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints = const <String>[], ContentInsertionConfiguration? contentInsertionConfiguration, Clip clipBehavior = Clip.hardEdge, String? restorationId, bool scribbleEnabled = true, bool enableIMEPersonalizedLearning = true, EditableTextContextMenuBuilder? contextMenuBuilder = _defaultContextMenuBuilder, bool canRequestFocus = true, SpellCheckConfiguration? spellCheckConfiguration, TextMagnifierConfiguration? magnifierConfiguration})
Creates a Moon Design text input.
const

Properties

activeBorderColor Color?
The border color of the active or focused text input.
final
autocorrect bool
Whether to enable autocorrection.
final
autofillHints Iterable<String>?
A list of strings that helps the autofill service identify the type of this text input.
final
autofocus bool
Whether this text field should focus itself if nothing else is already focused.
final
backgroundColor Color?
The background color of the text input.
final
borderRadius BorderRadiusGeometry?
The border radius of the text input.
final
canRequestFocus bool
Determines whether this text field can request the primary focus.
final
clipBehavior Clip
The content will be clipped (or not) according to this option.
final
contentInsertionConfiguration ContentInsertionConfiguration?
Configuration of handler for media content inserted via the system input method.
final
contextMenuBuilder EditableTextContextMenuBuilder?
Builds the text selection toolbar when requested by the user.
final
controller TextEditingController?
Controls the input text.
final
cursorColor Color?
The color of the cursor.
final
cursorErrorColor Color?
The color of the cursor when the MoonTextInput is showing an error.
final
cursorHeight double?
How tall the cursor will be.
final
cursorOpacityAnimates bool?
Whether the cursor will animate from fully transparent to fully opaque during each cursor blink.
final
cursorRadius Radius?
How rounded the corners of the cursor should be.
final
cursorWidth double
How thick the cursor will be.
final
decoration Decoration?
The custom decoration of the text input.
final
dragStartBehavior DragStartBehavior
Determines the way that drag start behavior is handled.
final
enabled bool
If false the text field is "disabled": it ignores taps and its decoration is rendered in grey.
final
enableIMEPersonalizedLearning bool
Whether to enable that the IME update personalized data such as typing history and user dictionary data.
final
enableInteractiveSelection bool
Whether to enable user interface affordances for changing the text selection.
final
enableSuggestions bool
Whether to show input suggestions as the user types.
final
errorBorderColor Color?
The border color of the text input in error state.
final
errorBuilder MoonTextInputErrorBuilder?
A builder to build the text input error widget.
final
errorColor Color?
The color of the text input in error state.
final
errorText String?
The error text can be used to force text input into an error state (useful for asynchronous errors).
final
expands bool
Whether this widget's height will be sized to fill its parent.
final
focusNode FocusNode?
Defines the keyboard focus for this widget.
final
gap double?
The gap between the leading widget, text input and trailing widget.
final
hasFloatingLabel bool
Whether the text input has floating label.
final
hashCode int
The hash code for this object.
no setterinherited
height double?
The height of the text input (does not include the space taken by MoonTextInput.errorBuilder).
final
helper Widget?
The widget to display below the text input. Not displayed in error state.
final
helperPadding EdgeInsetsGeometry?
The padding of the helper and errorBuilder widget.
final
helperTextStyle TextStyle?
The text style of the helper widget or error state text.
final
hintText String?
The hint text to display in the text area.
final
hintTextColor Color?
The text color of the text input hint.
final
hoverBorderColor Color?
The border color of the text input on hover.
final
inactiveBorderColor Color?
The border color of the inactive text input.
final
initialValue String?
The initial value of the text input.
final
inputFormatters List<TextInputFormatter>?
Optional input validation and formatting overrides.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance Brightness?
The appearance of the keyboard.
final
keyboardType TextInputType
The type of keyboard to use for editing the text.
final
leading Widget?
The widget to display before the text input.
final
magnifierConfiguration TextMagnifierConfiguration?
This magnifying glass is useful for scenarios on mobile devices where the user's finger may be covering part of the screen where a granular action is being performed, such as navigating a small cursor with a drag gesture, on an image or text.
final
maxLength int?
The maximum number of characters (unicode grapheme clusters) to allow in the text field.
final
maxLengthEnforcement MaxLengthEnforcement?
Determines how the maxLength limit should be enforced.
final
maxLines int?
The maximum number of lines to show at one time, wrapping if necessary.
final
minLines int?
The minimum number of lines to occupy when the content spans fewer lines.
final
mouseCursor MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
obscureText bool
Whether to hide the text being edited (e.g., for passwords).
final
obscuringCharacter String
Character used for obscuring text if obscureText is true.
final
onAppPrivateCommand AppPrivateCommandCallback?
This is used to receive a private command from the input method.
final
onChanged ValueChanged<String>?
Called when the user initiates a change to the TextField's value: when they have inserted or deleted text.
final
onEditingComplete VoidCallback?
Called when the user submits editable content (e.g., user presses the "done" button on the keyboard).
final
onSubmitted ValueChanged<String>?
Called when the user indicates that they are done editing the text in the field.
final
onTap GestureTapCallback?
Called for the first tap in a series of taps.
final
onTapAlwaysCalled bool
Whether onTap should be called for every tap.
final
onTapOutside TapRegionCallback?
Called for each tap that occurs outside of theTextFieldTapRegion group when the text field is focused.
final
padding EdgeInsetsGeometry?
The padding of the text input.
final
readOnly bool
Whether the text can be changed.
final
restorationId String?
Restoration ID to save and restore the state of the text field.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scribbleEnabled bool
Whether iOS 14 Scribble features are enabled for this widget.
final
scrollController ScrollController?
The ScrollController to use when vertically scrolling the input.
final
scrollPadding EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view.
final
scrollPhysics ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input.
final
selectionControls TextSelectionControls?
Optional delegate for building the text selection handles.
final
selectionEnabled bool
Same as enableInteractiveSelection.
no setter
selectionHeightStyle BoxHeightStyle
Controls how tall the selection highlight boxes are computed to be.
final
selectionWidthStyle BoxWidthStyle
Controls how wide the selection highlight boxes are computed to be.
final
showCursor bool?
Configuration of toolbar options.
final
smartDashesType SmartDashesType
Whether to allow the platform to automatically format dashes.
final
smartQuotesType SmartQuotesType
Whether to allow the platform to automatically format quotes.
final
spellCheckConfiguration SpellCheckConfiguration?
Configuration that details how spell check should be performed.
final
strutStyle StrutStyle?
The strut style used for the vertical layout.
final
style TextStyle?
The text style of the input text.
final
textAlign TextAlign
How the text should be aligned horizontally.
final
textAlignVertical TextAlignVertical?
How the text should be aligned vertically.
final
textCapitalization TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard.
final
textColor Color?
The text color of the text input.
final
textDirection TextDirection?
The directionality of the text.
final
textInputAction TextInputAction?
The type of action button to use for the keyboard.
final
textInputSize MoonTextInputSize?
The size of the text input.
final
trailing Widget?
The widget to display after the text input.
final
transitionCurve Curve?
The curve of the text input transition animation (enable and disable).
final
transitionDuration Duration?
The duration of the text input transition animation (enable and disable).
final
undoController UndoHistoryController?
Controls the undo state.
final
width double?
The width of the text input.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<MoonTextInput>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

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

Constants

noMaxLength → const int
If maxLength is set to this value, only the "current input length" part of the character counter is displayed.