intl_phone_number_input 0.2.0

Flutter Android iOS

A simple and customizable flutter package on International Phone Number Input.

Intl Phone Number Input #

A simple and customizable flutter package for international phone number input

What's new #

* As You Type Formatter: The Package now formats the input to it's selected national format
* You can now disable input formatting by setting inputFormat to false
* Replaced TextField with 
* AutoValidate
* TextStyle
* onInputChanged now returns a new PhoneNumber Model
* You can create a PhoneNumber object from PhoneNumber.getRegionInfoFromPhoneNumber(String phoneNumber, [String isoCode]); 
* You can now parse phoneNumber by calling   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

Usage #

Constructors #

s/nConstructor
1InternationalPhoneNumberInput
2InternationalPhoneNumberInput.withCustomDecoration
3InternationalPhoneNumberInput.withCustomBorder

Available Parameters #

InternationalPhoneNumberInput({
    Key key,
    @required this.onInputChanged,
    this.onInputValidated,
    this.focusNode,
    this.textFieldController,
    this.onSubmit,
    this.keyboardAction,
    this.countries,
    this.textStyle,
    this.inputBorder,
    this.inputDecoration,
    this.initialCountry2LetterCode = 'NG',
    this.hintText = 'Phone Number',
    this.autoValidate = false,
    this.formatInput = true,
    this.errorMessage = 'Invalid phone number',
    });
ParameterDatatypeInitial ValueDefault [1]Decoration [2]CustomBorder [3]
onInputChangefunction(PhoneNumber)null✔️✔️✔️
onInputValidatedfunction(string)null✔️✔️✔️
focusNodeFocusNodenull✔️✔️✔️
textFieldControllerTextEditingControllerTextEditingController()✔️✔️✔️
onSubmitFunction()null✔️✔️✔️
keyboardActionTextInputActionnull✔️✔️✔️
countriesListnull✔️✔️✔️
textStyleTextStylenull✔️✔️✔️
inputBorderInputBordernull✔️✔️
inputDecorationInputDecorationnull✔️✔️
initialCountry2LetterCodeStringNG✔️✔️✔️
hintTextStringPhone Number✔️✔️
autoValidatebooleantrue✔️✔️✔️
formatInputbooleantrue✔️✔️✔️
errorMessageStringInvalid phone number✔️✔️

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.

Dependencies #

Credits #

A special thanks to niinyarko

102
likes
70
pub points
95%
popularity

A simple and customizable flutter package on International Phone Number Input.

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

ogunye4nao@gmail.com

License

MIT (LICENSE)

Dependencies

flutter, libphonenumber, provider

More

Packages that depend on intl_phone_number_input