-
Notifications
You must be signed in to change notification settings - Fork 6
Add localization support with flutter_localizations #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| arb-dir: lib/l10n | ||
| template-arb-file: app_en.arb | ||
| output-localization-file: app_localizations.dart |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "@@locale": "en", | ||
| "appTitle": "Tattoo", | ||
| "@appTitle": { | ||
| "description": "The application title" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| import 'dart:async'; | ||
|
|
||
| import 'package:flutter/foundation.dart'; | ||
| import 'package:flutter/widgets.dart'; | ||
| import 'package:flutter_localizations/flutter_localizations.dart'; | ||
| import 'package:intl/intl.dart' as intl; | ||
|
|
||
| import 'app_localizations_en.dart'; | ||
| import 'app_localizations_zh.dart'; | ||
|
|
||
| // ignore_for_file: type=lint | ||
|
|
||
| /// Callers can lookup localized strings with an instance of AppLocalizations | ||
| /// returned by `AppLocalizations.of(context)`. | ||
| /// | ||
| /// Applications need to include `AppLocalizations.delegate()` in their app's | ||
| /// `localizationDelegates` list, and the locales they support in the app's | ||
rileychh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /// `supportedLocales` list. For example: | ||
| /// | ||
| /// ```dart | ||
| /// import 'l10n/app_localizations.dart'; | ||
| /// | ||
| /// return MaterialApp( | ||
| /// localizationsDelegates: AppLocalizations.localizationsDelegates, | ||
| /// supportedLocales: AppLocalizations.supportedLocales, | ||
| /// home: MyApplicationHome(), | ||
| /// ); | ||
| /// ``` | ||
| /// | ||
| /// ## Update pubspec.yaml | ||
| /// | ||
| /// Please make sure to update your pubspec.yaml to include the following | ||
| /// packages: | ||
| /// | ||
| /// ```yaml | ||
| /// dependencies: | ||
| /// # Internationalization support. | ||
| /// flutter_localizations: | ||
| /// sdk: flutter | ||
| /// intl: any # Use the pinned version from flutter_localizations | ||
| /// | ||
| /// # Rest of dependencies | ||
| /// ``` | ||
| /// | ||
| /// ## iOS Applications | ||
| /// | ||
| /// iOS applications define key application metadata, including supported | ||
| /// locales, in an Info.plist file that is built into the application bundle. | ||
| /// To configure the locales supported by your app, you’ll need to edit this | ||
| /// file. | ||
| /// | ||
| /// First, open your project’s ios/Runner.xcworkspace Xcode workspace file. | ||
| /// Then, in the Project Navigator, open the Info.plist file under the Runner | ||
| /// project’s Runner folder. | ||
| /// | ||
| /// Next, select the Information Property List item, select Add Item from the | ||
| /// Editor menu, then select Localizations from the pop-up menu. | ||
| /// | ||
| /// Select and expand the newly-created Localizations item then, for each | ||
| /// locale your application supports, add a new item and select the locale | ||
| /// you wish to add from the pop-up menu in the Value field. This list should | ||
| /// be consistent with the languages listed in the AppLocalizations.supportedLocales | ||
| /// property. | ||
| abstract class AppLocalizations { | ||
| AppLocalizations(String locale) | ||
| : localeName = intl.Intl.canonicalizedLocale(locale.toString()); | ||
|
|
||
| final String localeName; | ||
|
|
||
| static AppLocalizations? of(BuildContext context) { | ||
| return Localizations.of<AppLocalizations>(context, AppLocalizations); | ||
| } | ||
|
|
||
| static const LocalizationsDelegate<AppLocalizations> delegate = | ||
| _AppLocalizationsDelegate(); | ||
|
|
||
| /// A list of this localizations delegate along with the default localizations | ||
| /// delegates. | ||
| /// | ||
| /// Returns a list of localizations delegates containing this delegate along with | ||
| /// GlobalMaterialLocalizations.delegate, GlobalCupertinoLocalizations.delegate, | ||
| /// and GlobalWidgetsLocalizations.delegate. | ||
| /// | ||
| /// Additional delegates can be added by appending to this list in | ||
| /// MaterialApp. This list does not have to be used at all if a custom list | ||
| /// of delegates is preferred or required. | ||
| static const List<LocalizationsDelegate<dynamic>> localizationsDelegates = | ||
| <LocalizationsDelegate<dynamic>>[ | ||
| delegate, | ||
| GlobalMaterialLocalizations.delegate, | ||
| GlobalCupertinoLocalizations.delegate, | ||
| GlobalWidgetsLocalizations.delegate, | ||
| ]; | ||
|
|
||
| /// A list of this localizations delegate's supported locales. | ||
| static const List<Locale> supportedLocales = <Locale>[ | ||
| Locale('en'), | ||
| Locale('zh'), | ||
| ]; | ||
|
|
||
| /// The application title | ||
| /// | ||
| /// In en, this message translates to: | ||
| /// **'Tattoo'** | ||
| String get appTitle; | ||
| } | ||
|
|
||
| class _AppLocalizationsDelegate | ||
| extends LocalizationsDelegate<AppLocalizations> { | ||
| const _AppLocalizationsDelegate(); | ||
|
|
||
| @override | ||
| Future<AppLocalizations> load(Locale locale) { | ||
| return SynchronousFuture<AppLocalizations>(lookupAppLocalizations(locale)); | ||
| } | ||
|
|
||
| @override | ||
| bool isSupported(Locale locale) => | ||
| <String>['en', 'zh'].contains(locale.languageCode); | ||
|
|
||
| @override | ||
| bool shouldReload(_AppLocalizationsDelegate old) => false; | ||
| } | ||
|
|
||
| AppLocalizations lookupAppLocalizations(Locale locale) { | ||
| // Lookup logic when only language code is specified. | ||
| switch (locale.languageCode) { | ||
| case 'en': | ||
| return AppLocalizationsEn(); | ||
| case 'zh': | ||
| return AppLocalizationsZh(); | ||
| } | ||
|
|
||
| throw FlutterError( | ||
| 'AppLocalizations.delegate failed to load unsupported locale "$locale". This is likely ' | ||
| 'an issue with the localizations generation tool. Please file an issue ' | ||
| 'on GitHub with a reproducible sample app and the gen-l10n configuration ' | ||
| 'that was used.', | ||
| ); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // ignore: unused_import | ||
| import 'package:intl/intl.dart' as intl; | ||
| import 'app_localizations.dart'; | ||
|
|
||
| // ignore_for_file: type=lint | ||
|
|
||
| /// The translations for English (`en`). | ||
| class AppLocalizationsEn extends AppLocalizations { | ||
| AppLocalizationsEn([String locale = 'en']) : super(locale); | ||
|
|
||
| @override | ||
| String get appTitle => 'Tattoo'; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // ignore: unused_import | ||
| import 'package:intl/intl.dart' as intl; | ||
| import 'app_localizations.dart'; | ||
|
|
||
| // ignore_for_file: type=lint | ||
|
|
||
| /// The translations for Chinese (`zh`). | ||
| class AppLocalizationsZh extends AppLocalizations { | ||
| AppLocalizationsZh([String locale = 'zh']) : super(locale); | ||
|
|
||
| @override | ||
| String get appTitle => 'Tattoo'; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "@@locale": "zh", | ||
| "appTitle": "Tattoo" | ||
rileychh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.