UTextField class

Text field with label, validator, clear button, password eye, formatters and u's layout options. UTextField(labelText: "Email", validator: UValidators.email(), keyboardType: TextInputType.emailAddress)

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• UTextField

Available extensions

• WidgetsExtension

Constructors

UTextField({Key? key, String? text, String? labelText, String? hintText, EdgeInsetsGeometry? contentPadding, double? fontSize, TextEditingController? controller, VoidCallback? onTap, String? validator(String?)?, Widget? prefix, Widget? suffix, dynamic onSave(String? value)?, String? initialValue, double? textHeight, ValueChanged<String>? onChanged, ValueChanged<String>? onFieldSubmitted, int? maxLength, List<TextInputFormatter>? formatters, List<String>? autoFillHints, bool readOnly = false, TextInputType keyboardType = TextInputType.text, bool obscureText = false, int lines = 1, bool hasClearButton = false, bool required = false, bool isDense = false, TextAlign textAlign = TextAlign.start, Color? textColor, FocusNode? focusNode, EdgeInsetsGeometry? margin, bool visible = true, double? opacity, BoxFit? fit, AlignmentGeometry fitAlignment = Alignment.center, double? scale, double? rotate, Offset? translate, bool center = false, bool safeArea = false, int? expanded, int? flexible, bool positioned = false, double? left, double? top, double? right, double? bottom, double? positionedWidth, double? positionedHeight, double? borderRadius, FloatingLabelBehavior? floatingLabelBehavior})

const

Properties

autoFillHints → List<String>?

Autofill hints (email, password, oneTimeCode…) for password managers and SMS codes.

final

borderRadius → double?

Corner radius.

final

bottom → double?

Distance from the bottom when positioned in a Stack.

final

center → bool

Centers it in the available space.

final

contentPadding → EdgeInsetsGeometry?

Padding inside the field.

final

controller → TextEditingController?

Controller to read or change it from code.

final

expanded → int?

Flex value to fill the remaining space in a Row/Column (null = off).

final

fit → BoxFit?

How the content fits its box (BoxFit).

final

fitAlignment → AlignmentGeometry

Alignment inside the box when it does not fill it.

final

flexible → int?

Flex value to shrink in a Row/Column when space is tight (null = off).

final

floatingLabelBehavior → FloatingLabelBehavior?

When the label floats above the field.

final

focusNode → FocusNode?

Focus node to control keyboard focus.

final

fontSize → double?

Font size.

final

formatters → List<TextInputFormatter>?

Input formatters, e.g. UTextFieldFormatter / digits only.

final

hasClearButton → bool

Shows an × button that clears the text.

final

hashCode → int

The hash code for this object.

no setter, inherited

hintText → String?

Grey hint shown while empty.

final

initialValue → String?

Starting value.

final

isDense → bool

Smaller vertical padding.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

keyboardType → TextInputType

Keyboard to show (number, email, phone, multiline…).

final

labelText → String?

Floating label text.

final

left → double?

Distance from the left when positioned in a Stack.

final

lines → int

Number of text lines.

final

margin → EdgeInsetsGeometry?

Space outside, around the widget.

final

maxLength → int?

Maximum characters (shows a counter).

final

obscureText → bool

Hides the text (passwords) and shows an eye button to reveal it.

final

onChanged → ValueChanged<String>?

Called with the new value when the user changes it.

final

onFieldSubmitted → ValueChanged<String>?

Called when the user presses the keyboard's done/enter.

final

onSave → dynamic Function(String? value)?

Called when saved.

final

onTap → VoidCallback?

Called when tapped.

final

opacity → double?

See-through amount, 0 (invisible) to 1 (solid).

final

positioned → bool

Wraps it in a Positioned (use inside a Stack) with top/left/right/bottom.

final

positionedHeight → double?

Height when positioned.

final

positionedWidth → double?

Width when positioned.

final

prefix → Widget?

Widget before the text.

final

readOnly → bool

Shows the value without allowing edits.

final

required → bool

Marks the field as required.

final

right → double?

Distance from the right when positioned in a Stack.

final

rotate → double?

Rotation in radians.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

safeArea → bool

Keeps it out of the notch and system bars.

final

scale → double?

Scales the painted widget (1 = normal size).

final

suffix → Widget?

Widget after the text.

final

text → String?

Text to show.

final

textAlign → TextAlign

Text alignment.

final

textColor → Color?

Text color.

final

textHeight → double?

Line height of the text.

final

top → double?

Distance from the top when positioned in a Stack.

final

translate → Offset?

Moves the painted widget by this offset (layout unchanged).

final

validator → String? Function(String?)?

Form validator; return an error text or null (see UValidators).

final

visible → bool

False hides it completely (takes no space).

final

Methods

alignAtBottomCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the bottom center.

alignAtBottomLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the bottom left.

alignAtBottomRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the bottom right.

alignAtCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Centered.

alignAtCenterLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the center left.

alignAtCenterRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the center right.

