fl_country_code_picker

A Flutter package for showing a modal that contains country dial code. The user can search for the available codes and select right from the modal. Also, it has an automatic scrolling feature that points at current device's locale. Supports localizations!

Where do the data come from? Check the references for more information about the data.

📌 Examples

🕹️ Usage

Instantiate FlCountryCodePicker class to access the package's functionalities and properties. You can also pass some optional parameters to customize the picker's view.

/// Default.
final countryPicker = const  FlCountryCodePicker();

/// With custom params.
final countryPickerWithParams = const FlCountryCodePicker(
      localize: true,
      showDialCode: true,
      showSearchBar: true,
      favoritesIcon: _yourIcon,
      favorites: _yourFavorites,
      title: _yourModalTitleWidget,
      filteredCountries: _yourFilters,
      countryTextStyle: _yourCountryTextStyle,
      dialCodeTextStyle: _yourdialCodeTextStyle,
      searchBarDecoration: _yourInputDecoration,
    );

Call the modal for country code picker.

    GestureDetector(
    onTap: () async {
        // Show the country code picker when tapped.
        final picked= await countryPicker.showPicker(context: context);
        // Null check
        if (picked!= null) print(picked);
    },
    child: Container(
        padding: const  EdgeInsets.symmetric(
        horizontal: 8.0, vertical: 4.0),
        margin: const  EdgeInsets.symmetric(horizontal: 8.0),
        decoration: const  BoxDecoration(
        color: Colors.blue,
        borderRadius: BorderRadius.all(Radius.circular(5.0))),
        child: Text('Show Picker', style: const  TextStyle(color: Colors.white)),
        ),
    ),

To enable localization, add the following lines in your MaterialApp.

import  'package:fl_country_code_picker/fl_country_code_picker.dart' as flc;

MaterialApp(
    title: 'Your App',
    // Supported locales at the moment.
    // Cannot find your locale? Please make a request.
    supportedLocales: flc.CountryLocalizations.supportedLocales.map(Locale.new),
    localizationsDelegates: const [
        // Package's localization delegate.
        // You can still add other delegates from your app.
        CountryLocalizations.delegate,
    ],
    // ... some omitted values
);

🆕 What's New?

• Added i18n support for Burmese (Myanmar)
• Improved documentation by adding data references.

• Added support for National Significant Numbers (NSN) per country.

  • Check the example for default view to use NSN.
  

FlCountryCodePicker

FlCountryCodePicker class contains all of the functionalities of this package. This contains (optional) properties that can be supply to achieve customization at picker's view or appearance.

showPicker

showPicker is a method under the FlCountryCodePicker that can be used to show and customize the country code picker modal.

CountryCode

CountryCode model can be used to manipulate the selected country code by the user.

❓ FAQ:

• How to use country code's flag directory in Image widget?

  Image.asset(
      fit: fit,
      width: width,
      countryCode.flagUri,
      alignment: alignment,
      package: countryCode.flagImagePackage,
  );

  • How to change modal's title?

First, Create your title Widget.

    const Widget title = Padding(
        padding: EdgeInsets.all(16),
        child: Text(
        'My Title',
        style: TextStyle(fontSize: 20, fontWeight: FontWeight.bold),
        ),
    );

Then pass it to FlCountryCodePicker's title parameter.

countryPicker = const  FlCountryCodePicker(title: title);

📚 References

• Internationalization Codes: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
• Country Codes: https://countrycode.org
• International Call Prefixes: https://www.globalcallforwarding.com/international-call-prefixes
• National Significant Number https://en.wikipedia.org/wiki/List_of_mobile_telephone_prefixes_by_country

🐞 Bugs/Requests

If you encounter any problems feel open an issue. If you feel the library is missing a feature, please raise a ticket on Github and we'll look into it. Pull request are also welcome.

📃 License

MIT License