Note

This native picker depends on the photos in thePhotos for MacOS App, which uses theApple PhotosUI Picker, also known as PHPicker.

✨ Features

🛠️ Getting started

$ flutter pub add image_picker image_picker_macos native_image_picker_macos

Tip

After registering this implementation as outlined in theUsage section, you canuse theimage_picker plugin as usual.

📜 Usage

Future<void>main()async {WidgetsFlutterBinding.ensureInitialized();awaitNativeImagePickerMacOS.registerWithIfSupported();// ADD THIS LINErunApp(constMainApp());}

finalbool isRegistered=NativeImagePickerMacOS.isRegistered();// ORimport'package:image_picker_platform_interface/image_picker_platform_interface.dart';finalbool isRegistered=ImagePickerPlatform.instanceisNativeImagePickerMacOS;

finalbool isSupported=awaitNativeImagePickerMacOS.isSupported();// Returns false on non-macOS platforms or if PHPicker is not supported on the current macOS version.

// NOTE: This code assumes the current target platform is macOS and native_image_picker_macos implementation is supported.import'package:image_picker_macos/image_picker_macos.dart';import'package:native_image_picker_macos/native_image_picker_macos.dart';// To switch to image_picker_macos (supported on all macOS versions):ImagePickerMacOS.registerWith();// To switch to native_image_picker_macos (supported on macOS 13 and above):NativeImagePickerMacOS.registerWith();

awaitNativeImagePickerMacOS.instanceOrNull?.openPhotosApp();// ORfinalImagePickerPlatform imagePickerImplementation=ImagePickerPlatform.instance;if (imagePickerImplementationisNativeImagePickerMacOS) {await imagePickerImplementation.openPhotosApp();}

Tip

You can useNativeImagePickerMacOS.registerWith() to register this implementation. However, this bypasses platform checks, whichmay result in runtime errors if the current platform is not macOS or if the macOS version is unsupported. Instead, useregisterWithIfSupported() if uncertain.

🌱 Contributing

$ dart run pigeon --input pigeons/messages.dart# To generate the required Dart and host-language code.$ dart run build_runner build --delete-conflicting-outputs# To generate the mock classes.$ swift-format format --in-place --recursive macos/native_image_picker_macos/Sources/native_image_picker_macos example/macos/Runner example/macos/RunnerTests example/macos/RunnerUITests# To format the Swift code.$ dart format.# To format the Dart code.$ (cd example/macos&& xcodebuildtest -workspace Runner.xcworkspace -scheme Runner -configuration Debug -quiet)# To run the native macOS unit tests.$ fluttertest# To run the Flutter unit tests.

Resources

ℹ️ Limitations

📚 Additional information

🧪 Testing

Tip

With this approach, you can effectively test this platform implementation with the existing packages that useimage_picker APIs. All platform-specific calls toNativeImagePickerMacOS should use the instance fromImagePickerPlatform.instance instead of creating a newNativeImagePickerMacOS to work.

$ flutter pub add dev:mockito dev:image_picker_platform_interface dev:build_runner dev:plugin_platform_interface# Add them as dev-dependencies

import'package:mockito/annotations.dart';import'package:mockito/mockito.dart';import'package:native_image_picker_macos/native_image_picker_macos.dart';@GenerateNiceMocks([MockSpec<NativeImagePickerMacOS>()])

$ dart run build_runner build --delete-conflicting-outputs

import'package:image_picker_platform_interface/image_picker_platform_interface.dart';import'package:flutter_test/flutter_test.dart';voidmain() {TestWidgetsFlutterBinding.ensureInitialized();lateMockNativeImagePickerMacOS mockNativeImagePickerMacOS;setUp(() {    mockNativeImagePickerMacOS=MockNativeImagePickerMacOS();ImagePickerPlatform.instance= mockNativeImagePickerMacOS;  });// Your tests, example:testWidgets('pressing the open photos button calls openPhotosApp from $NativeImagePickerMacOS',    (WidgetTester tester)async {await tester          .pumpWidget(constExampleWidget());// REPLACE WITH THE TARGET WIDGETfinal openPhotosFinder=          find.text('Open Photos App');// REPLACE WITH THE BUTTON TEXTexpect(openPhotosFinder, findsOneWidget);// Assuming the openPhotosApp call will success.when(mockNativeImagePickerMacOS.openPhotosApp())          .thenAnswer((_)async=>true);await tester.tap(openPhotosFinder);await tester.pump();verify(mockNativeImagePickerMacOS.openPhotosApp()).called(1);verifyNoMoreInteractions(mockNativeImagePickerMacOS);    },  );// ...}

 Assertion failed: "Platform interfaces must not be implemented with `implements`"

import'package:plugin_platform_interface/plugin_platform_interface.dart';// This doesn't work yet since MockNativeImagePickerMacOS is generated, unlike the mocktail package.classMockNativeImagePickerMacOSextendsMockwithMockPlatformInterfaceMixinimplementsNativeImagePickerMacOS {}

@GenerateNiceMocks([MockSpec<NativeImagePickerMacOS>(as:Symbol('BaseMockNativeImagePickerMacOS'))])// This name should be different than MockNativeImagePickerMacOS for the mockito generation to successimport'<current-test-file-name>.mocks.dart';// REPLACE <current-test-file-name> with the current test file name without extensionimport'package:plugin_platform_interface/plugin_platform_interface.dart';classMockNativeImagePickerMacOSextendsBaseMockNativeImagePickerMacOSwithMockPlatformInterfaceMixin {}// Use MockNativeImagePickerMacOS instead of BaseMockNativeImagePickerMacOS for creating the mock of NativeImagePickerMacOS

Note

Refer to theFlutter documentation on mocking dependencies using Mockito for more details.