OudsPhoneNumberInput class

OUDS Text Input Design Guidelines

Reference design version : 1.3.0

This widget allows users to enter a phone number with support for country selection, automatic formatting, and visual icons or status indicators.

Parameters:

  • controller: The text controller to access or modify the input value.
  • focusNode: The focus node to manage focus on the input field.
  • enabled: Indicates if the field is enabled (default: true).
  • readOnly: If true, the field is read-only (default: false). This parameter should be consistent with the countrySelector, if used, to ensure coherent input management.
  • keyboardType: The type of keyboard to display during input.
  • countrySelector: Optional. If provided, displays a country selector for choosing the country of the number.
  • decoration: Decoration configuration for the input field, including labels, icons, helper texts, etc.
  • onEditingComplete: Callback invoked when editing is complete.

You can use OudsPhoneNumberInput component in your project, customizing parameters as needed :

Example 1: With a country selector
OudsPhoneNumberInput(
  decoration: OudsInputDecoration(
    labelText: "Phone Number",
    hintText: "Enter your number",
  ),
  controller: myController,
  countrySelector: CountrySelector(
    readOnly: false,
    countryFilter: CountryFilter.all,
    codes: ["FR", "US"],
    onCountryChanged: (country) {
      // Handle country change if needed
    },
  ),
  readOnly: false, // should be consistent with the countrySelector if it enforces read-only
)
Example 2: Without a country selector (direct input only)
OudsPhoneNumberInput(
  decoration: OudsInputDecoration(
    labelText: "Phone Number",
    hintText: "Enter your number",
  ),
  controller: myController,
  // No countrySelector provided
  readOnly: false,
)
Inheritance

Constructors

OudsPhoneNumberInput({Key? key, TextEditingController? controller, FocusNode? focusNode, bool? enabled = true, bool? readOnly = false, TextInputType? keyboardType, CountrySelector? countrySelector, required OudsInputDecoration decoration, void onEditingComplete(String)?})

Properties

controller TextEditingController?
final
countrySelector ↔ CountrySelector?
getter/setter pair
decoration → OudsInputDecoration
final
enabled bool?
final
focusNode FocusNode?
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?
final
onEditingComplete → void Function(String)?
final
readOnly bool?
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<OudsPhoneNumberInput>
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

Static Methods

buildIcon(BuildContext context, String assetName, OudsFormFieldsControlState controlTextInputState, bool isError) Widget