PinPut class
Constructors
PinPut.new ({Key ? key , required int fieldsCount , ValueChanged <String > ? onSubmit , FormFieldSetter <String > ? onSaved , ValueChanged <String > ? onChanged , VoidCallback ? onTap , ValueChanged <String ? > ? onClipboardFound , TextEditingController ? controller , FocusNode ? focusNode , Widget ? preFilledWidget , List <int > separatorPositions = const [] , Widget separator = const SizedBox(width: 15.0) , TextStyle ? textStyle , BoxDecoration ? submittedFieldDecoration , BoxDecoration ? selectedFieldDecoration , BoxDecoration ? followingFieldDecoration , BoxDecoration ? disabledDecoration , double ? eachFieldWidth , double ? eachFieldHeight , MainAxisAlignment fieldsAlignment = MainAxisAlignment.spaceBetween , AlignmentGeometry eachFieldAlignment = Alignment.center , EdgeInsetsGeometry ? eachFieldMargin , EdgeInsetsGeometry ? eachFieldPadding , BoxConstraints eachFieldConstraints = const BoxConstraints(minHeight: 40.0, minWidth: 40.0) , InputDecoration ? inputDecoration , Curve animationCurve = Curves.linear , Duration animationDuration = const Duration(milliseconds: 160) , PinAnimationType pinAnimationType = PinAnimationType.slide , Offset ? slideTransitionBeginOffset , bool enabled = true , bool checkClipboard = false , bool useNativeKeyboard = true , bool autofocus = false , AutovalidateMode autovalidateMode = AutovalidateMode.disabled , bool withCursor = false , Widget ? cursor , Brightness ? keyboardAppearance , List <TextInputFormatter > ? inputFormatters , FormFieldValidator <String > ? validator , TextInputType keyboardType = TextInputType.number , String ? obscureText , TextCapitalization textCapitalization = TextCapitalization.none , TextInputAction ? textInputAction , ToolbarOptions ? toolbarOptions = const ToolbarOptions(paste: true) , MainAxisSize mainAxisSize = MainAxisSize.max , Iterable <String > ? autofillHints , bool enableIMEPersonalizedLearning = true , String ? initialValue , SmartDashesType ? smartDashesType , SmartQuotesType ? smartQuotesType , bool enableSuggestions = true , MaxLengthEnforcement ? maxLengthEnforcement , VoidCallback ? onEditingComplete , double cursorWidth = 2 , double ? cursorHeight , Radius ? cursorRadius , Color ? cursorColor , bool enableInteractiveSelection = true , TextSelectionControls ? selectionControls , InputCounterWidgetBuilder ? buildCounter , String ? restorationId })
const
Properties
animationCurve
→ Curve
curve of every PinPut Animation
final
animationDuration
→ Duration
Duration of every PinPut Animation
final
autofillHints
→ Iterable <String > ?
lists of auto fill hints
final
autofocus
→ bool
Whether this text field should focus itself if nothing else is already
focused.
final
autovalidateMode
→ AutovalidateMode
If true validator function is called when PinPut value changes
alternatively you can use GlobalKey
final
buildCounter
→ InputCounterWidgetBuilder ?
final
checkClipboard
→ bool
Whether we should check Clipboard data
final
controller
→ TextEditingController ?
Used to get, modify PinPut value and more.
final
cursor
→ Widget ?
If withCursor true the focused field includes cursor widget or '|'
final
cursorColor
→ Color ?
final
cursorHeight
→ double ?
final
cursorRadius
→ Radius ?
final
cursorWidth
→ double
final
disabledDecoration
→ BoxDecoration ?
The decoration of each PinPut field when PinPut ise disabled
final
eachFieldAlignment
→ AlignmentGeometry
Defines how each PinPut field are being placed within the container
final
eachFieldConstraints
→ BoxConstraints
Additional constraints to apply to the each field container.
properties
final
eachFieldHeight
→ double ?
height of each PinPut field
final
eachFieldMargin
→ EdgeInsetsGeometry ?
Empty space to surround the PinPut field container.
final
eachFieldPadding
→ EdgeInsetsGeometry ?
Empty space to inscribe the PinPut field container.
For example space between border and text
final
eachFieldWidth
→ double ?
width of each PinPut field
final
enabled
→ bool
Defines PinPut state
final
enableIMEPersonalizedLearning
→ bool
final
enableInteractiveSelection
→ bool
Whether to enable user interface affordances for changing the
text selection.
final
enableSuggestions
→ bool
final
fieldsAlignment
→ MainAxisAlignment
Defines how PinPut fields are being placed inside Row
final
fieldsCount
→ int
Displayed fields count. PIN code length.
final
focusNode
→ FocusNode ?
Defines the keyboard focus for this widget.
To give the keyboard focus to this widget, provide a focusNode and then
use the current FocusScope to request the focus:
final
followingFieldDecoration
→ BoxDecoration ?
The decoration of each PinPut following field
final
hashCode
→ int
The hash code for this object.
no setter inherited
initialValue
→ String ?
final
inputDecoration
→ InputDecoration ?
The decoration to show around the text PinPut .
final
inputFormatters
→ List <TextInputFormatter > ?
Optional input validation and formatting overrides.
final
key
→ Key ?
Controls how one widget replaces another widget in the tree.
final inherited
keyboardAppearance
→ Brightness ?
The appearance of the keyboard.
This setting is only honored on iOS devices.
If unset, defaults to the brightness of ThemeData.primaryColorBrightness
.
final
keyboardType
→ TextInputType
The type of keyboard to use for editing the text.
final
mainAxisSize
→ MainAxisSize
Maximize the amount of free space along the main axis.
final
maxLengthEnforcement
→ MaxLengthEnforcement ?
final
obscureText
→ String ?
Provide any symbol to obscure each PinPut field
Recommended ●
final
onChanged
→ ValueChanged <String > ?
Called every time input value changes.
final
onClipboardFound
→ ValueChanged <String ? > ?
Called when Clipboard has value of length fieldsCount.
final
onEditingComplete
→ VoidCallback ?
final
onSaved
→ FormFieldSetter <String > ?
Signature for being notified when a form field changes value.
final
onSubmit
→ ValueChanged <String > ?
Same as FormField onFieldSubmitted, called when PinPut submitted.
final
onTap
→ VoidCallback ?
Called when user clicks on PinPut
final
pinAnimationType
→ PinAnimationType
Animation Type of each PinPut field
options:
none, scale, fade, slide, rotation
final
preFilledWidget
→ Widget ?
Widget that is displayed before field submitted.
final
restorationId
→ String ?
final
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
selectedFieldDecoration
→ BoxDecoration ?
The decoration of PinPut currently selected field
final
selectionControls
→ TextSelectionControls ?
final
separator
→ Widget
Builds a PinPut separator
final
separatorPositions
→ List <int >
Sets the positions where the separator should be shown
final
slideTransitionBeginOffset
→ Offset ?
Begin Offset of ever PinPut field when pinAnimationType is slide
final
smartDashesType
→ SmartDashesType ?
final
smartQuotesType
→ SmartQuotesType ?
final
submittedFieldDecoration
→ BoxDecoration ?
Box decoration of following properties of PinPut
submittedFieldDecoration selectedFieldDecoration followingFieldDecoration disabledDecoration
You can customize every pixel with it
properties are being animated implicitly when value changes
final
textCapitalization
→ TextCapitalization
Configures how the platform keyboard will select an uppercase or
lowercase keyboard.
final
textInputAction
→ TextInputAction ?
The type of action button to use for the keyboard.
final
textStyle
→ TextStyle ?
The style to use for PinPut
If null, defaults to the subhead
text style from the current Theme .
final
toolbarOptions
→ ToolbarOptions ?
Configuration of toolbar options.
final
useNativeKeyboard
→ bool
Whether we use Native keyboard or custom Numpad
when flag is set to false PinPut wont be focusable anymore
so you should set value of PinPut 's TextEditingController programmatically
final
validator
→ FormFieldValidator <String > ?
An optional method that validates an input. Returns an error string to
display if the input is invalid, or null otherwise.
final
withCursor
→ bool
If true the focused field includes fake cursor
final