Merge pull request #36 from Iconica-Development/feature/error_handling

feat: error handling

.gitignore

@@ -31,3 +31,7 @@ build/
 coverage/
 /.flutter-plugins
 /.flutter-plugins-dependencies
+
+# FVM Version Cache
+.fvm/
+.fvmrc

CHANGELOG.md

@@ -36,3 +36,15 @@
 ## 2.0.0 - February 22nd 2024
 
 - Simplified the ImagePickerTheme
+
+# 3.0.0 - February 22nd 2024
+
+- Removed customButton from ImagePicker.
+
+# 4.0.0
+* Added title options to theme.
+* updated iconica_analysis dependency.
+* Updated default theme.
+
+# 4.1.0
+* Added support for handling errors when calling `pickImage`.

example/lib/main.dart

@@ -11,7 +11,9 @@ void main() {
 }
 
 class ImagePickerExample extends StatelessWidget {
-  const ImagePickerExample({Key? key}) : super(key: key);
+  const ImagePickerExample({
+    super.key,
+  });
 
   @override
   Widget build(BuildContext context) {
@@ -27,8 +29,10 @@ class ImagePickerExample extends StatelessWidget {
 }
 
 class ImagePickerExampleHomePage extends StatefulWidget {
-  const ImagePickerExampleHomePage({Key? key, required this.title})
-      : super(key: key);
+  const ImagePickerExampleHomePage({
+    required this.title,
+    super.key,
+  });
 
   final String title;
 
@@ -112,7 +116,13 @@ class ImagePickerExampleHomePageState
     Uint8List? imageInBytes = await showModalBottomSheet<Uint8List?>(
         context: context,
         backgroundColor: Colors.white,
-        builder: (BuildContext context) => const ImagePicker());
+        builder: (BuildContext context) => ImagePicker(
+              onError: (error) {
+                ScaffoldMessenger.of(context).showSnackBar(
+                  SnackBar(content: Text(error.message ?? "An error occurred")),
+                );
+              },
+            ));
     if (imageInBytes != null) {
       if (!listEquals(uploadedImage, imageInBytes)) {
         setState(() {

example/linux/flutter/generated_plugin_registrant.cc

@@ -6,6 +6,10 @@
 
 #include "generated_plugin_registrant.h"
 
+#include <file_selector_linux/file_selector_plugin.h>
 
 void fl_register_plugins(FlPluginRegistry* registry) {
+  g_autoptr(FlPluginRegistrar) file_selector_linux_registrar =
+      fl_plugin_registry_get_registrar_for_plugin(registry, "FileSelectorPlugin");
+  file_selector_plugin_register_with_registrar(file_selector_linux_registrar);
 }

example/linux/flutter/generated_plugins.cmake

@@ -3,6 +3,7 @@
 #
 
 list(APPEND FLUTTER_PLUGIN_LIST
+  file_selector_linux
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST

example/macos/Flutter/GeneratedPluginRegistrant.swift

@@ -5,6 +5,8 @@
 import FlutterMacOS
 import Foundation
 
+import file_selector_macos
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
+  FileSelectorPlugin.register(with: registry.registrar(forPlugin: "FileSelectorPlugin"))
 }

example/windows/flutter/generated_plugin_registrant.cc

@@ -6,6 +6,9 @@
 
 #include "generated_plugin_registrant.h"
 
+#include <file_selector_windows/file_selector_windows.h>
 
 void RegisterPlugins(flutter::PluginRegistry* registry) {
+  FileSelectorWindowsRegisterWithRegistrar(
+      registry->GetRegistrarForPlugin("FileSelectorWindows"));
 }

example/windows/flutter/generated_plugins.cmake

@@ -3,6 +3,7 @@
 #
 
 list(APPEND FLUTTER_PLUGIN_LIST
+  file_selector_windows
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST

lib/flutter_image_picker.dart

@@ -4,7 +4,7 @@
 ///
 library flutter_image_picker;
 
-export 'src/models/image_picker_config.dart';
-export 'src/models/image_picker_theme.dart';
-export 'src/services/image_picker_service.dart';
-export 'src/ui/image_picker.dart';
+export "src/models/image_picker_config.dart";
+export "src/models/image_picker_theme.dart";
+export "src/services/image_picker_service.dart";
+export "src/ui/image_picker.dart";

lib/src/models/image_picker_theme.dart

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
+import "package:flutter/material.dart";
 
 class ImagePickerTheme {
   /// The [ImagePickerTheme] is used to style the [ImagePicker].
@@ -12,11 +12,14 @@ class ImagePickerTheme {
     this.iconSize = 125,
     this.spaceBetweenIcons = 30,
     this.makePhotoIcon,
-    this.makePhotoText = 'Take a Picture',
+    this.makePhotoText = "TAKE PICTURE",
     this.selectImageIcon,
-    this.selectImageText = 'Select File',
+    this.selectImageText = "UPLOAD FILE",
     this.iconTextStyle,
     this.closeButtonBuilder,
+    this.title = "Do you want to upload a file or take a picture?",
+    this.titleStyle,
+    this.titleAlignment = TextAlign.center,
   });
 
   /// The color of the icons
@@ -45,5 +48,11 @@ class ImagePickerTheme {
 
   final TextStyle? iconTextStyle;
 
-  final Widget Function(Function onTap)? closeButtonBuilder;
+  final Widget Function(Function() onTap)? closeButtonBuilder;
+
+  final String title;
+
+  final TextStyle? titleStyle;
+
+  final TextAlign titleAlignment;
 }

lib/src/services/image_picker_service.dart

@@ -2,9 +2,9 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'dart:typed_data';
-import 'package:flutter_image_picker/src/models/image_picker_config.dart';
-import 'package:image_picker/image_picker.dart';
+import "dart:typed_data";
+import "package:flutter_image_picker/src/models/image_picker_config.dart";
+import "package:image_picker/image_picker.dart";
 
 /// The Image Picker Service class is the functionality of the Image Picker
 /// package which uses the Image Picker package to choose an image.

lib/src/ui/image_picker.dart

@@ -2,9 +2,10 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
-import 'package:flutter_image_picker/flutter_image_picker.dart';
-import 'package:image_picker/image_picker.dart';
+import "package:flutter/material.dart";
+import "package:flutter/services.dart";
+import "package:flutter_image_picker/flutter_image_picker.dart";
+import "package:image_picker/image_picker.dart";
 
 /// The Image Picker class generates the Image Picker Widget which can be
 /// displayed in your application. If you call the class you can give it 4
@@ -21,7 +22,7 @@ class ImagePicker extends StatelessWidget {
     this.theme = const ImagePickerTheme(),
     this.config = const ImagePickerConfig(),
     this.service,
-    this.customButton,
+    this.onError,
     super.key,
   });
 
@@ -32,18 +33,25 @@ class ImagePicker extends StatelessWidget {
   /// uploaded image.
   final ImagePickerConfig config;
 
-  /// The Image Picker Dialog can have a custom button if you want to.
-  final Widget? customButton;
-
   /// The ImagePickerService can be used if you want to use your own
   /// implementation of the Image Service if you want to use it for testing or
   /// add more features. If null the current implementation will be used.
   final ImagePickerService? service;
 
+  final Function(PlatformException error)? onError;
+
   @override
   Widget build(BuildContext context) => SingleChildScrollView(
         child: Column(
           children: <Widget>[
+            ListTile(
+              title: Text(
+                theme.title,
+                style:
+                    theme.titleStyle ?? Theme.of(context).textTheme.titleMedium,
+                textAlign: theme.titleAlignment,
+              ),
+            ),
             Row(
               mainAxisAlignment: MainAxisAlignment.center,
               children: [
@@ -54,6 +62,7 @@ class ImagePicker extends StatelessWidget {
                   Icons.image,
                   ImageSource.gallery,
                   theme.selectImageText,
+                  onError,
                 ),
                 if (config.cameraOption ?? true) ...[
                   SizedBox(
@@ -66,6 +75,7 @@ class ImagePicker extends StatelessWidget {
                     Icons.camera_alt_rounded,
                     ImageSource.camera,
                     theme.makePhotoText,
+                    onError,
                   ),
                 ],
               ],
@@ -80,14 +90,13 @@ class ImagePicker extends StatelessWidget {
                 child: SizedBox(
                   width: 300,
                   height: 40,
-                  child: customButton ??
-                      ElevatedButton(
+                  child: ElevatedButton(
                     style: ElevatedButton.styleFrom(
                       backgroundColor: Colors.black,
                     ),
                     onPressed: () => Navigator.of(context).pop(),
                     child: const Text(
-                          'Close',
+                      "Close",
                       style: TextStyle(
                         fontSize: 15,
                         color: Colors.white,
@@ -122,6 +131,7 @@ class ImagePicker extends StatelessWidget {
     IconData icon,
     ImageSource imageSource,
     String bottomText,
+    Function(PlatformException error)? onError,
   ) =>
       Column(
         mainAxisSize: MainAxisSize.min,
@@ -130,8 +140,14 @@ class ImagePicker extends StatelessWidget {
             key: Key(bottomText),
             onTap: () async {
               var navigator = Navigator.of(context);
-              var image = await (service ?? ImagePickerServiceDefault())
+              Uint8List? image;
+              try {
+                image = await (service ?? ImagePickerServiceDefault())
                     .pickImage(imageSource, config: config);
+              } on PlatformException catch (e) {
+                debugPrint("image_picker_error: $e");
+                onError?.call(e);
+              }
               navigator.pop(image);
             },
             child: customIcon ??

pubspec.yaml

@@ -1,16 +1,18 @@
 name: flutter_image_picker
 description: A Flutter Image Picking package.
-version: 2.0.0
+version: 4.1.0
 repository: https://github.com/Iconica-Development/flutter_image_picker
 
+publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
+
 environment:
-  sdk: ">=2.17.6 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
   flutter: ">=1.17.0"
 
 dependencies:
   flutter:
     sdk: flutter
-  image_picker: ^1.0.7
+  image_picker: ^1.1.2
 
 dev_dependencies:
   flutter_test:
@@ -19,6 +21,4 @@ dev_dependencies:
   flutter_iconica_analysis:
     git:
       url: https://github.com/Iconica-Development/flutter_iconica_analysis
-      ref: 6.0.0
-
-flutter:
+      ref: 7.0.0

test/image_picker_ui_test.dart

@@ -2,22 +2,22 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'dart:typed_data';
+import "dart:typed_data";
 
-import 'package:flutter/material.dart';
-import 'package:flutter_image_picker/flutter_image_picker.dart'
+import "package:flutter/material.dart";
+import "package:flutter_image_picker/flutter_image_picker.dart"
     as iconica_image_picker;
-import 'package:flutter_test/flutter_test.dart';
-import 'package:image_picker/image_picker.dart' as image_picker;
-import 'package:mocktail/mocktail.dart';
+import "package:flutter_test/flutter_test.dart";
+import "package:image_picker/image_picker.dart" as image_picker;
+import "package:mocktail/mocktail.dart";
 
-import 'mocks/image_picker_service_mock.dart';
+import "mocks/image_picker_service_mock.dart";
 
 void main() {
   var cameraImage = Uint8List(10);
   var galleryImage = Uint8List(44);
 
-  testWidgets('Image Picker Shows With Normal Theme', (tester) async {
+  testWidgets("Image Picker Shows With Normal Theme", (tester) async {
     await tester.pumpWidget(
       const MaterialApp(
         home: Material(
@@ -32,7 +32,7 @@ void main() {
     var selectImageIconFinder = find.byIcon(Icons.image);
     var selectImageTextFinder = find
         .text(const iconica_image_picker.ImagePickerTheme().selectImageText);
-    var closebuttonTextFinder = find.text('Close');
+    var closebuttonTextFinder = find.text("Close");
 
     expect(makePhotoIconFinder, findsOneWidget);
     expect(makePhotoTextFinder, findsOneWidget);
@@ -42,7 +42,7 @@ void main() {
   });
 
   testWidgets(
-      'Image Picker Calls Function Correctly When ImageSource Is Gallery',
+      "Image Picker Calls Function Correctly When ImageSource Is Gallery",
       (tester) async {
     var serviceMock = ImagePickerServiceMock();
 
@@ -70,7 +70,7 @@ void main() {
   });
 
   testWidgets(
-      'Image Picker Calls Function Correctly When ImageSource Is Camera',
+      "Image Picker Calls Function Correctly When ImageSource Is Camera",
       (tester) async {
     var serviceMock = ImagePickerServiceMock();
 
@@ -97,20 +97,20 @@ void main() {
         .called(1);
   });
 
-  testWidgets('Image Picker Shows With Custom Theme', (tester) async {
+  testWidgets("Image Picker Shows With Custom Theme", (tester) async {
     Widget makePhotoIcon = Container(
       height: 125,
       width: 125,
       color: Colors.red,
     );
-    var makePhotoText = 'taaaake image';
+    var makePhotoText = "taaaake image";
     Widget selectImageIcon = Container(
       height: 125,
       width: 125,
       color: Colors.blue,
     );
-    var selectImageText = 'seleeeeect image';
-    var closeButtonText = 'Close';
+    var selectImageText = "seleeeeect image";
+    var closeButtonText = "Close";
 
     await tester.pumpWidget(
       MaterialApp(

test/mocks/image_picker_service_mock.dart

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter_image_picker/src/services/image_picker_service.dart';
-import 'package:mocktail/mocktail.dart';
+import "package:flutter_image_picker/src/services/image_picker_service.dart";
+import "package:mocktail/mocktail.dart";
 
 class ImagePickerServiceMock extends Mock implements ImagePickerService {}