language_helper 0.9.0+2

Easy way to implement multiple languages (localizations) into your app with minimal effort.

Language Helper

An easy way to implement multiple languages (localizations) into your app with minimal effort.

Features

• Easy to control the language translations in your application. Automatically uses the current device locale upon first open, if possible.

• You can completely control the translated text with LanguageConditions.

• Supports analyzing which text is missing in a specific language.

• Supports analyzing which text is in your app but not in your language data, and vice versa.

• Supports extracting the needed text for translation from all .dart files in your project with a single command. dart run language_helper:generate (still in the early stages). Original package is language_helper_generator.

Usage

Here is your translation (can be created with language_helper_generator):

final en = {
  'Hello @{name}': 'Hello @{name}',
  'We have @{number} dollar': LanguageCondition(
    param: 'number',
    conditions: {
      '0': 'We have zero dollar',
      '1': 'We have one dollar',

      // Default value.
      '_': 'We have @{number} dollars',
    }
  ),
};

const vi = {
  'Hello @{name}': 'Xin chào @{name}',
  'We have @{number} dollar': 'Chúng ta có @{number} đô-la', 
};

LanguageData languageData = {
  LanguageCodes.en: en,
  LanguageCodes.vi: vi,
};

With LanguageConditions, you can completely control which text is returned according to the parameters' conditions. You can use 'default' or '_' to set the default value for the condition.

Initialize the data:

final languageHelper = LanguageHelper.instance;

main() async {
  // LanguageHelper should be initialized before calling `runApp`.
  await languageHelper.initial(
      // This is [LanguageData] and it must not be empty.
      data: languageData,
      // Like the `languageData` but with higher priority.
      dataOverrides: languageDataOverrides,
      // Default is set to the device locale (if available) or the first language of the `languageData`.
      initialCode: LanguageCodes.en,
      // Changes the app language when the device language changes. Default is set to `true`.
      syncWithDevice: true,
  );

  runApp(const MyApp());
}

Implement flutter localizations to your app like this

class App extends StatelessWidget {
  const App({super.key});

  @override
  Widget build(BuildContext context) {
    return LanguageBuilder(
      builder: (context) {
        return MaterialApp(
          localizationsDelegates: languageHelper.delegate,
          supportedLocales: languageHelper.locales,
          locale: languageHelper.locale,
          home: const HomePage(),
        );
      }
    );
  }
}

Here is your Widgets:

Using LanguageBuilder

LanguageBuilder(
    builder: (context) {
        return Scaffold(
          body: Column(
            children: [
              Text('Hello @{name}'.tr),
              Text('We have @{number} dollar'.tr),
            ],
          ),
        );
    },
),

Using Tr (A short version of LanguageBuilder)

Tr((_) => Text('Hello @{name}'.tr)),

Change the language:

languageHelper.change(LanguageCodes.vi);

Add a new language data:

languageHelper.addData(newLanguageData);
languageHelper.addDataOverrides(newLanguageDataOverrides);

The addData and addDataOverrides have activate parameter which automaticaly rebuild all needed LanguageBuilder, so notice that you may get the setState issue because of the rebuilding of the LanguageBuilder when it's still building. If the error occurs, you may need to set it to false and activate the new data yourself by using reload method.

Get list of implemented LanguageCodess:

// List of [LanguageCodes] from the [data]
final codes = languageHelper.codes;

// List of [LanguageCodes] from the [dataOverrides]
final codesOverrides = languageHelper.codesOverrides;

// List of [LanguageCodes] from both of the [data] and [dataOverrides] without duplicated
final codesBoth = languageHelper.codesBoth;

Get text:

final translated = languageHelper.translate(
    'Hello @{text}, @number', 
    toCode: LanguageCodes.en, // [Optional] Translate to specific language code
    params {'text' : 'World', 'number': '10'}, // [Optional] Translate with parameters
);
// Hello World, 10

Use extension:

final translated = 'Hello'.tr;
final translatedParam = 'Hello @{text}, @number'.trP({'text': 'World', 'number': '10'});
final translatedTo = 'Hello @{text}, @number'.trT(LanguageCodes.en);
final translatedFull = 'Hello @{text}, @number'.trF(toCode: LanguageCodes.en, params: {'text': 'World', 'number': '10'});

Note: The ${param} works in all cases, the @param only work if the text ends with a white space, the end of a line, or the end of a new line.

Beside the onChanged method, you can listen to the language changed events by using stream:

final sub = languageHelper.stream.listen((code) => print(code));

Note: Remember to sub.cancel() when it's not in use to avoid memory leaks.

You can analyze the missing texts for all language with this function:

languageHelper.analyze();

This function will automatically be called in initial when isDebug is true.

Here is the result from the Example:

flutter: [Language Helper]
flutter: [Language Helper] ==================================================
flutter: [Language Helper]
flutter: [Language Helper] Analyze all languages to find the missing texts...
flutter: [Language Helper] Results:
flutter: [Language Helper]   LanguageCodes.en:
flutter: [Language Helper]     This text is missing in `en`
flutter: [Language Helper]
flutter: [Language Helper]   LanguageCodes.vi:
flutter: [Language Helper]     This text is missing in `vi`
flutter: [Language Helper]
flutter: [Language Helper] ==================================================
flutter: [Language Helper]

Language Helper Generator:

You can also create a base LanguageData by using language_helper_generator's command:

dart run language_helper:generate

If you want to change the generating path, using this:

dart run language_helper:generate --path=./example/lib

This command will also run dart format for the generated files, so you can easily manage the translations using the version control.

This runner will get all the texts that using language_helper extensions (.tr, .trP, .trT, .trF) and .translate method then creating a base structure for LanguageData. You can see the generated data in the example.

The data will be generated with this format:

|-- .lib
|   |--- resources
|   |    |--- language_helper
|   |    |    |--- _language_data_abstract.g.dart
|   |    |    |--- language_data.dart

• _language_data_abstract.g.dart: Contains your base language from your all .dart files. This file will be re-generated when you run the command.

• language_data.dart: Modifiable language data because it's only generated 1 time.

LanguageData Serialization

Convert LanguageData to JSON:

final json = data.toJson();

Convert JSON to LanguageData:

final data = LanguageDataSerializer.fromJson(json);

Additional Information

• The app will try to use the Devicelocale to set the initialCode if it is not set, if the Devicelocale is unavailable, it will use the first language in data instead.

• No matter how many LanguageBuilder that you use, the plugin only rebuilds the outest (the root) widget of LanguageBuilder, so it significantly improves performance.. And all LanguageBuilder widgets will be rebuilt at the same time. This setting can be changed with forceRebuild parameter in both initial for global setting and LanguageBuilder for local setting.

• The LanguageCodes contains all the languages with additional information like name in English (englishName) and name in native language (nativeName).

Contributions

As the project is currently in its early stages, it may contain bugs or other issues. Should you experience any problems, we kindly ask that you file an issue to let us know. Additionally, we welcome contributions in the form of pull requests (PRs) to help enhance the project.