easy_localization 3.0.0-dev.1
easy_localization: ^3.0.0-dev.1 copied to clipboard

Easy and Fast internationalizing and localization your Flutter Apps, this package simplify the internationalizing process .

Easy and Fast internationalization for your Flutter Apps

Pub Version likes likes likes Code Climate issues GitHub closed issues GitHub contributors GitHub repo size GitHub forks GitHub stars Coveralls github branch GitHub Workflow Status CodeFactor Grade GitHub license Sponsors PRs Welcome

Why easy_localization? #

  • πŸš€ Easy translations for many languages
  • πŸ”Œ Load translations as JSON, CSV, Yaml, Xml using Easy Localization Loader
  • πŸ’Ύ React and persist to locale changes
  • ⚑ Supports plural, gender, nesting, RTL locales and more
  • ⁉️ Error widget for missing translations
  • ❀️ Extension methods on Text and BuildContext
  • πŸ’» Code generation for localization files and keys.

Getting Started #

πŸ”© Installation #

Add to your pubspec.yaml:

  easy_localization: <last_version>

Create folder and add translation files like this

└── translations
    β”œβ”€β”€ {languageCode}.{ext}                  //only language code
    └── {languageCode}-{countryCode}.{ext}    //or full locale code


└── translations
    β”œβ”€β”€ en.json
    └── en-US.json 

Declare your assets localization directory in pubspec.yaml:

    - assets/translations/

πŸ”Œ Loading translations from other resources #

You can use JSON,CSV,HTTP,XML,Yaml files, etc.

See Easy Localization Loader for more info.

⚠️ Note on iOS #

For translation to work on iOS you need to add supported locales to ios/Runner/Info.plist as described here.



βš™οΈ Configuration app #

Add EasyLocalization widget like in example

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:easy_localization/easy_localization.dart';