alignAtLERP(Alignment a, Alignment b, double t, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned between a and b at t (0 = a, 1 = b).

alignAtTopCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the top center.

alignAtTopLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the top left.

alignAtTopRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned to the top right.

alignXY(double x, double y, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

Aligned at x, y from -1 to 1. child.alignXY(0, -0.5)

card({Color? backgroundColor, double? elevation, EdgeInsetsGeometry? margin}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Material Card around it. child.card(elevation: 2)

center() → Widget

Available on Widget, provided by the WidgetsExtension extension

Centered in the available space. child.center()

chip({required Color backgroundColor, double? width, double? height, Alignment? alignment, double borderWidth = 1, double radius = 12, Color borderColor = Colors.transparent, EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 8, vertical: 6), EdgeInsetsGeometry? margin, BoxConstraints? constraints}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Pill-shaped colored box, e.g. for tags. Text("New").chip(backgroundColor: Colors.green.shade100)

clipCircle() → Widget

Available on Widget, provided by the WidgetsExtension extension

Clips to a circle. avatar.clipCircle()

clipRadius(double radius) → Widget

Available on Widget, provided by the WidgetsExtension extension

Rounds the corners by clipping. image.clipRadius(12)

container({double? width, double? height, Alignment? alignment, Color? backgroundColor, double borderWidth = 1, double radius = 1, Color borderColor = Colors.transparent, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin, BoxConstraints? constraints}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Box with background, border and rounded corners. child.container(backgroundColor: Colors.white, radius: 12)

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<UTextField>

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.

inherited

disabled(bool disabled, {double opacity = 0.5}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Greys out and blocks taps when disabled. form.disabled(isSaving)

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Takes the remaining space in a Row/Column. child.expanded()

fadeSlideIn({int milliseconds = 1000, double offset = 24}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Fades and slides up once when first shown. card.fadeSlideIn()

fit({Alignment alignment = Alignment.center}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Shrinks to fit the space (never grows). Text(long).fit()

flexible({int flex = 1}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Can shrink in a Row/Column but does not have to fill. child.flexible()

form(GlobalKey<FormState> key) → Widget

Available on Widget, provided by the WidgetsExtension extension

Wraps in a Form with key. column.form(formKey)

hero(Object tag) → Widget

Available on Widget, provided by the WidgetsExtension extension

Hero animation between pages with the same tag. image.hero("product-$id")

ltr() → Widget

Available on Widget, provided by the WidgetsExtension extension

Forces left-to-right (numbers, phone numbers, code). Text(phone).ltr()

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDoubleTap(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

Double tap. image.onDoubleTap(like)

onLongPress(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

Long press. child.onLongPress(showOptions)

onPress(VoidCallback onTap, {double pressedScale = 0.9, Duration duration = const Duration(milliseconds: 120)}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Tap with a press-down shrink animation. card.onPress(open)

onTap(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

Tap without ripple. child.onTap(open)

onTapInk(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

Tap with a Material ripple (needs a Material ancestor). tile.onTapInk(open)

opacity(double opacity) → Widget

Available on Widget, provided by the WidgetsExtension extension

Makes it see-through (0 = invisible, 1 = solid). child.opacity(0.5)

pAll(double padding) → Widget

Available on Widget, provided by the WidgetsExtension extension

Same padding on every side. child.pAll(16)

pLTRB(double left, double top, double right, double bottom) → Widget

Available on Widget, provided by the WidgetsExtension extension

Padding left, top, right, bottom. child.pLTRB(8, 4, 8, 4)

pOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Padding on chosen sides. child.pOnly(top: 8)

position({double? left, double? top, double? right, double? bottom, double? width, double? height}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Positioned inside a Stack. badge.position(top: 0, right: 0)

pSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Horizontal and/or vertical padding. child.pSymmetric(horizontal: 16)

rotate(double scale) → Widget

Available on Widget, provided by the WidgetsExtension extension

Rotates by scale radians. arrow.rotate(pi / 2)

rtl() → Widget

Available on Widget, provided by the WidgetsExtension extension

Forces right-to-left. child.rtl()

safeArea() → Widget

Available on Widget, provided by the WidgetsExtension extension

Keeps it out of the notch and system bars. body.safeArea()

scale(double scale) → Widget

Available on Widget, provided by the WidgetsExtension extension

Scales the paint (layout size unchanged). icon.scale(1.5)

scrollable({Axis scrollDirection = Axis.vertical}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Makes it scroll when it does not fit. column.scrollable()

showMenus(List<PopupMenuEntry<int>> items) → Widget

Available on Widget, provided by the WidgetsExtension extension

Shows a popup menu where the user taps; items return their int value. child.showMenus([PopupMenuItem(value: 1, child: Text("Edit"))])

sized({double? width, double? height}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Fixed width and/or height. logo.sized(width: 48, height: 48)

skeleton(bool loading) → Widget

Available on Widget, provided by the WidgetsExtension extension

Draws a shimmering loading placeholder in its shape while loading. Text("Name").skeleton(isLoading)

sliver() → Widget

Available on Widget, provided by the WidgetsExtension extension

Lets a normal widget sit inside a CustomScrollView. header.sliver()

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

tooltip(String message) → Widget

Available on Widget, provided by the WidgetsExtension extension

Shows message on long press / mouse hover. icon.tooltip("Delete")

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → 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

translate(Offset offset) → Widget

Available on Widget, provided by the WidgetsExtension extension

Moves the paint by offset (layout unchanged). child.translate(const Offset(0, -4))

visible(bool visible, {bool maintainSize = false}) → Widget

Available on Widget, provided by the WidgetsExtension extension

Shows it only when visible; with maintainSize it keeps its space. saveButton.visible(isDirty)

Operators

operator ==(Object other) → bool

The equality operator.

inherited