Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mineral-dart/i18n
📦 The I18n module allows you to translate your textual content into multiple languages from yaml files while injecting your variables.
https://github.com/mineral-dart/i18n
Last synced: about 1 month ago
JSON representation
📦 The I18n module allows you to translate your textual content into multiple languages from yaml files while injecting your variables.
- Host: GitHub
- URL: https://github.com/mineral-dart/i18n
- Owner: mineral-dart
- License: mit
- Created: 2022-09-11T18:09:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-24T23:18:36.000Z (over 1 year ago)
- Last Synced: 2023-08-09T13:45:16.946Z (over 1 year ago)
- Language: Dart
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌐 I18n
The i18n module has been designed exclusively for the Mineral framework, it allows you to translate your textual content through yaml files.
## Register the module
After installing the module, please register it within `./src/main.dart` following the scheme below :
```dart
import 'package:mineral/core.dart';
import 'package:mineral/core/services.dart';
import 'package:mineral_i18n/mineral_i18n.dart';
void main () async {
final kernel = Kernel(
intents: IntentService(all: true),
packages: PackageService([
I18n(['fr', 'en'])
]),
);
await kernel.init();
}
```
## Translate your textual content
As a first step, please create a `lang` folder containing `{lang}.yaml` translation files.
We consider the following software structure :
```
lang/
foo/
fr.yaml
en.yaml
```
The files will contain the following keys :
```yaml
# lang/foo/fr.yaml
bar: bar en français !
```
```yaml
# lang/foo/en.yaml
bar: bar in english !
```
Then we can use the `t()` function to translate our key path.
```dart
import 'package:mineral_i18n/mineral_i18n.dart';
class Foo extends MineralEvent with Translation {
Future handle (Ready event) async {
final String sentence = t(Lang.fr, 'foo.bar');
print(sentence); // bar en français !
final String sentence = t(Lang.en_GB, 'foo.bar');
print(sentence); // bar in english !
}
}
```
## Injecting variables
The i18n module integrates the possibility of using variables thanks to special characters which will be replaced by the associated variable.
We consider the file `lang/foo/en.yaml` as containing the following key set :
```yaml
bar: {framework} is my favourite framework !
```
Our string is now waiting for a variable named xx which we will give it when we call the `t()` function.
```dart
import 'package:mineral_i18n/mineral_i18n.dart';
class Foo extends MineralEvent with Translation {
Future handle (Ready event) async {
final String sentence = t(Lang.en_GB, 'foo.bar', { 'framework': 'Mineral' });
print(sentence); // Mineral is my favourite framework !
}
}
```
## Using package commands
The i18n package provides you with a series of commands that you can discover via the help menu.
In order to use these commands, you will need to add the package to the CLI as follows:
```dart
// mineral file
import 'package:mineral/cli.dart';
import 'package:mineral_i18n/mineral_i18n.dart';
Future main (List arguments) async {
final i18n = I18n(['fr', 'en']);
final cli = CommandLineInterface(packages: [i18n]);
await cli.handle(arguments);
}
```
The commands issued by the package are now available