void main() async {
  await EasyLocalization.ensureInitialized();
      supportedLocales: [Locale('en', 'US'), Locale('de', 'DE')],
      path: 'assets/translations', // <-- change patch to your
      fallbackLocale: Locale('en', 'US'),
      child: MyApp()

class MyApp extends StatelessWidget {
  Widget build(BuildContext context) {
    return MaterialApp(
      localizationsDelegates: context.localizationDelegates,
      supportedLocales: context.supportedLocales,
      locale: context.locale,
      home: MyHomePage()

Full example

πŸ“œ Easy localization widget properties #

keyfalseWidget key.
childtruePlace for your main page widget.
supportedLocalestrueList of supported locales.
pathtruePath to your folder with localization files.
assetLoaderfalseRootBundleAssetLoader()Class loader for localization files. You can use custom loaders from Easy Localization Loader or create your own class.
fallbackLocalefalseReturns the locale when the locale is not in the list supportedLocales.
startLocalefalseOverrides device locale.
saveLocalefalsetrueSave locale in device storage.
useOnlyLangCodefalsefalseTrigger for using only language code for reading localization files.

en.json //useOnlyLangCode: true
en-US.json //useOnlyLangCode: false
errorWidgetfalseFutureErrorWidget()Shows a custom error widget when an error occurs.

Usage #

πŸ”₯ Initialize library #

Call EasyLocalization.ensureInitialized() in your main before runApp.

void main() async{
  // ...
  // Needs to be called so that we can await for EasyLocalization.ensureInitialized();

  await EasyLocalization.ensureInitialized();
  // ...
  // ...

πŸ”₯ Change or get locale #

Easy localization uses extension methods [BuildContext] for access to locale.

It's more easiest way change locale or get parameters πŸ˜‰.

ℹ️ No breaking changes, you can use old the static method EasyLocalization.of(context)


context.locale = Locale('en', 'US');


πŸ”₯ Translate tr() #

Main function for translate your language keys

You can use extension methods of [String] or [Text] widget, you can also use tr() as a static function.

Text('title').tr() //Text widget

print('title'.tr()); //String

var title = tr('title') //Static function


contextBuildContextThe location in the tree where this widget builds
argsList<String>List of localized strings. Replaces {} left to right
namedArgsMap<String, String>Map of localized strings. Replaces the name keys {key_name} according to its name
genderStringGender switcher. Changes the localized string based on gender string


   "msg":"{} are written in the {} language",
   "msg_named":"Easy localization are written in the {lang} language",
   "msg_mixed":"{} are written in the {lang} language",
      "male":"Hi man ;) {}",
      "female":"Hello girl :) {}",
      "other":"Hello {}"
// args
Text('msg').tr(args: ['Easy localization', 'Dart']),

// namedArgs
Text('msg_named').tr(namedArgs: {'lang': 'Dart'}),

// args and namedArgs
Text('msg_mixed').tr(args: ['Easy localization'], namedArgs: {'lang': 'Dart'}),

// gender
Text('gender').tr(gender: _gender ? "female" : "male"),

πŸ”₯ Plurals plural() #

You can translate with pluralization. To insert a number in the translated string, use {}. Number formatting supported, for more information read NumberFormat class documentation.

You can use extension methods of [String] or [Text] widget, you can also use plural() as a static function.


contextBuildContextThe location in the tree where this widget builds
valuenumNumber value for pluralization
argsList<String>List of localized strings. Replaces {} left to right
formatNumberFormatFormats a numeric value using a NumberFormat class


  "day": {
    "zero":"{} Π΄Π½Π΅ΠΉ",
    "one": "{} дСнь",
    "two": "{} дня",
    "few": "{} дня",
    "many": "{} Π΄Π½Π΅ΠΉ",
    "other": "{} Π΄Π½Π΅ΠΉ"
  "money": {
    "zero": "You not have money",
    "one": "You have {} dollar",
    "many": "You have {} dollars",
    "other": "You have {} dollars"
  "money_args": {
    "zero": "{} has no money",
    "one": "{} has {} dollar",
    "many": "{} has {} dollars",
    "other": "{} has {} dollars"

⚠️ Key "other" required!

//Text widget with format
Text('money').plural(1000000, format: NumberFormat.compact(locale: context.locale.toString())) // output: You have 1M dollars

print('day'.plural(21)); // output: 21 дСнь

//Static function
var money = plural('money', 10.23) // output: You have 10.23 dollars

//Static function with arguments
var money = plural('money_args', 10.23, args: ['John', '10.23'])  // output: John has 10.23 dollars

Linked translations: #

If there's a translation key that will always have the same concrete text as another one you can just link to it. To link to another translation key, all you have to do is to prefix its contents with an @: sign followed by the full name of the translation key including the namespace you want to link to.


  "example": {
    "hello": "Hello",
    "world": "World!",
    "helloWorld": "@:example.hello @:example.world"
print('example.helloWorld'.tr()); //Output: Hello World!

You can also do nested anonymous and named arguments inside the linked messages.


  "date": "{currentDate}.",
  "dateLogging": "INFO: the date today is @:date"
print('dateLogging'.tr(namedArguments: {'currentDate': DateTime.now().toIso8601String()})); //Output: INFO: the date today is 2020-11-27T16:40:42.657.

Formatting linked translations: #

Formatting linked locale messages If the language distinguishes cases of character, you may need to control the case of the linked locale messages. Linked messages can be formatted with modifier @.modifier:key

The below modifiers are available currently.

  • upper: Uppercase all characters in the linked message.
  • lower: Lowercase all characters in the linked message.
  • capitalize: Capitalize the first character in the linked message.


  "example": {
    "fullName": "Full Name",
    "emptyNameError": "Please fill in your @.lower:example.fullName"


print('example.emptyNameError'.tr()); //Output: Please fill in your full name

πŸ”₯ Delete save locale deleteSaveLocale() #

Clears a saved locale from device storage


  onPressed: (){
  child: Text(LocaleKeys.reset_locale).tr(),

πŸ”₯ Get Easy localization widget properties #

At any time, you can take the main properties of the Easy localization widget using [BuildContext].

Are supported: supportedLocales, fallbackLocale, localizationDelegates.


print(context.supportedLocales); // output: [en_US, ar_DZ, de_DE, ru_RU]

print(context.fallbackLocale); // output: en_US

πŸ’» Code generation #

Code generation supports only json files, for more information run in terminal flutter pub run easy_localization:generate -h

Command line arguments #

--help-hHelp info
--source-dir-Sresources/langsFolder containing localization files
--source-file-sFirst fileFile to use for localization
--output-dir-Olib/generatedOutput folder stores for the generated file
--output-file-ocodegen_loader.g.dartOutput file name
--format-fjsonSupport json or keys formats

πŸ”Œ Localization asset loader class #


  1. Open your terminal in the folder's path containing your project
  2. Run in terminal flutter pub run easy_localization:generate
  3. Change asset loader and past import.
  import 'generated/codegen_loader.g.dart';
  void main(){
      child: MyApp(),
      supportedLocales: [Locale('en', 'US'), Locale('ar', 'DZ')],
      path: 'resources/langs',
      assetLoader: CodegenLoader()
  1. All done!

πŸ”‘ Localization keys #

If you have many localization keys and are confused, key generation will help you. The code editor will automatically prompt keys


  1. Open your terminal in the folder's path containing your project
  2. Run in terminal flutter pub run easy_localization:generate -f keys -o locale_keys.g.dart
  3. Past import.
import 'generated/locale_keys.g.dart';
  1. All done!

How to usage generated keys:

print(LocaleKeys.title.tr()); //String
Text(LocaleKeys.title).tr(); //Widget

Screenshots #

Arabic RTLEnglish LTRError widget
Arabic RTLEnglish LTRError widget

Donations #

We need your support. Projects like this can not be successful without support from the community. If you find this project useful, and would like to support further development and ongoing maintenance, please consider donating.

Sponsors #

Contributors thanks #


pub points

Easy and Fast internationalizing and localization your Flutter Apps, this package simplify the internationalizing process .

Repository (GitHub)
View/report issues






args, flutter, flutter_localizations, intl, path, shared_preferences


Packages that depend on easy_localization