phrase 1.0.4 icon indicating copy to clipboard operation
phrase: ^1.0.4 copied to clipboard

Phrase over-the-air translations library for Flutter

Phrase OTA for Flutter #

Library for Phrase over-the-air translations.

Installation #

Important: this library depends on 0.17.0 version of Flutter's intl library. Please follow this guide to add localizations support to your app.

Add Phrase to your pubspec.yaml:

dependencies:
  phrase: ^1.0.4
  ...
  intl: ^0.17.0
  flutter_localizations:
    sdk: flutter
  ...

flutter:
  generate: true
  ...

Just like intl library, Phrase uses code generation to process your ARB files. To keep it up-to-date, just run this command:

flutter pub run phrase

or if you're using build_runner:

flutter pub run build_runner watch

Usage #

Initialize Phrase in your main.dart file:

import 'package:flutter/material.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
import 'package:flutter_gen/gen_l10n/phrase_localizations.dart';
import 'package:phrase/phrase.dart';

void main() {
  Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]");
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      //..
      localizationsDelegates: PhraseLocalizations.localizationsDelegates,
      supportedLocales: PhraseLocalizations.supportedLocales,
    );
  }
}

That's it! You can access your messages just like you did before:

Text(AppLocalizations.of(context)!.helloWorld);

But now your app will check for updated translations in Phrase regularly and download them in the background.

Customization #

Update behavior #

By default, Phrase will update OTA translations every time the app launches.<br/> You can disable this behavior:

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]", checkForUpdates: false);

and trigger updates manually:

Phrase.updateTranslations(context).then((_) => print("Done!"));

Custom app version #

The SDK will use the app version by default to return a release which matches the release constraints for the min and max version. The app version has to use semantic versioning otherwise no translation update will be returned. In case your app does not use semantic versioning it is possible to manually override the app version:

Phrase.setup("[DISTRIBUTION_ID]", "[ENVIRONMENT_ID]", customAppVersion: "1.2.3");
7
likes
90
pub points
87%
popularity

Publisher

verified publisher iconphrase.com

Phrase over-the-air translations library for Flutter

Homepage

Documentation

API reference

License

Icon for licenses.unknown (LICENSE)

Dependencies

build, crypto, flutter, glob, http, intl, package_info_plus, path, path_provider, shared_preferences, synchronized, uuid, yaml

More

Packages that depend on phrase