FxOtpInput class

A 6-digit OTP input with a resend countdown.

Composes FxPinInput for digit entry and FxCountdownAction for the resend timer. Call FxOtpInputState.triggerError via a GlobalKey to shake the cells and clear the input on a wrong code.

Example:

FxOtpInput(
  key: _otpKey,
  onCompleted: (code) async => await verifyOtp(code),
  onResend: () async => await resendOtp(),
)

// On wrong code:
_otpKey.currentState?.triggerError();
Inheritance

Constructors

FxOtpInput({Key? key, required Future<void> onCompleted(String), int length = 6, FxPinInputTheme? pinTheme, bool autoFocus = true, String? errorText, TextEditingController? controller})
const

Properties

autoFocus → bool
final
controller → TextEditingController?
final
errorText → String?
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
final
onCompleted → Future<void> Function(String)
final
pinTheme → FxPinInputTheme?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FxOtpInput>
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
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, 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

Operators

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