I18n supportedLocales etc.

marcglasberg · Dec 18, 2024 · 2fda07c · 2fda07c
1 parent 382e5ca
commit 2fda07c
Show file tree

Hide file tree

Showing 11 changed files with 325 additions and 94 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,49 @@ Sponsored by [MyText.ai](https://mytext.ai)
 
 [![](./example/SponsoredByMyTextAi.png)](https://mytext.ai)
 
+## 15.0.0-dev.1
+
+* Optionally, you can now set the `supportedLocales` of your app in the `I18n` widget.
+  For example, if your app supports American English and Standard Spanish, you'd use:
+  `supportedLocales: [Locale('en', 'US'), Locale('es')]`,
+  or `supportedLocales: ['en-US'.asLocale, 'es'.asLocale]`.
+
+  If you do set `I18n.supportedLocales`, you must add the line
+  `supportedLocales: I18n.supportedLocales` to your `MaterialApp` (or `CupertinoApp`)
+  widget, like this:
+
+  ```dart
+  void main() {
+    WidgetsFlutterBinding.ensureInitialized();
+  
+    runApp(I18n(
+        initialLocale: ...,
+        supportedLocales: ['en-US'.asLocale, 'es'.asLocale], // Here!
+        child: AppCore(),
+      ));
+    }
+  }
+  
+  class AppCore extends StatelessWidget {
+    Widget build(BuildContext context) {
+      return MaterialApp(
+        locale: I18n.locale,
+        supportedLocales: I18n.supportedLocales, // Here!
+        ...
+      ),
+  ```
+
+  If you provide `I18n.supportedLocales`, only those supported locales will be
+  considered when recording **missing translations**. In other words, unsupported locales
+  will not be recorded as missing translations.
+
+
+* **Breaking Change**: The `Translations.missingTranslationCallback` signature has
+  changed. This will only affect you if you have defined your own callback, which is
+  unlikely. If your code does break, update it to the new signature, which is an easy fix.
+  Note that it now returns a boolean. Only if it returns `true` will the missing
+  translation be added to the `Translations.missingTranslations` map.
+
 ## 14.1.0
 
 Version 14 brings important improvements, like new interpolation methods, useful

diff --git a/example/lib/1_translation_example/main.dart b/example/lib/1_translation_example/main.dart
@@ -36,6 +36,16 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', 'US'), // Could also be 'en-US'.asLocale,
+        const Locale('pt', 'BR'), // Could also be 'pt-BR'.asLocale,
+        const Locale('es', 'ES'), // Could also be 'es-ES'.asLocale,
+      ],
       child: AppCore(),
     ),
   );
@@ -45,19 +55,10 @@ class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
-      locale: I18n.locale,
       debugShowCheckedModeBanner: false,
-      //
-      localizationsDelegates: [
-        GlobalMaterialLocalizations.delegate,
-        GlobalWidgetsLocalizations.delegate,
-        GlobalCupertinoLocalizations.delegate,
-      ],
-      supportedLocales: [
-        const Locale('en', 'US'),
-        const Locale('pt', 'BR'),
-        const Locale('es', 'ES'),
-      ],
+      locale: I18n.locale,
+      localizationsDelegates: I18n.localizationsDelegates,
+      supportedLocales: I18n.supportedLocales,
       home: MyHomePage(),
       theme: ThemeData(
         elevatedButtonTheme: ElevatedButtonThemeData(

diff --git a/example/lib/2_identifier_translation_example/main.dart b/example/lib/2_identifier_translation_example/main.dart
@@ -30,6 +30,15 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', 'US'), // Could also be 'en-US'.asLocale,
+        const Locale('pt', 'BR'), // Could also be 'pt-BR'.asLocale,
+      ],
       child: AppCore(),
     ),
   );
@@ -38,18 +47,10 @@ void main() async {
 class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) => MaterialApp(
-        locale: I18n.locale,
         debugShowCheckedModeBanner: false,
-        //
-        localizationsDelegates: [
-          GlobalMaterialLocalizations.delegate,
-          GlobalWidgetsLocalizations.delegate,
-          GlobalCupertinoLocalizations.delegate,
-        ],
-        supportedLocales: [
-          const Locale('en', "US"),
-          const Locale('pt', "BR"),
-        ],
+        locale: I18n.locale,
+        localizationsDelegates: I18n.localizationsDelegates,
+        supportedLocales: I18n.supportedLocales,
         home: MyHomePage(),
       );
 }

diff --git a/example/lib/3_scoped_identifier_translation_example/main.dart b/example/lib/3_scoped_identifier_translation_example/main.dart
@@ -33,6 +33,15 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', "US"),
+        const Locale('pt', "BR"),
+      ],
       child: AppCore(),
     ),
   );
