Intl Phone Number Input

A simple and customizable flutter package for international phone number input

CustomDecorationCustomBorderDefault
Screenshot_1587652933Screenshot_1587652933Screenshot_1587652933

What's new

  • Fixed issue with text input autoFocus when formatInput is set to false
  • Added new locale translations for "sk" "se" "pl" "no" "ja" "it" "zh" "nl" "de" "fr" "es" "en" "pt_BR"
  • Added selector configuration selectorConfig parameter which enables you to
    • Add emoji flag support
    • Add option to turn off flags
  • Breaking Change selectorType has been moved to selectorConfig
  • Fixed autoFocus search search field
  • Fixed keyboard covers bottom sheet while search
  • Breaking Change Removed factory constructors withCustomBorder and withCustomDecoration

Features

  • Support for RTL languages
  • Selector mode dropdown, bottom sheet and dialog
  • As You Type Formatter: formats inputs to its selected international format
  • Get Region Info with PhoneNumber.getRegionInfoFromPhoneNumber(String phoneNumber, String isoCode);
  • Format PhoneNumber with PhoneNumber.getParsableNumber(String phoneNumber, String isoCode) or PhoneNumber Reference.parseNumber()
  • Custom list of countries e.g. 'NG', 'GH', 'BJ' 'TG', 'CI'
    String phoneNumber =  '+234 500 500 5005';
    PhoneNumber number = await PhoneNumber.getRegionInfoFromPhoneNumber(phoneNumber);
    String parsableNumber = number.parseNumber();
    `controller reference`.text = parsableNumber

Note

    PhoneNumber.getRegionInfoFromPhoneNumber(String phoneNumber, [String isoCode])

Could throw an Exception if the phoneNumber isn't recognised its a good pattern to pass the country's isoCode or have '+' at the beginning of the string

isoCode could be null if PhoneNumber is not recognised

Usage

Constructors

s/nConstructor
1InternationalPhoneNumberInput

Available Parameters

InternationalPhoneNumberInput({
    Key key,
    this.selectorType,
    @required this.onInputChanged,
    this.onInputValidated,
    this.focusNode,
    this.textFieldController,
    this.onSubmit,
    this.keyboardAction,
    this.countries,
    this.textStyle,
    this.selectorTextStyle,
    this.inputBorder,
    this.inputDecoration,
    this.searchBoxDecoration,
    this.initialValue,
    this.selectorButtonOnErrorPadding = 24,
    this.maxLength = 15,
    this.hintText = 'Phone Number',
    this.isEnabled = true,
    this.autoFocus = false,
    this.autoValidate = false,
    this.formatInput = true,
    this.errorMessage = 'Invalid phone number',
    this.ignoreBlank = false,
    this.locale,
    this.countrySelectorScrollControlled = true,
    });
ParameterDatatypeInitial ValueDefault 1
onInputChangedfunction(PhoneNumber)null:heavy_check_mark:
onInputValidatedfunction(bool)null:heavy_check_mark:
focusNodeFocusNodenull:heavy_check_mark:
textFieldControllerTextEditingControllerTextEditingController():heavy_check_mark:
onSubmitFunction()null:heavy_check_mark:
keyboardActionTextInputActionnull:heavy_check_mark:
countriesListnull:heavy_check_mark:
textStyleTextStylenull:heavy_check_mark:
selectorTextStyleTextStylenull:heavy_check_mark:
inputBorderInputBordernull:heavy_check_mark:
inputDecorationInputDecorationnull:heavy_check_mark:
initialValuePhoneNumbernull:heavy_check_mark:
hintTextStringPhone Number:heavy_check_mark:
selectorButtonOnErrorPaddingdouble24:heavy_check_mark:
maxLengthinteger15:heavy_check_mark:
isEnabledbooleantrue:heavy_check_mark:
autoFocusbooleanfalse:heavy_check_mark:
autoValidatebooleanfalse:heavy_check_mark:
formatInputbooleantrue:heavy_check_mark:
errorMessageStringInvalid phone number:heavy_check_mark:
selectorConfigSelectorConfigPhoneInputSelectorType.DROPDOWN:heavy_check_mark:
ignoreBlankbooleanfalse:heavy_check_mark:
localeStringnull:heavy_check_mark:
searchBoxDecorationInputDecorationnull:heavy_check_mark:
countrySelectorScrollControlledbooleantrue:heavy_check_mark:

Selector Types

DROPDOWNBOTTOMSHEETDIALOG
Screenshot_1587652933Screenshot_1587652933Screenshot_1587652933

Testing

Widget Key parameters and Helper classes are now available for integration testing check out this example 🎯 Integration Testing Example

Contributions

If you encounter any problem or the library is missing a feature feel free to open an issue. Feel free to fork, improve the package and make pull request.

Contributors

Made with contributors-img.

Dependencies

Credits

A special thanks to niinyarko

Libraries

intl_phone_number_input
intl_phone_number_input_test