chore(localizations): improve success and error messages

singerdmx · Dec 2, 2024 · 5221d8d · 5221d8d
1 parent bb45e33
commit 5221d8d
Show file tree

Hide file tree

Showing 45 changed files with 1,252 additions and 64 deletions.
diff --git a/flutter_quill_extensions/lib/src/editor/image/image_menu.dart b/flutter_quill_extensions/lib/src/editor/image/image_menu.dart
@@ -157,23 +157,22 @@ class ImageOptionsMenu extends StatelessWidget {
               if (result == null) {
                 messenger.showSnackBar(SnackBar(
                     content: Text(
-                  localizations.errorWhileSavingImage,
+                  localizations.errorUnexpectedSavingImage,
                 )));
                 return;
               }
 
               if (kIsWeb) {
                 messenger.showSnackBar(SnackBar(
-                    content: Text(localizations.savedUsingTheNetwork)));
+                    content: Text(localizations.successImageDownloaded)));
                 return;
               }
 
               if (result.isGallerySave) {
-                // TODO(save-image): Improve all messages in here
                 messenger.showSnackBar(SnackBar(
-                  content: Text(localizations.saved),
+                  content: Text(localizations.successImageSavedGallery),
                   action: SnackBarAction(
-                    label: localizations.open,
+                    label: localizations.openGallery,
                     onPressed: () =>
                         QuillNativeProvider.instance.openGalleryApp(),
                   ),
@@ -190,10 +189,9 @@ class ImageOptionsMenu extends StatelessWidget {
 
                 messenger.showSnackBar(
                   SnackBar(
-                    content: Text(
-                        localizations.theImageHasBeenSavedAt(imageFilePath)),
+                    content: Text(localizations.successImageSaved),
                     action: SnackBarAction(
-                      label: localizations.open,
+                      label: localizations.openFileLocation,
                       onPressed: () => launchUrl(Uri.file(imageFilePath)),
                     ),
                   ),

diff --git a/flutter_quill_extensions/test/editor/image/widgets/image_menu_test.dart b/flutter_quill_extensions/test/editor/image/widgets/image_menu_test.dart
@@ -79,20 +79,37 @@ void main() {
         );
       });
 
+      if (kIsWeb) {
+        testWidgets(
+          'shows a success message when the image downloaded on the web',
+          (tester) async {
+            mockSaveImageResult(const SaveImageResult(
+                imageFilePath: null, isGallerySave: false));
+
+            await pumpTargetWidget(tester);
+            await tapTargetWidget(tester);
+
+            final localizations =
+                tester.localizationsFromElement(ImageOptionsMenu);
+
+            expect(
+              find.text(localizations.successImageDownloaded),
+              findsOneWidget,
+            );
+          },
+        );
+      }
+
       testWidgets('shows error message when saving fails', (tester) async {
         mockSaveImageResult(null);
 
         await pumpTargetWidget(tester);
-
-        final saveButtonFinder = findTargetWidget();
-
-        await tester.tap(saveButtonFinder);
-        await tester.pump();
+        await tapTargetWidget(tester);
 
         final localizations = tester.localizationsFromElement(ImageOptionsMenu);
 
         expect(
-          find.text(localizations.errorWhileSavingImage),
+          find.text(localizations.errorUnexpectedSavingImage),
           findsOneWidget,
         );
 
@@ -117,19 +134,19 @@ void main() {
         final localizations = tester.localizationsFromElement(ImageOptionsMenu);
 
         expect(
-          find.text(localizations.saved),
+          find.text(localizations.successImageSavedGallery),
           findsOneWidget,
         );
 
         expect(
-          find.text(localizations.open),
+          find.text(localizations.openGallery),
           findsOneWidget,
         );
       });
 
       for (final desktopPlatform in TargetPlatformVariant.desktop().values) {
         testWidgets(
-            'shows saved file path and open desktop path on ${desktopPlatform.name}',
+            'shows saved success image and open file path action on ${desktopPlatform.name}',
             (tester) async {
           debugDefaultTargetPlatformOverride = desktopPlatform;
 
@@ -144,12 +161,12 @@ void main() {
               tester.localizationsFromElement(ImageOptionsMenu);
 
           expect(
-            find.text(localizations.theImageHasBeenSavedAt(savedImagePath)),
+            find.text(localizations.successImageSaved),
             findsOneWidget,
           );
 
           expect(
-            find.text(localizations.open),
+            find.text(localizations.openFileLocation),
             findsOneWidget,
           );
 

diff --git a/lib/src/l10n/generated/quill_localizations.dart b/lib/src/l10n/generated/quill_localizations.dart
@@ -768,6 +768,42 @@ abstract class FlutterQuillLocalizations {
   /// In en, this message translates to:
   /// **'Insert video'**
   String get insertVideo;
+
+  /// A generic error message shown when an image cannot be saved due to an unknown issue.
+  ///
+  /// In en, this message translates to:
+  /// **'An unexpected error occurred while saving the image. Please try again.'**
+  String get errorUnexpectedSavingImage;
+
+  /// Message shown on mobile when an image is successfully saved to the gallery.
+  ///
+  /// In en, this message translates to:
+  /// **'Image saved to your gallery.'**
+  String get successImageSavedGallery;
+
+  /// Message shown on desktop when an image is successfully saved. The user is prompted to open the file location.
+  ///
+  /// In en, this message translates to:
+  /// **'Image saved successfully.'**
+  String get successImageSaved;
+
+  /// Message shown on web when an image is successfully downloaded.
+  ///
+  /// In en, this message translates to:
+  /// **'Image downloaded successfully.'**
+  String get successImageDownloaded;
+
+  /// Label for the button that opens the system gallery app.
+  ///
+  /// In en, this message translates to:
+  /// **'Open Gallery'**
+  String get openGallery;
+
+  /// Label for the button that opens the file explorer to the file's location.
+  ///
+  /// In en, this message translates to:
+  /// **'Open File Location'**
+  String get openFileLocation;
 }
 
 class _FlutterQuillLocalizationsDelegate

diff --git a/lib/src/l10n/generated/quill_localizations_ar.dart b/lib/src/l10n/generated/quill_localizations_ar.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -302,4 +304,23 @@ class FlutterQuillLocalizationsAr extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_bg.dart b/lib/src/l10n/generated/quill_localizations_bg.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -304,4 +306,23 @@ class FlutterQuillLocalizationsBg extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_bn.dart b/lib/src/l10n/generated/quill_localizations_bn.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -310,4 +312,23 @@ class FlutterQuillLocalizationsBn extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_ca.dart b/lib/src/l10n/generated/quill_localizations_ca.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -306,4 +308,23 @@ class FlutterQuillLocalizationsCa extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_cs.dart b/lib/src/l10n/generated/quill_localizations_cs.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -304,4 +306,23 @@ class FlutterQuillLocalizationsCs extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_da.dart b/lib/src/l10n/generated/quill_localizations_da.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -302,4 +304,23 @@ class FlutterQuillLocalizationsDa extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_de.dart b/lib/src/l10n/generated/quill_localizations_de.dart
@@ -1,3 +1,5 @@
+// ignore: unused_import
+import 'package:intl/intl.dart' as intl;
 import 'quill_localizations.dart';
 
 // ignore_for_file: type=lint
@@ -308,4 +310,23 @@ class FlutterQuillLocalizationsDe extends FlutterQuillLocalizations {
 
   @override
   String get insertVideo => 'Insert video';
+
+  @override
+  String get errorUnexpectedSavingImage =>
+      'An unexpected error occurred while saving the image. Please try again.';
+
+  @override
+  String get successImageSavedGallery => 'Image saved to your gallery.';
+
+  @override
+  String get successImageSaved => 'Image saved successfully.';
+
+  @override
+  String get successImageDownloaded => 'Image downloaded successfully.';
+
+  @override
+  String get openGallery => 'Open Gallery';
+
+  @override
+  String get openFileLocation => 'Open File Location';
 }