README.md

phone_form_field

Flutter phone input integrated with flutter internationalization

Features

• Totally cross platform, this is a dart only package / dependencies
• Internationalization
• Phone formatting localized by region
• Phone number validation (built-in validators included for main use cases)
• Support autofill and copy paste
• Extends Flutter's FormField
• Uses dart phone_numbers_parser for parsing

Demo

Demo available at https://cedvdb.github.io/phone_form_field/

Usage

// works without any param
PhoneFormField();

// all params
PhoneFormField(
  key: Key('phone-field')
  controller: null,     // controller & initialValue value
  initialValue: null,   // can't be supplied simultaneously
  shouldFormat: true    // default 
  defaultCountry: IsoCode.US, // default 
  decoration: InputDecoration(
    labelText: 'Phone',          // default to null
    border: OutlineInputBorder() // default to UnderlineInputBorder(),
    // ...
  ),
  validator: PhoneValidator.validMobile(),   // default PhoneValidator.valid()
  isCountryChipPersistent: false, // default
  isCountrySelectionEnabled: true, // default
  countrySelectorNavigator: CountrySelectorNavigator.bottomSheet(),
  showFlagInInput: true,  // default
  flagSize: 16,           // default
  autofillHints: [AutofillHints.telephoneNumber], // default to null
  enabled: true,          // default
  autofocus: false,       // default
  onSaved: (PhoneNumber p) => print('saved $p'),   // default null
  onChanged: (PhoneNumber p) => print('saved $p'), // default null
  // ... + other textfield params
)

Validation

Built-in validators

• required : PhoneValidator.required
• valid : PhoneValidator.valid (default value when no validator supplied)
• valid mobile number : PhoneValidator.validMobile
• valid fixed line number : PhoneValidator.validFixedLine
• valid type : PhoneValidator.validType
• valid country : PhoneValidator.validCountry
• none : PhoneValidator.none (this can be used to disable default valid validator)

Validators details

• Each validator has an optional errorText property to override built-in translated text
• Most of them have an optional allowEmpty (default is true) preventing to flag an empty field as valid. Consider using a composed validator with a first PhoneValidator.required when a different text is needed for empty field.

Composing validators

Validator can be a composed set of validators built-in or custom validator using PhoneValidator.compose, see example below.

Note that when composing validators, the sorting is important as the error message displayed is the first validator failing.

PhoneFormField(
  // ...
  validator: PhoneValidator.compose([
    // list of validators to use
    PhoneValidator.required(errorText: "You must enter a value"),
    PhoneValidator.validMobile(),
    // ..
  ]),
)

Country selector

Here are the list of the parameters available for all built-in country selector :

Name	Default value	Description
countries	null	Countries available in list view (all countries are listed when omitted)
favorites	null	List of country code ['FR','UK'] to display on top of the list
addSeparator	true	Whether to add a separator between favorite countries and others one. Useless if favorites parameter is null
showCountryCode	true	Whether to display the country dial code as listTile item subtitle
sortCountries	false	Whether the countries should appear in alphabetic order, if false the countries are displayed in the same order as countries property (Note that favorite countries are listed in supplied order whatever the value of this parameter)
noResultMessage	null	The message to be displayed in place of the list when search result is empty (a default localised message is used when omitted)

Built-in country selector

• CountrySelectorNavigator.searchDelegate Open a dialog to select the country. No extra parameters

• CountrySelectorNavigator.dialog Open a dialog to select the country. No extra parameters

• CountrySelectorNavigator.bottomSheet Open a bottom sheet expanding to all available space in both axis No extra parameters

• CountrySelectorNavigator.modalBottomSheet Open a modal bottom sheet expanded horizontally Extra parameters:

  • height (double, default null) Allow to determine the height of the bottom sheet, will expand to all available height when omitted

• CountrySelectorNavigator.draggableBottomSheet Open a modal bottom sheet expanded horizontally which may be dragged from a minimum to a maximum of current available height. Uses internally the DraggableScrollableSheet flutter widget Extra parameters:

  • initialChildSize (double, default: 0.5) factor of current available height used when opening
  • minChildSize (double, default: 0.Z5) : maximum factor of current available height
  • minChildSize (double, default: 0.Z5) : minimum factor of current available height
  • borderRadius (BorderRadiusGeometry, default: 16px circular radius on top left/right)

Custom Country Selector Navigator

You can use your own country selector by creating a class that implements CountrySelectorNavigator It has one required method navigate expected to return the selected country:

class CustomCountrySelectorNavigator implements CountrySelectorNavigator {
  Future<Country?> navigate(BuildContext context) {
    // ask user for a country and return related `Country` class
  }
}

// usage
PhoneFormField(
  // ...
  selectorNavigator: CustomCountrySelectorNavigator(),
  // ...
)

Internationalization

Include the delegate

  return MaterialApp(
    localizationsDelegates: [
      GlobalMaterialLocalizations.delegate,
      PhoneFieldLocalization.delegate
    ],
    supportedLocales: [
      const Locale('en', ''),
      const Locale('es', ''),
      const Locale('fr', ''),
      const Locale('ru', ''),
      const Locale('uk', ''),
      // ...
    ],

That's it.

A bunch of languages are built-in:

- 'ar',
- 'de',
- 'en',
- 'el'
- 'es',
- 'fr',
- 'hin',
- 'it',
- 'nl',
- 'pt',
- 'ru',
- 'uk',
- 'tr',
- 'zh',
- 'sv',

If one of the language you target is not supported you can submit a pull request with the translated file in src/l10n