Flutter phone input integrated with flutter internationalization
Demo available at https://cedvdb.github.io/phone_form_field/
PhoneFormField();
/// params
PhoneFormField(
initialValue: PhoneNumber.parse('+33'), // or use the controller
validator: PhoneValidator.compose(
[PhoneValidator.required(), PhoneValidator.validMobile()]),
countrySelectorNavigator: const CountrySelectorNavigator.page(),
onChanged: (phoneNumber) => print('changed into $phoneNumber'),
enabled: true,
isCountrySelectionEnabled: true,
isCountryButtonPersistent: true,
countryButtonStyle: const CountryButtonStyle(
showDialCode: true,
showIsoCode: true,
showFlag: true,
flagSize: 16
),
// + all parameters of TextField
// + all parameters of FormField
// ...
);
PhoneValidator.required
PhoneValidator.valid
(default value when no validator supplied)PhoneValidator.validMobile
PhoneValidator.validFixedLine
PhoneValidator.validType
PhoneValidator.validCountry
PhoneValidator.none
(this can be used to disable default valid validator)errorText
property to override built-in translated textValidator 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(),
// ..
]),
)
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) |
CountrySelectorNavigator.page Open a page 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 omittedCountrySelectorNavigator.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 openingminChildSize
(double, default: 0.Z5
) : maximum factor of current available height minChildSize
(double, default: 0.Z5
) : minimum factor of current available heightborderRadius
(BorderRadiusGeometry, default: 16px circular radius on top left/right)You can use your own country selector by creating a class that implements CountrySelectorNavigator
It has one required method show
expected to return the selected country:
class CustomCountrySelectorNavigator implements CountrySelectorNavigator {
Future<Country?> show(BuildContext context) {
// ask user for a country and return related `Country` class
}
}
// usage
PhoneFormField(
// ...
selectorNavigator: CustomCountrySelectorNavigator(),
// ...
)
This package uses the flutter_country_selector
package under the hood, which exports a method for dynamic localization CountrySelectorLocalization.of(context).countryName(isoCode)
.
Include the delegate
return MaterialApp(
localizationsDelegates: [
DefaultMaterialLocalizations.delegate,
...PhoneFieldLocalization.delegates,
],
supportedLocales: [
const Locale('en', ''),
const Locale('es', ''),
const Locale('fr', ''),
const Locale('ru', ''),
const Locale('uz', ''),
const Locale('uk', ''),
// ...
],
That's it.
If one of the language you target is not supported you can submit a pull request in flutter_country_selector and phone_form_field repositories.
Some users have expressed their need to change some flags due to political reasons, or stylistic reasons. You might also wish to add your own flags. To do so refer to this issue: https://github.com/cedvdb/phone_form_field/issues/222