Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

Commit

Permalink
feat: add l10n
Browse files Browse the repository at this point in the history
  • Loading branch information
alestiago committed Mar 11, 2024
1 parent f665fa3 commit 8c786c0
Show file tree
Hide file tree
Showing 10 changed files with 190 additions and 2 deletions.
1 change: 1 addition & 0 deletions packages/trashy_road/analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ include: package:very_good_analysis/analysis_options.5.1.0.yaml
analyzer:
exclude:
- lib/**/*.gen.dart
- lib/l10n/arb/**.dart
linter:
rules:
public_member_api_docs: false
4 changes: 4 additions & 0 deletions packages/trashy_road/l10n.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
arb-dir: lib/l10n/arb
template-arb-file: app_en.arb
output-localization-file: app_localizations.dart
synthetic-package: false
7 changes: 7 additions & 0 deletions packages/trashy_road/lib/l10n/arb/app_en.arb
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"@@locale": "en",
"great": "great",
"@great": {
"description": "Shown to congratulate the player in the Score Page."
}
}
130 changes: 130 additions & 0 deletions packages/trashy_road/lib/l10n/arb/app_localizations.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
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';

/// 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
/// `supportedLocales` list. For example:
///
/// ```dart
/// import 'arb/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')
];

/// Shown to congratulate the player in the Score Page.
///
/// In en, this message translates to:
/// **'great'**
String get great;
}

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'].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();
}

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.'
);
}
9 changes: 9 additions & 0 deletions packages/trashy_road/lib/l10n/arb/app_localizations_en.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import 'app_localizations.dart';

/// The translations for English (`en`).
class AppLocalizationsEn extends AppLocalizations {
AppLocalizationsEn([String locale = 'en']) : super(locale);

@override
String get great => 'great';
}
15 changes: 15 additions & 0 deletions packages/trashy_road/lib/l10n/l10n.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import 'package:flutter/widgets.dart';
import 'package:trashy_road/l10n/l10n.dart';

export 'package:trashy_road/l10n/arb/app_localizations.dart';

/// Extension for [AppLocalizations] to access it from [BuildContext].
///
/// If the [AppLocalizations] is not found, generate it using:
/// ```sh
/// # Generate new AppLocalizations (from packages/trashy_road):
/// flutter gen-l10n
/// ```
extension AppLocalizationsX on BuildContext {
AppLocalizations get l10n => AppLocalizations.of(this)!;
}
5 changes: 4 additions & 1 deletion packages/trashy_road/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import 'package:basura/basura.dart';
import 'package:flame/cache.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:trashy_road/l10n/l10n.dart';
import 'package:trashy_road/src/audio/audio.dart';
import 'package:trashy_road/src/loading/loading.dart';
import 'package:trashy_road/src/maps/maps.dart';
Expand Down Expand Up @@ -41,8 +42,10 @@ class _MyApp extends StatelessWidget {
child: BasuraTheme(
data: BasuraThemeData.light(),
child: MaterialApp(
title: 'Flutter Demo',
title: 'Trashy Town',
debugShowCheckedModeBanner: false,
localizationsDelegates: AppLocalizations.localizationsDelegates,
supportedLocales: AppLocalizations.supportedLocales,
theme: ThemeData(
colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
useMaterial3: true,
Expand Down
5 changes: 4 additions & 1 deletion packages/trashy_road/lib/src/score/view/score_page.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:trashy_road/gen/assets.gen.dart';
import 'package:trashy_road/l10n/l10n.dart';
import 'package:trashy_road/src/game/game.dart';
import 'package:trashy_road/src/loading/loading.dart';
import 'package:trashy_road/src/maps/maps.dart';
Expand Down Expand Up @@ -72,6 +73,8 @@ class ScorePage extends StatelessWidget {

@override
Widget build(BuildContext context) {
final l10n = context.l10n;

final screenSize = MediaQuery.sizeOf(context);
final gameMapsBloc = context.read<GameMapsBloc>();
final nextMap = gameMapsBloc.state.next(_identifier);
Expand Down Expand Up @@ -103,7 +106,7 @@ class ScorePage extends StatelessWidget {
mainAxisSize: MainAxisSize.min,
children: [
Center(
child: AutoSizeText('Nice!', style: textStyle),
child: AutoSizeText(l10n.great, style: textStyle),
),
SizedBox(
height: 80,
Expand Down
13 changes: 13 additions & 0 deletions packages/trashy_road/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,11 @@ packages:
url: "https://pub.dev"
source: hosted
version: "5.4.0"
flutter_localizations:
dependency: "direct main"
description: flutter
source: sdk
version: "0.0.0"
flutter_svg:
dependency: "direct main"
description:
Expand Down Expand Up @@ -511,6 +516,14 @@ packages:
url: "https://pub.dev"
source: hosted
version: "4.0.2"
intl:
dependency: "direct main"
description:
name: intl
sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d"
url: "https://pub.dev"
source: hosted
version: "0.18.1"
io:
dependency: transitive
description:
Expand Down
3 changes: 3 additions & 0 deletions packages/trashy_road/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ dependencies:
sdk: flutter
flutter_bloc: ^8.1.3
flutter_gen: ^5.4.0
flutter_localizations:
sdk: flutter
flutter_svg: ^2.0.10+1
intl: ^0.18.1
meta: ^1.11.0
path: ^1.8.3
rive: ^0.12.4
Expand Down

0 comments on commit 8c786c0

Please sign in to comment.