This is an adaptation of i18next standard for Dart with support for Flutter localization techniques. This package is still a work in progress.
Mind that this is still a pre-1.0.0 so breaking changes may occur frequently.
[x] Support for variables
[x] Support for namespaces
[x] Support for context
[x] Support for simple plural forms (one or plural)
[x] Support for multiple plural forms (one, few, many, plural, ...)
[x] Plural and context fallbacks
[x] Locale and namespace fallbacks
[x] Get string or object tree
[x] Support for nesting
[x] Flutter's LocalizationsDelegate support
[x] Asset bundle localizations data source (retrieves from pubspec.yaml). See the example for more details.
[ ] Sprintf support
[ ] Resource caching
[ ] Custom post-processing
[ ] ~Retrieve resource files from server~ (won't do, see https://github.com/williamhjcho/i18next/issues/27)
Usage
Simples way to add the latest version is to run flutter pub add i18next
Or you can declare it directly into your pubspec.yaml file:
dependencies:i18next:^0.9.0# (or the latest version available)
To use it with flutter's LocalizationsDelegate you first create I18NextLocalizationDelegate and register it in your WidgetsApp (MaterialApp or CupertinoApp).
I18NextLocalizationDelegate(
locales: widget.locales,
// this data source is from where the delegate will retrieve the localizations from (namespaces Map)
dataSource: ...,
// optional extra options can be added here
options: I18NextOptions(...),
),
Then to access and use it, simply call
Widgetbuild(BuildContext context) {
// It finds the i18next instance on the widgets tree via `Localizations.of`I18Next.of(context).t(...);
...
}
But if you want to handle it yourself, then simply instantiate it:
I18Next(
locale,
// This store is from where i18next will attempt to retrieve the localizations from.
resourceStore: ...,
// Optional extra options can be added here
options: I18NextOptions(...)
);
{"key1":"{{text, uppercase}} just uppercased","key2":"The current date is {{now, datetime(format:dd/MM/yyyy)}}","key3":"Right now we are in {{now, datetime(format:MMM), uppercase}}."}
i18next.t('key1', arguments: { 'text': 'my text' }); // 'MY TEXT just uppercased'
i18next.t('key2', arguments: { 'now': DateTime.now() }); // 'The current date is 21/01/2020'
i18next.t('key3', arguments: { 'now': DateTime.now() }); // 'Right now we are in JAN.'
There are other usages and possibilities as well, this is just an example of what is defined by this format.
Namespaces: A namespace can be thought of as logical groupings of different sets of translations. In a given namespace you could have a set of languages, each with their own set of keys. They can also be understood as separate files.
For example:
common.json: Things that are reused everywhere, eg. Button labels 'save', 'cancel'
validation.json: All validation texts
glossary.json: Words we want to be reused consistently inside texts
// common.json{"myKey":"This key is in common"}// feature.json{"myKey":"This key is in my feature"}
i18next.t('common:myKey'); // 'This key is in common'
i18next.t('feature:myKey'); // 'This key is in my feature'
i18next.t('friend'); // 'A friend'
i18next.t('friend', count: 1); // 'A friend'// It fallbacks to `friend` since `friend_plural` is not present
i18next.t('friend', count: 2); // 'A friend'
i18next.t('friend', context: 'female'); // 'A girlfriend'// It fallbacks to `friend` since `friend_male` is not present
i18next.t('friend', context: 'male'); // 'A friend'
There is a way to also set the default namespace or a order of namespaces so a key knows where to start looking for the translation.