translations_loader 1.0.1
translations_loader: ^1.0.1 copied to clipboard

Flutter library for reading translations files and transforming them into Map to be by some framework like GetX

Simple library for loading translations from assets folder. Library should be used with GetX or some similar framework as it just loads files as Map<String, String>.

Two file formats of translation files are supported:

  • json
  • properties

Features #

  • simplified internationalization
  • supported json and properties files
  • all keys from json file are converted as object1.object2.value so that they are the same as in properties file

Getting started #

You need to configure assets folder with your translation files. For instance:

flutter:
  uses-material-design: true

  assets:
    - assets/i18n/

Inside that folder you need to put all your translation files. Library does NOT use countryCode of the Locale, just languageCode.

For example:

en.json

{
  "app": {
    "name": "Test application",
    "version": "1",
    "bar": {
      "title": "My title"
    }
  }
}    

hr.properties

app.name=Testna aplikacija
app.version=1
app.bar.title=Moj naslov

And that is it, you just need to configure library inside main application and you'll have all your translations.

NOTE: You need to include flutter_localization in your pubspec:

#....
dependencies:
  flutter:
    sdk: flutter
  flutter_localizations:
    sdk: flutter

  cupertino_icons: ^1.0.3
#....

Usage #

To get translations, you just need to use static method loadTranslations inside TranslationsLoader class. For instance: TranslationsLoader.loadTranslations("assets/i18n").

To use this library with GetX library, you need to implement Translations class:

class ApplicationTranslations extends Translations {
  final Map<String, Map<String, String>> _translationKeys;

  ApplicationTranslations(this._translationKeys);

  @override
  Map<String, Map<String, String>> get keys => _translationKeys;
}

Then you can use it when setting your GetMaterialApp:

Future<void> main() async {
  // ...

  runApp(GetMaterialApp(
    translations: ApplicationTranslations(await TranslationsLoader.loadTranslations("assets/i18n")),
    locale: Get.deviceLocale,
    fallbackLocale: defaultLocale,
    supportedLocales: supportedLocales,
    localizationsDelegates: const [
      GlobalMaterialLocalizations.delegate,
      GlobalWidgetsLocalizations.delegate,
      GlobalCupertinoLocalizations.delegate,
    ],
    // .....
  ));
}

Additional information #

alt text

0
likes
130
pub points
31%
popularity

Publisher

ancronik.site

Flutter library for reading translations files and transforming them into Map to be by some framework like GetX

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

flutter

More

Packages that depend on translations_loader