TPinField class

A segmented PIN / OTP verification code input field.

Automatically handles digit entry, backspace navigation, clipboard paste, obscure masking, and completed state detection.

Inheritance
Available extensions

Constructors

TPinField({Key? key, int length = 6, double boxWidth = 48.0, double boxHeight = 54.0, double spacing = 10.0, double borderRadius = 8.0, bool obscureText = false, String obscureCharacter = '•', bool enabled = true, bool autoFocus = false, String? errorText, ValueChanged<String>? onChanged, ValueChanged<String>? onCompleted})
const

Properties

autoFocus → bool
Whether to autofocus the first segment box.
final
borderRadius → double
Border radius of segment boxes (default 8.0).
final
boxHeight → double
Height of each segment box (default 54.0).
final
boxWidth → double
Width of each segment box (default 48.0).
final
enabled → bool
Whether this field is disabled.
final
errorText → String?
Error text displayed below the field.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
length → int
Number of segments / digits (default 6).
final
obscureCharacter → String
Mask character used when obscureText is true (default '•').
final
obscureText → bool
Whether to obscure the input text (like a password/PIN).
final
onChanged → ValueChanged<String>?
Callback fired whenever any digit changes.
final
onCompleted → ValueChanged<String>?
Callback fired as soon as all digits are filled.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spacing → double
Horizontal spacing between segment boxes (default 10.0).
final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TPinField>
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
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.
paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.
size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.
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, 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
visible(bool visible, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.
when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

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