country_codes_plus 5.0.2

Country code plus is a helper package that provides country details given a particular localization, such as dial codes, ISO 3166 codes (alpha-2, alpha-3) and country names.

country_codes_plus

A Flutter plugin that provides country details (ISO codes, dial codes, names) based on a Locale.

Features

• Resolve country details from device locale or a provided Locale.
• Access ISO 3166 alpha-2/alpha-3 codes and dial codes.
• Optional localized country names with init.
• Input formatter for phone dial codes.

Installation

Add the dependency in pubspec.yaml:

dependencies:
  country_codes_plus: ^5.0.2

Then run:

flutter pub get

Compatibility Matrix

Component	Supported
Dart SDK	>=3.0.0 <4.0.0
Flutter SDK	>=3.7.0
Android	Supported
iOS	Supported
macOS	Supported
Web	Not officially supported (init should be avoided on web)

Quick Start

import 'package:country_codes_plus/country_codes_plus.dart';

Future<void> setup() async {
  await CountryCodes.init();

  final locale = CountryCodes.getDeviceLocale();
  final details = CountryCodes.detailsForLocale();

  print(locale); // e.g. en_US
  print(details.alpha2Code); // e.g. US
  print(details.alpha3Code); // e.g. USA
  print(details.dialCode); // e.g. +1
  print(details.name); // e.g. United States
}

Usage

Import the package:

import 'package:country_codes_plus/country_codes_plus.dart';

Initialize (device locale)

await CountryCodes.init();

final Locale deviceLocale = CountryCodes.getDeviceLocale();
final CountryDetails details = CountryCodes.detailsForLocale();

print(details.alpha2Code); // e.g. US
print(details.alpha3Code); // e.g. USA
print(details.dialCode);   // e.g. +1
print(details.name);       // e.g. United States
print(details.localizedName); // localized if init() received an app locale

Use a custom Locale

final CountryDetails details =
    CountryCodes.detailsForLocale(const Locale('pt', 'PT'));

print(details.alpha2Code); // PT
print(details.dialCode);   // +351
print(details.name);       // Portugal

Locale without region

If a Locale has no country (e.g. Locale('en')), the package tries to infer a country from language. English defaults to US.

Lookup by alpha-2 code

final CountryDetails sk = CountryCodes.detailsFromAlpha2('SK');
print(sk.dialCode); // +421

Error handling

final name = CountryCodes.name(
  locale: const Locale('xx', 'YY'),
  onInvalidLocale: () => debugPrint('Invalid locale'),
);

Formatters

DialCodeFormatter

TextFormField(
  keyboardType: TextInputType.phone,
  inputFormatters: [DialCodeFormatter()],
);

Platform support

• Android, iOS, macOS: supported
• Web: not officially supported (avoid calling init on web)

Migration

• If you are upgrading from country_codes, update dependency and imports to country_codes_plus.
• Legacy import package:country_codes_plus/country_code_plus.dart remains available as a re-export.

Example App

• See the example app in example/.

Contributing

• PRs are welcome. Please read CONTRIBUTING.md first.
• Use issue templates for bug reports and feature requests.

Security

• For vulnerability reporting, see SECURITY.md.

License

MIT, see LICENSE.