Internationalisation des applications Flutter
Sommaire
Concepts fondamentaux
Flutter gère l'internationalisation (i18n) et la localisation (l10n) via les packages flutter_localizations et intl. L'approche standard utilise des fichiers App Resource Bundle (.arb) pour définir les chaînes localisées, qui sont ensuite compilées en une classe AppLocalizations générée, permettant un accès typé et sécurisé dans l'arbre de widgets.
Workflow de configuration
Copiez et suivez cette checklist lors de l'initialisation de l'internationalisation dans un projet Flutter :
- Suivi des tâches
- 1. Ajouter les dépendances dans
pubspec.yaml. - 2. Activer le flag
generate. - 3. Créer le fichier de configuration
l10n.yaml. - 4. Configurer
MaterialAppouCupertinoApp.
- 1. Ajouter les dépendances dans
1. Ajouter les dépendances
Ajoutez les packages de localisation requis au projet. Exécutez les commandes suivantes dans le terminal :
flutter pub add flutter_localizations --sdk=flutter
flutter pub add intl:any
Vérifiez que votre pubspec.yaml contient les éléments suivants dans dependencies :
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
intl: any
2. Activer la génération de code
Ouvrez pubspec.yaml et activez le flag generate dans la section flutter pour automatiser les tâches de localisation :
flutter:
generate: true
3. Créer le fichier de configuration
Créez un nouveau fichier nommé l10n.yaml dans le répertoire racine du projet Flutter. Définissez le répertoire d'entrée, le fichier template et le fichier de sortie :
arb-dir: lib/l10n
template-arb-file: app_en.arb
output-localization-file: app_localizations.dart
synthetic-package: true
4. Configurer le point d'entrée de l'application
Importez les localisations générées et la bibliothèque flutter_localizations dans votre main.dart. Injectez les délégués et les locales supportées dans votre MaterialApp ou CupertinoApp.
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart'; // Ajustez le chemin si synthetic-package est false
// ... dans la méthode build
return MaterialApp(
localizationsDelegates: const [
AppLocalizations.delegate,
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate,
GlobalCupertinoLocalizations.delegate,
],
supportedLocales: const [
Locale('en'), // Anglais
Locale('es'), // Espagnol
],
home: const MyHomePage(),
);
Workflow d'implémentation
Suivez ce workflow lors de l'ajout ou de la modification de contenu localisé.
1. Définir les fichiers ARB
- Si vous créez un NOUVEAU contenu : Ajoutez la chaîne de base dans le fichier template (
lib/l10n/app_en.arb). Incluez une description pour le contexte. - Si vous MODIFIEZ du contenu existant : Localisez la clé dans tous les fichiers
.arbsupportés et mettez à jour les valeurs.
{
"helloWorld": "Hello World!",
"@helloWorld": {
"description": "La salutation conventionnelle du programmeur débutant"
}
}
Créez les fichiers correspondants pour les autres locales (par ex. app_es.arb) :
{
"helloWorld": "¡Hola Mundo!"
}
2. Générer les classes de localisation
Exécutez la commande suivante pour déclencher la génération de code :
flutter pub get
Boucle de retour : Exécutez le validateur -> examinez la sortie du terminal pour les erreurs de syntaxe ARB -> corrigez les virgules manquantes ou les espaces réservés non correspondants -> relancez flutter pub get.
3. Consommer les chaînes localisées
Accédez aux chaînes localisées dans votre arbre de widgets en utilisant AppLocalizations.of(context). Assurez-vous que le widget appelant est un descendant de MaterialApp.
Text(AppLocalizations.of(context)!.helloWorld)
Formatage avancé
Utilisez des espaces réservés pour les données dynamiques, les pluriels et les sélections conditionnelles.
Espaces réservés
Définissez les paramètres entre accolades et spécifiez leur type dans l'objet de métadonnées.
"hello": "Hello {userName}",
"@hello": {
"description": "Un message avec un seul paramètre",
"placeholders": {
"userName": {
"type": "String",
"example": "Bob"
}
}
}
Pluriels
Utilisez la syntaxe plural pour gérer les variations de chaînes basées sur la quantité. Le cas other est obligatoire.
"nWombats": "{count, plural, =0{no wombats} =1{1 wombat} other{{count} wombats}}",
"@nWombats": {
"description": "Un message pluriel",
"placeholders": {
"count": {
"type": "num",
"format": "compact"
}
}
}
Sélections
Utilisez la syntaxe select pour les chaînes conditionnelles, comme le texte genré.
"pronoun": "{gender, select, male{he} female{she} other{they}}",
"@pronoun": {
"description": "Un message genré",
"placeholders": {
"gender": {
"type": "String"
}
}
}
Exemples
l10n.yaml complet
arb-dir: lib/l10n
template-arb-file: app_en.arb
output-localization-file: app_localizations.dart
synthetic-package: true
use-escaping: true
Implémentation complète d'un widget
import 'package:flutter/material.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
class GreetingWidget extends StatelessWidget {
final String userName;
final int notificationCount;
const GreetingWidget({
super.key,
required this.userName,
required this.notificationCount,
});
@override
Widget build(BuildContext context) {
final l10n = AppLocalizations.of(context)!;
return Column(
children: [
Text(l10n.hello(userName)),
Text(l10n.nWombats(notificationCount)),
],
);
}
}