@@ -41,18 +50,10 @@ void main() async {
 class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) => MaterialApp(
-        locale: I18n.locale,
         debugShowCheckedModeBanner: false,
-        //
-        localizationsDelegates: [
-          GlobalMaterialLocalizations.delegate,
-          GlobalWidgetsLocalizations.delegate,
-          GlobalCupertinoLocalizations.delegate,
-        ],
-        supportedLocales: [
-          const Locale('en', "US"),
-          const Locale('pt', "BR"),
-        ],
+        locale: I18n.locale,
+        localizationsDelegates: I18n.localizationsDelegates,
+        supportedLocales: I18n.supportedLocales,
         home: MyHomePage(),
       );
 }

diff --git a/example/lib/4_const_translation_example/main.dart b/example/lib/4_const_translation_example/main.dart
@@ -16,6 +16,15 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', "US"),
+        const Locale('pt', "BR"),
+      ],
       child: AppCore(),
     ),
   );
@@ -24,18 +33,10 @@ void main() async {
 class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) => MaterialApp(
-        locale: I18n.locale,
         debugShowCheckedModeBanner: false,
-        //
-        localizationsDelegates: [
-          GlobalMaterialLocalizations.delegate,
-          GlobalWidgetsLocalizations.delegate,
-          GlobalCupertinoLocalizations.delegate,
-        ],
-        supportedLocales: [
-          const Locale('en', "US"),
-          const Locale('pt', "BR"),
-        ],
+        locale: I18n.locale,
+        localizationsDelegates: I18n.localizationsDelegates,
+        supportedLocales: I18n.supportedLocales,
         home: MyHomePage(),
       );
 }

diff --git a/example/lib/5_interpolation_example/main.dart b/example/lib/5_interpolation_example/main.dart
@@ -29,6 +29,15 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', "US"),
+        const Locale('pt', "BR"),
+      ],
       child: AppCore(),
     ),
   );
@@ -37,18 +46,10 @@ void main() async {
 class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) => MaterialApp(
-        locale: I18n.locale,
         debugShowCheckedModeBanner: false,
-        //
-        localizationsDelegates: [
-          GlobalMaterialLocalizations.delegate,
-          GlobalWidgetsLocalizations.delegate,
-          GlobalCupertinoLocalizations.delegate,
-        ],
-        supportedLocales: [
-          const Locale('en', "US"),
-          const Locale('pt', "BR"),
-        ],
+        locale: I18n.locale,
+        localizationsDelegates: I18n.localizationsDelegates,
+        supportedLocales: I18n.supportedLocales,
         home: MyHomePage(),
       );
 }

diff --git a/example/lib/6_load_by_file_example/main.dart b/example/lib/6_load_by_file_example/main.dart
@@ -34,6 +34,16 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', 'US'), // Could also be 'en-US'.asLocale,
+        const Locale('pt', 'BR'), // Could also be 'pt-BR'.asLocale,
+        const Locale('es', 'ES'), // Could also be 'es-ES'.asLocale,
+      ],
       child: AppCore(),
     ),
   );
@@ -43,19 +53,10 @@ class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
-      locale: I18n.locale,
       debugShowCheckedModeBanner: false,
-      //
-      localizationsDelegates: [
-        GlobalMaterialLocalizations.delegate,
-        GlobalWidgetsLocalizations.delegate,
-        GlobalCupertinoLocalizations.delegate,
-      ],
-      supportedLocales: [
-        const Locale('en', 'US'),
-        const Locale('pt', 'BR'),
-        const Locale('es', 'ES'),
-      ],
+      locale: I18n.locale,
+      localizationsDelegates: I18n.localizationsDelegates,
+      supportedLocales: I18n.supportedLocales,
       home: MyHomePage(),
       theme: ThemeData(
         elevatedButtonTheme: ElevatedButtonThemeData(

diff --git a/example/lib/7_load_by_http_example/main.dart b/example/lib/7_load_by_http_example/main.dart
@@ -43,6 +43,16 @@ void main() async {
     I18n(
       initialLocale: await I18n.loadLocale(),
       autoSaveLocale: true,
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        GlobalCupertinoLocalizations.delegate,
+      ],
+      supportedLocales: [
+        const Locale('en', 'US'), // Could also be 'en-US'.asLocale,
+        const Locale('pt', 'BR'), // Could also be 'pt-BR'.asLocale,
+        const Locale('es', 'ES'), // Could also be 'es-ES'.asLocale,
+      ],
       child: AppCore(),
     ),
   );
@@ -52,19 +62,10 @@ class AppCore extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
-      locale: I18n.locale,
       debugShowCheckedModeBanner: false,
-      //
-      localizationsDelegates: [
-        GlobalMaterialLocalizations.delegate,
-        GlobalWidgetsLocalizations.delegate,
-        GlobalCupertinoLocalizations.delegate,
-      ],
-      supportedLocales: [
-        const Locale('en', 'US'),
-        const Locale('pt', 'BR'),
-        const Locale('es', 'ES'),
-      ],
+      locale: I18n.locale,
+      localizationsDelegates: I18n.localizationsDelegates,
+      supportedLocales: I18n.supportedLocales,
       home: MyHomePage(),
       theme: ThemeData(
         elevatedButtonTheme: ElevatedButtonThemeData(