Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: Adding the possibility to pass a localization delegate to EasyLocalization widget #698

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

feat: Adding the possibility to pass a localization delegate to EasyLocalization widget #698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
361d154
expose EasyLocalizationDelegate to make the load method customizable
LSTGen Jul 24, 2024
4a93d85
Exported EasyLocalizationController and Localization classes
LSTGen Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/easy_localization.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ export 'package:easy_localization/src/easy_localization_app.dart';
export 'package:easy_localization/src/asset_loader.dart';
export 'package:easy_localization/src/public.dart';
export 'package:easy_localization/src/public_ext.dart';
export 'package:easy_localization/src/easy_localization_controller.dart';
export 'package:easy_localization/src/localization.dart';
export 'package:intl/intl.dart';
73 changes: 40 additions & 33 deletions lib/src/easy_localization_app.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,18 @@ class EasyLocalization extends StatefulWidget {
/// @Default value `errorWidget = ErrorWidget()`
final Widget Function(FlutterError? message)? errorWidget;

/// A custom delegate implementation that allow to override the load function and define a custom [EasyLocalizationController]
/// To use this delegate Extend the [EasyLocalizationDelegate] and implement the override needed
final EasyLocalizationDelegate? delegate;

EasyLocalization({
Key? key,
required this.child,
required this.supportedLocales,
required this.path,
this.fallbackLocale,
this.startLocale,
this.delegate,
this.useOnlyLangCode = false,
this.useFallbackTranslations = false,
this.useFallbackTranslationsForEmptyResources = false,
Expand Down Expand Up @@ -167,29 +172,30 @@ class EasyLocalization extends StatefulWidget {
}

class _EasyLocalizationState extends State<EasyLocalization> {
_EasyLocalizationDelegate? delegate;
EasyLocalizationDelegate? delegate;
EasyLocalizationController? localizationController;
FlutterError? translationsLoadError;

@override
void initState() {
EasyLocalization.logger.debug('Init state');
localizationController = EasyLocalizationController(
saveLocale: widget.saveLocale,
fallbackLocale: widget.fallbackLocale,
supportedLocales: widget.supportedLocales,
startLocale: widget.startLocale,
assetLoader: widget.assetLoader,
extraAssetLoaders: widget.extraAssetLoaders,
useOnlyLangCode: widget.useOnlyLangCode,
useFallbackTranslations: widget.useFallbackTranslations,
path: widget.path,
onLoadError: (FlutterError e) {
setState(() {
translationsLoadError = e;
});
},
);
localizationController = widget.delegate?.localizationController ??
EasyLocalizationController(
saveLocale: widget.saveLocale,
fallbackLocale: widget.fallbackLocale,
supportedLocales: widget.supportedLocales,
startLocale: widget.startLocale,
assetLoader: widget.assetLoader,
extraAssetLoaders: widget.extraAssetLoaders,
useOnlyLangCode: widget.useOnlyLangCode,
useFallbackTranslations: widget.useFallbackTranslations,
path: widget.path,
onLoadError: (FlutterError e) {
setState(() {
translationsLoadError = e;
});
},
);
// causes localization to rebuild with new language
localizationController!.addListener(() {
if (mounted) setState(() {});
Expand All @@ -214,13 +220,14 @@ class _EasyLocalizationState extends State<EasyLocalization> {
return _EasyLocalizationProvider(
widget,
localizationController!,
delegate: _EasyLocalizationDelegate(
localizationController: localizationController,
supportedLocales: widget.supportedLocales,
useFallbackTranslationsForEmptyResources:
widget.useFallbackTranslationsForEmptyResources,
ignorePluralRules: widget.ignorePluralRules,
),
delegate: widget.delegate ??
EasyLocalizationDelegate(
localizationController: localizationController!,
supportedLocales: widget.supportedLocales,
useFallbackTranslationsForEmptyResources:
widget.useFallbackTranslationsForEmptyResources,
ignorePluralRules: widget.ignorePluralRules,
),
);
}
}
Expand All @@ -229,7 +236,7 @@ class _EasyLocalizationProvider extends InheritedWidget {
final EasyLocalization parent;
final EasyLocalizationController _localeState;
final Locale? currentLocale;
final _EasyLocalizationDelegate delegate;
final EasyLocalizationDelegate delegate;

/// {@macro flutter.widgets.widgetsApp.localizationsDelegates}
///
Expand Down Expand Up @@ -298,19 +305,19 @@ class _EasyLocalizationProvider extends InheritedWidget {
context.dependOnInheritedWidgetOfExactType<_EasyLocalizationProvider>();
}

class _EasyLocalizationDelegate extends LocalizationsDelegate<Localization> {
class EasyLocalizationDelegate extends LocalizationsDelegate<Localization> {
final List<Locale>? supportedLocales;
final EasyLocalizationController? localizationController;
final EasyLocalizationController localizationController;
final bool useFallbackTranslationsForEmptyResources;
final bool ignorePluralRules;

/// * use only the lang code to generate i18n file path like en.json or ar.json
// final bool useOnlyLangCode;

_EasyLocalizationDelegate({
EasyLocalizationDelegate({
required this.useFallbackTranslationsForEmptyResources,
this.ignorePluralRules = true,
this.localizationController,
required this.localizationController,
this.supportedLocales,
}) {
EasyLocalization.logger.debug('Init Localization Delegate');
Expand All @@ -322,14 +329,14 @@ class _EasyLocalizationDelegate extends LocalizationsDelegate<Localization> {
@override
Future<Localization> load(Locale value) async {
EasyLocalization.logger.debug('Load Localization Delegate');
if (localizationController!.translations == null) {
await localizationController!.loadTranslations();
if (localizationController.translations == null) {
await localizationController.loadTranslations();
}

Localization.load(
value,
translations: localizationController!.translations,
fallbackTranslations: localizationController!.fallbackTranslations,
translations: localizationController.translations,
fallbackTranslations: localizationController.fallbackTranslations,
useFallbackTranslationsForEmptyResources:
useFallbackTranslationsForEmptyResources,
ignorePluralRules: ignorePluralRules,
Expand Down