MoonAuthCode class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- MoonAuthCode
Constructors
-
MoonAuthCode({Key? key, AuthFieldShape? authFieldShape = AuthFieldShape.box, bool autoDismissKeyboard = true, bool autoFocus = false, bool autoUnfocus = true, bool enabled = true, bool enableInputFill = false, bool obscureText = false, bool peekWhenObscuring = false, bool showAuthFieldCursor = true, bool useHapticFeedback = false, BorderRadiusGeometry? borderRadius, Color? authFieldCursorColor, Color? selectedBorderColor, Color? activeBorderColor, Color? inactiveBorderColor, Color? errorBorderColor, Color? selectedFillColor, Color? activeFillColor, Color? inactiveFillColor, double? borderWidth, double? disabledOpacityValue, double? gap, double? height, double? width, Duration? animationDuration, Duration? errorAnimationDuration, Duration? peekDuration, Curve? animationCurve, Curve? errorAnimationCurve, ErrorAnimationType errorAnimationType = ErrorAnimationType.noAnimation, FocusNode? focusNode, int authInputFieldCount = 6, List<
BoxShadow> ? boxShadows, List<BoxShadow> ? activeBoxShadows, List<BoxShadow> ? inActiveBoxShadows, List<TextInputFormatter> ? inputFormatters, MainAxisAlignment mainAxisAlignment = MainAxisAlignment.center, String? hintCharacter, String obscuringCharacter = '•', String? semanticLabel, TextInputAction textInputAction = TextInputAction.done, TextInputType keyboardType = TextInputType.visiblePassword, String? errorText, TextStyle? hintStyle, TextStyle? textStyle, TextStyle? errorTextStyle, TextEditingController? textController, required FormFieldValidator<String> validator, ValueChanged<String> ? onChanged, ValueChanged<String> ? onCompleted, ValueChanged<String> ? onSubmitted, VoidCallback? onEditingComplete, required MoonAuthCodeErrorBuilder errorBuilder, Widget? obscuringWidget}) -
Creates a Moon Design auth code.
const
Properties
- activeBorderColor → Color?
-
The border color of the auth code input field with input.
final
-
activeBoxShadows
→ List<
BoxShadow> ? -
The list of shadows applied to the auth code input field with input.
final
- activeFillColor → Color?
-
The fill color of the auth code input field with input.
final
- animationCurve → Curve?
-
The curve of the auth code input field transition animation.
final
- animationDuration → Duration?
-
The duration of the auth code input field transition animation.
final
- authFieldCursorColor → Color?
-
The cursor color of the auth code input field.
final
- authFieldShape → AuthFieldShape?
-
The shape of the auth code input field.
final
- authInputFieldCount → int
-
The total number of input fields to build for the auth code.
final
- autoDismissKeyboard → bool
-
Whether to automatically dismiss the keyboard when the last input is entered.
final
- autoFocus → bool
-
True if this widget will be selected as the initial focus when no other
node in its scope is currently focused.
final
- autoUnfocus → bool
-
Whether to automatically unfocus the auth code.
final
- borderRadius → BorderRadiusGeometry?
-
The border radius of the auth code input field.
final
- borderWidth → double?
-
The border width of the auth code input field.
final
-
boxShadows
→ List<
BoxShadow> ? -
The list of shadows applied to the auth code input field.
final
- disabledOpacityValue → double?
-
The opacity value of the auth code when enabled is false.
final
- enabled → bool
-
Whether the auth code is enabled.
final
- enableInputFill → bool
-
Whether to enable the fill color for the auth code input fields.
final
- errorAnimationCurve → Curve?
-
The curve of the auth code error state animation.
final
- errorAnimationDuration → Duration?
-
The duration of the auth code error state animation.
final
- errorAnimationType → ErrorAnimationType
-
The animation type for the auth code validation error.
final
- errorBorderColor → Color?
-
The border color of the auth code input field in error state.
final
- errorBuilder → MoonAuthCodeErrorBuilder
-
A builder to build the auth code error widget.
final
- errorText → String?
-
The error text can be used to force authentication into an error state (useful for asynchronous errors).
final
- errorTextStyle → TextStyle?
-
The text style of the auth code in error state.
final
- focusNode → FocusNode?
-
An optional focus node to use as the focus node for this widget.
final
- gap → double?
-
The horizontal gap between the auth code input fields.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double?
-
The height of the auth code input field.
final
- hintCharacter → String?
-
The character or placeholder to display in the auth code input field when its value is empty.
final
- hintStyle → TextStyle?
-
The text style of the hintCharacter.
final
- inactiveBorderColor → Color?
-
The border color of the auth code input field without input.
final
-
inActiveBoxShadows
→ List<
BoxShadow> ? -
The list of shadows applied to the auth code input field without input.
final
- inactiveFillColor → Color?
-
The fill color of the auth code input field without 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
- keyboardType → TextInputType
-
The keyboard TextInputType for the auth code.
final
- mainAxisAlignment → MainAxisAlignment
-
The placement of the auth code input fields along the main axis.
final
- obscureText → bool
-
Whether to replace all typed characters in the auth code input fields with the obscuringCharacter.
final
- obscuringCharacter → String
-
The character to use to obscure the text when obscureText is true.
final
- obscuringWidget → Widget?
-
The widget to obscure the auth code input field text.
final
-
onChanged
→ ValueChanged<
String> ? -
The callback that is called when the auth code input text changes.
final
-
onCompleted
→ ValueChanged<
String> ? -
The callback that is called when all the auth code input fields are filled.
final
- onEditingComplete → VoidCallback?
-
The onEditingComplete callback runs when editing is finished.
It differs from onSubmitted by having a default value which
updates textController and yields keyboard focus.
final
-
onSubmitted
→ ValueChanged<
String> ? -
The callback that is called when the 'done' or 'next' action is triggered on the keyboard.
final
- peekDuration → Duration?
-
The duration to display the typed character before it is obscured with obscuringCharacter.
The peekWhenObscuring has to be set to true.
final
- peekWhenObscuring → bool
-
Whether to briefly display the typed character before obscuring it with the obscuringCharacter.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedBorderColor → Color?
-
The border color of the selected auth code input field.
final
- selectedFillColor → Color?
-
The fill color of the selected auth code input field.
final
- semanticLabel → String?
-
The semantic label for the auth code.
final
- showAuthFieldCursor → bool
-
Whether to show the cursor in the selected auth code input field.
final
- textController → TextEditingController?
-
The TextEditingController used to edit the text in the auth code input field.
final
- textInputAction → TextInputAction
-
The action to perform by the text input control.
final
- textStyle → TextStyle?
-
The text style of the auth code.
final
- useHapticFeedback → bool
-
Whether to use haptic feedback (vibration) for auth code error state.
final
-
validator
→ FormFieldValidator<
String> -
The input text validator for the auth code TextFormField.
The validator errors take precedence over the provided errorText.
final
- width → double?
-
The width of the auth code input field.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _MoonAuthCodeState -
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}) → 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