OTPInput class
A PIN / OTP verification component for the Alter Design System.
Features:
- Configurable digit count (
length: 4or6). - Auto-focus progression and backspace retreat.
- Full paste clipboard detection to auto-fill cells.
- Optional
obscureOtpmode. - Matches Alter input tokens (20px radius, 64px box height, stroke borders, textDanger on error).
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- OTPInput
Constructors
-
OTPInput({Key? key, int length = 4, InputControlType type = InputControlType.gray, bool obscureOtp = false, String obscuringCharacter = '•', bool autofocus = true, bool enabled = true, bool readOnly = false, bool isError = false, bool showErrorMessage = true, String errorMessage = 'Invalid OTP code', ValueChanged<
String> ? onChanged, ValueChanged<String> ? onCompleted}) -
Creates an OTPInput verification instance.
const
Properties
- autofocus → bool
-
Whether the first digit cell should autofocus on render.
final
- enabled → bool
-
Whether the OTP input is interactive.
final
- errorMessage → String
-
Default error message text.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isError → bool
-
Whether the component is in an error state.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- length → int
-
Total number of OTP pin digits/cells (defaults to 4).
final
- obscureOtp → bool
-
Whether the entered digits should be obscured.
final
- obscuringCharacter → String
-
Obscuring character glyph (defaults to '•').
final
-
onChanged
→ ValueChanged<
String> ? -
Callback executed with current concatenated OTP string on change.
final
-
onCompleted
→ ValueChanged<
String> ? -
Callback executed when all OTP digits have been filled.
final
- readOnly → bool
-
Whether the OTP input is read-only.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showErrorMessage → bool
-
Whether to render the error message beneath the cells.
final
- type → InputControlType
-
Surface background and border style variant.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< OTPInput> -
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