SeniorPinCodeFields class - senior_pin_code_field_widget library

Constructors

SeniorPinCodeFields({Key? key, bool allowPasteText = false, bool autoClear = false, bool autofocus = false, bool autoHideKeyboard = true, TextEditingController? controller, bool disabled = false, FocusNode? focusNode, required int length, bool obscureText = false, ValueChanged<String>? onChange, required ValueChanged<String> onComplete, Future<bool> onCompleteValidator(String)?, ValueChanged<String>? onPaste, SeniorModalDefinitions? pasteModalDefinitions, TextInputType keyboardType = TextInputType.text, SeniorPinCodeFieldStyle? style}): Creates the design system's pin code fields component. The length and onComplete parameters are required. if allowPasteText is true you must set pasteModalDefinitions.
const

Properties

allowPasteText → bool: Whether the option to "paste" content into the component will be available. The default value is false.
final
autoClear → bool: Whether the content added to the fields will be removed when it loses focus and it has not been filled in completely. The default value is false.
final
autofocus → bool: Whether the component will request focus. The default value is false.
final
autoHideKeyboard → bool: Whether the keyboard will close automatically. The default value is true.
final
controller → TextEditingController?: The control that represents the component's text field. Allows you to get and provide information related to the value of pin code fields.
final
disabled → bool: Define se os campos estarão desabilitados. Neste estado eles não poderão receber interações. The default value is false.
final
focusNode → FocusNode?: The focus node to control the component's focus.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
keyboardType → TextInputType: The keyboard type displayed in the field. Defines the content that can be added to the field. The default value is TextInputType.text.
final
length → int: The number of fields (characters) in the field.
final
obscureText → bool: Defines if the value filled in the component will be explicit. When true the content display will be replaced by a neutral character. Stored content will still be preserved. The default value is false.
final
onChange → ValueChanged<String>?: Callback function executed when there are changes in the field.
final
onComplete → ValueChanged<String>: Callback function executed when all fields are filled.
final
onCompleteValidator → (Future<bool> Function(String)?): Callback function executed when all fields are filled to validate the content. If your return is false, a validation error will be considered.
final
onPaste → ValueChanged<String>?: Callback function executed when content is "pasted" in the component.
final
pasteModalDefinitions → SeniorModalDefinitions?: The definitions for the paste option modal. Allows you to configure: SeniorModalDefinitions.cancelLabel the text for the button with the cancel function. SeniorModalDefinitions.confirmLabel the text for the confirmation button. SeniorModalDefinitions.content the message shown in the modal. SeniorModalDefinitions.title the modal title.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
style → SeniorPinCodeFieldStyle?: The style definitions for the component. Allows you to configure: SeniorPinCodeFieldStyle.defaultBorderColor the default color for the border color. The color displayed when the field is not in focus, has no content, or in an no-error state. SeniorPinCodeFieldStyle.disabledDefaultBorderColor the default color for the border color. The color displayed when the field has no content and is disabled. SeniorPinCodeFieldStyle.disabledHasTextBorderColor the border color for when the field has content and is disabled. SeniorPinCodeFieldStyle.disabledPinBoxColor the field text color for when it is disabled. SeniorPinCodeFieldStyle.disabledPinTextColor the field's background color for when it is disabled. SeniorPinCodeFieldStyle.errorBorderColor the border color for fields that are in an error state. SeniorPinCodeFieldStyle.hasTextBorderColor the border color for when the field has content. SeniorPinCodeFieldStyle.highlightColor the border color for when the field is in focus. SeniorPinCodeFieldStyle.pinBoxColor the field's background color. SeniorPinCodeFieldStyle.pinTextColor the text color of the field.
final

Methods

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