Skip to content

julienandco/firebase_remote_config_localization_loader

Repository files navigation

firebase_remote_config_localization_loader

Features

Lets you easily set up the internationalization of your app with files that are stored in FirebaseRemoteConfig.

Getting started

  • Make sure you are using Easy Localization to internationalize your app, as this package provides an AssetLoader instance, which is defined in the Easy Localization package.
  • Add the dependency to the package to your pubspec.yaml:
dependencies:
  firebase_remote_config_localization_loader:
    git: 
        url: https://github.com/julienandco/firebase_remote_config_localization_loader
        ref: main

Usage

  • Add the following code to the main.dart of your application:
...
final supportedLocales = [const Locale('de'), const Locale('en')]; // Add your supported locales here

final localizationLoader =
    FirebaseRemoteConfigLocalizationLoader(
        configData: 
            FirebaseRemoteConfigData(
            remoteConfigInstance: FirebaseRemoteConfig.instance,
            supportedLocales: supportedLocales,
            buildRemoteConfigStringFromLocale: // Add your custom implementation here
                (locale) => 
                    'tran_${locale.languageCode}',
            ),
        fallbackAssetPath: '<your_path_to_the_local_translation_files>',
    );
await localizationLoader.init();

runApp(
    EasyLocalization(
        path: localizationLoader.path,
        assetLoader: localizationLoader.assetLoader,
        supportedLocales: supportedLocales,
        fallbackLocale: const Locale('de'),
        saveLocale: true,
        useFallbackTranslations: true,
        useOnlyLangCode: true,
        child: const App(),
    ),
);
...

🚨 If you did not use FirebaseRemoteConfig before, you need to initialize it first. You can do this by adding the following code to the main.dart of your application, BEFORE instantiating the FirebaseRemoteConfigLocalizationLoader:

final remoteConfig = FirebaseRemoteConfig.instance;

await remoteConfig.setConfigSettings(
    RemoteConfigSettings(
      fetchTimeout: const Duration(minutes: 1),
      minimumFetchInterval: const Duration(hours: 1),
    ),
  );
await remoteConfig.fetchAndActivate();

Additional information

Feel free to contact me if you have any questions, open some pull requests, or want to contribute to this package.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages