LOCALIZATION.md

Localization

Add new language to app (step 1)

In ${FLUTTER_PROJECT}/assets/translations, add the en.json template file. For example:

en.json

{  
  "helloWorld": "Hello World!"  
}

{} is used to place arguments and {name} for named arguments.

Important: After any update of .json file you need to run this command for generate LocaleKeys file.

flutter pub run easy_localization:generate -S ./assets/translations -s en.json -f keys

Step 2

To add a new language translation in the app you need to add an fr.json file in the same directory for French translation of the same message: fr.json

{  
  "helloWorld": "Bonjour le Monde"  
}

then run this command

flutter pub run easy_localization:generate -S ./assets/translations -s en.json -f keys

and update constants.dart file to:

const List<Locale> localeList = [Locale('en'), Locale('fr')];

Step 3

Translate text lets suppose we start with this code

home.dart

  
  ..

  Widget build(BuildContext context) {
    return Row(
      children: <Widget>[
          Text(
            'Hello World'
          ),
          Text(
            'Welcome'
          ),
        ]
    );
  }

and we want to translate Hello World text to french when people device localization is french language home.dart

import 'package:easy_localization/easy_localization.dart';
import 'package:web_dex/generated/codegen_loader.g.dart';

  ...
  
  Widget build(BuildContext context) {
    return Row(
      children: <Widget>[
          Text(
            LocaleKeys.helloWorld.tr() 
          ),
          Text(
            'Welcome'
          ),
        ]
    );
  }

How to translate string with variable

How to translate sentence with the variables in it, say 10 and KMD in Max amount is 10 KMD, please select other amount?

  Text('Max amount is $amount $kmd, please select other amount') // amount & kmd is variable

Process:

• Add declaration in json file en.json

{  
  "maxMount": "Max amount is {amount} {coinAbbr}, please select other amount"
}

• update your code like the following snippet

  Text(LocaleKeys.maxMount.tr(namedArgs:{amount:10, coinAbbr:'KMD'}))

or you can just use arguments like the following example

• Add declaration in json file en.json

{  
  "maxMount": "Max amount is {} {}, please select other amount"  
}

• update your code like the following snippet

  Text(LocaleKeys.maxMount.tr(args:[10,'KMD'])) 

how to deal with Plurals?

update the value of required key in json file like following

en.json

{
  "money": {
    "zero": "You have no money",
    "one": "You have {} dollar",
    "two": "You have {} dollars",
    "many": "You have {} dollars",
    "few": "You have {} dollars",
    "other": "You have {} dollars"
  },
  "money_args": {
    "zero": "{} has no money",
    "one": "{} has {} dollar",
    "two": "{} has {} dollars",
    "many": "{} has {} dollars",
    "few": "{} has {} dollars",
    "other": "{} has {} dollars"
  }
}

• update your code like the following snippet

  Text(LocaleKeys.money.plural(10.23)),
  Text(LocaleKeys.money_args.plural(10.23,args:['John', '10.23'])), 

please note that after adding or removing any items in the translation json file, you need to run the following command

flutter pub run easy_localization:generate -S ./assets/translations -s en.json -f keys