intl_mobile_field 2.0.0

A customized Flutter TextFormField to input international Mobile number along with country code.

---

A customized Flutter TextFormField to input an international Mobile number along with the country code.

intl_mobile_field is a powerful and flexible Flutter package designed to handle international phone number input easily. It offers advanced features, improved compatibility, and enhanced customization options to meet modern development needs. Visit the Changelog to stay updated on the latest additions and improvements.

• Installing
• How to Use
• Supported Languages
• Contributing
• Maintainers
• LICENSE

Installing

To use this package:

Run this command:

flutter pub add intl_mobile_field

Or, add the following to your pubspec.yaml file under dependencies:

intl_mobile_field: ^2.0.0

Sometimes you may want to use the latest version of the package, instead of a published version. To do that, use the git syntax:

dependencies:
  intl_mobile_field:
    git:
      url: https://github.com/MdAshrafUllah/intl_mobile_field.git
      ref: master

How to Use

import the url

import 'package:intl_mobile_field/intl_mobile_field.dart';

For FlagsDropDown you have to import.

import 'package:intl_mobile_field/flags_drop_down.dart';

Simply create a IntlMobileField widget, and pass the required params:

Example: 1 (without favorite)

IntlMobileField(
  prefixIcon: FlagsDropDown(
    initialCountryCode: 'BD', // initial Country is Bangladesh
    languageCode: "en", // initial language is English
  ),
  decoration: const InputDecoration(
    labelText: 'Mobile Number',
    border: OutlineInputBorder(
      borderSide: BorderSide(),
    ),
  ),
  disableLengthCounter: true,
),

output

Example: 2 (with favorite - style one)

IntlMobileField(
  prefixIcon: FlagsDropDown(
    favorite: const ['BD', 'US', 'MY'],
    favoriteIcon: Icon(
      Icons.star,
      color: Colors.amber,
    ),
    favoriteIconPosition: Position.trailing,
    favoriteCountryCodePosition: Position.trailing,
    initialCountryCode: 'BD',
    languageCode: "en", // default is 'en'
    onCountryChanged: (country) {
      log('Country changed to: ${country.name}');
    },
  ),
  decoration: const InputDecoration(
    labelText: 'Mobile Number',
    border: OutlineInputBorder(
      borderSide: BorderSide(),
    ),
  ),
  disableLengthCounter: true,
  onChanged: (mobile) {
    log(mobile.completeNumber);
  },
),

output

Example: 3 (with favorite - style two)

IntlMobileField(
  prefixIcon: FlagsDropDown(
    favorite: const ['BD', 'US', 'MY'],
    favoriteIcon: Icon(
      Icons.favorite,
      color: Colors.pinkAccent,
    ),
    favoriteIconPosition: Position.trailing,
    initialCountryCode: 'BD',
    languageCode: "en", // default is 'en'
    onCountryChanged: (country) {
      log('Country changed to: ${country.name}');
    },
  ),
  decoration: const InputDecoration(
    labelText: 'Mobile Number',
    border: OutlineInputBorder(
      borderSide: BorderSide(),
    ),
  ),
  disableLengthCounter: true,
  onChanged: (mobile) {
    log(mobile.completeNumber);
  },
),

output

Use initialCountryCode to set an initial Country Code.

For PickerDialogStyle you have to import.

import 'package:intl_mobile_field/country_picker_dialog.dart';

Example 4 (FlagDropDown)

FlagsDropDown(
  countryCodeDisable: true,
  onCountryChanged: (country) {
    debugPrint('Country changed to: ${country.name}');
  },
  flagWidth: 150,
),

Output

Example 5 (FlagImage)

FlagImage(
  countryCode: 'BD',
  width: 150,
  height: 150,
),

Output

Example 6 (Validation Message)

When you want to show a validation message you can pass it through invalidNumberMessage

IntlMobileField(
  decoration: InputDecoration(
    labelText: "Mobile Number",
    border: OutlineInputBorder(),
  ),
  invalidNumberMessage: "Enter a Valid Number",
),

Output

Example 7 (Custom Validation)

you can add your own validation message.

IntlMobileField(
  decoration: InputDecoration(
    prefixIcon: FlagsDropDown(),
    labelText: "Mobile Number",
    border: OutlineInputBorder(),
  ),
  invalidNumberMessage:
      "Enter a Valid Number", // fallback error message
  validator: (mobileNumber) {
    if (mobileNumber == null || mobileNumber.number.isEmpty) {
      return 'Please enter a mobile number';
    }
    if (!RegExp(r'^[0-9]+$').hasMatch(mobileNumber.number)) {
      return 'Only digits are allowed';
    }
    return null;
  },
),

Output

RTL Support

If you select languageCode Arabic, Urdu, Persian, or Cantonese (Chinese), the flag will automatically be on the right, and the country code will automatically be on the left. You can also turn off RLT Support by adding rltSupport: false.

output

LRT Languages	RLT Language

Supported Languages

We support more than 20 languages, including:

Code	Language	Code	Language
hu	Hungarian	ar	Arabic
sk	Slovak	fa	Persian
se	Swedish	yue	Cantonese (Chinese)
pl	Polish	bd	Bangla (Bangladesh)
no	Norwegian	in	Hindi (India)
ja	Japanese	ur	Urdu (Pakistan)
it	Italian	pt_br	Brazilian Portuguese
zh	Simplified Chinese	sr_cyrl	Serbian (Cyrillic)
nl	Dutch	sr_latn	Serbian (Latin)
de	German	zh_tw	Traditional Chinese
fr	French	tr	Turkish
es	Spanish	ro	Romanian
en	English

Enjoy multilingual support with easy-to-read formatting!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Comment on Issue or Pull Request.

Maintainers

• Md Ashraf Ullah

LICENSE

This project is licensed under the MIT license. See LICENSE for more information.