LangTr

LangTr is a Flutter generator package designed to simplify the management of translation files in your Flutter applications.

Installation

Add lang_tr as a dependency in your pubspec.yaml file:

dependencies:
  lang_tr: <latest>

Usage

Configuration

To use LangTr, you can create a lang_tr.yaml configuration file in the root of your project or anywhere. Here's an example format for the configuration file:

lang_dir: lib/lang_tr
output_dir: lib
default_lang: fr
current_lang: en

• lang_dir: The path to the directory containing your translation files.
• output_file: The path and name of the generated translation file.
• default_lang: The default language to use if no language is specified.
• current_lang: The initial translation language.

Generating Translation Files

To generate the translation file from the configuration file, run the following command in your terminal:

dart pub run lang_tr:generate path_to_lang_tr.yaml

or without the configuration file

dart pub run lang_tr:generate

This will generate the translation file lang_tr.dart according to the settings specified in your lang_tr.yaml file.

Use cases

Inside the lang_dir directory, you can create translation files for each language you want to support. The files should be named according to the language code and in json format. Here's an example of a translation file for the English language en.json:

{
  "greet message": "Hello, World!",
  "welcome message": "Welcome to my app!"
}

Using in Code

You can now use the translations in your application by importing the lang_tr.dart file and accessing methods and fields of the LangTr class.

import 'path_to_generated/lang_tr.dart';

void main() {
  // Using translations
  String greeting = LangTr.greetMessage; // Accessing a specific translation
  print(greeting); // Prints "Hello, World!"
  LangTr.setLang('fr'); // Change the language. If the language is not found, the default language is used.
  print(LangTr.greetMessage); // Prints the translation in French if available, otherwise in English.

  LangTr.addListener((lang){
    // do something when the language changes
  });
}

Contribution

Contributions are welcome! If you have any improvement ideas, suggestions, or issues to report, feel free to open an issue or submit a pull request on GitHub.

License

This package is distributed under the MIT License. See the LICENSE file for more information.