⚡️ Expose Key for picking (#339)

Author: AlexV525

CHANGELOG.md

@@ -8,9 +8,10 @@ that can be found in the LICENSE file. -->
 
 To know more about breaking changes, see [Migration Guide][].
 
-### Improvements
+### New Features
 
-- Introduce `PathWrapper` to improve the overall loading speed. (#338)
+- Introduce `PathWrapper` in delegates to improve the overall loading speed. (#338)
+- Allow using `Key` during picking. (#339)
 
 ## 7.3.2
 

lib/src/delegates/asset_picker_delegate.dart

@@ -10,7 +10,6 @@ import 'package:photo_manager/photo_manager.dart';
 import '../constants/config.dart';
 import '../constants/constants.dart';
 import '../internal/methods.dart';
-import '../internal/singleton.dart';
 import '../provider/asset_picker_provider.dart';
 import '../widget/asset_picker.dart';
 import '../widget/asset_picker_page_route.dart';
@@ -62,6 +61,7 @@ class AssetPickerDelegate {
   /// {@endtemplate}
   Future<List<AssetEntity>?> pickAssets(
     BuildContext context, {
+    Key? key,
     AssetPickerConfig pickerConfig = const AssetPickerConfig(),
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<AssetEntity>>? pageRouteBuilder,
@@ -77,7 +77,7 @@ class AssetPickerDelegate {
       filterOptions: pickerConfig.filterOptions,
     );
     final Widget picker = AssetPicker<AssetEntity, AssetPathEntity>(
-      key: Singleton.pickerKey,
+      key: key,
       builder: DefaultAssetPickerBuilderDelegate(
         provider: provider,
         initialPermission: ps,
@@ -130,12 +130,13 @@ class AssetPickerDelegate {
       PickerProvider extends AssetPickerProvider<Asset, Path>>(
     BuildContext context, {
     required AssetPickerBuilderDelegate<Asset, Path> delegate,
+    Key? key,
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<Asset>>? pageRouteBuilder,
   }) async {
     await permissionCheck();
     final Widget picker = AssetPicker<Asset, Path>(
-      key: Singleton.pickerKey,
+      key: key,
       builder: delegate,
     );
     final List<Asset>? result = await Navigator.of(

lib/src/internal/singleton.dart

@@ -11,8 +11,6 @@ import '../delegates/sort_path_delegate.dart';
 class Singleton {
   const Singleton._();
 
-  static GlobalKey pickerKey = GlobalKey();
-
   static AssetPickerTextDelegate textDelegate = const AssetPickerTextDelegate();
   static SortPathDelegate<dynamic> sortPathDelegate = SortPathDelegate.common;
 

lib/src/widget/asset_picker.dart

@@ -38,12 +38,14 @@ class AssetPicker<Asset, Path> extends StatefulWidget {
   /// {@macro wechat_assets_picker.delegates.AssetPickerDelegate.pickAssets}
   static Future<List<AssetEntity>?> pickAssets(
     BuildContext context, {
+    Key? key,
     AssetPickerConfig pickerConfig = const AssetPickerConfig(),
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<AssetEntity>>? pageRouteBuilder,
   }) {
     return _pickerDelegate.pickAssets(
       context,
+      key: key,
       pickerConfig: pickerConfig,
       useRootNavigator: useRootNavigator,
       pageRouteBuilder: pageRouteBuilder,
@@ -54,12 +56,14 @@ class AssetPicker<Asset, Path> extends StatefulWidget {
   static Future<List<Asset>?> pickAssetsWithDelegate<Asset, Path,
       PickerProvider extends AssetPickerProvider<Asset, Path>>(
     BuildContext context, {
+    Key? key,
     required AssetPickerBuilderDelegate<Asset, Path> delegate,
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<Asset>>? pageRouteBuilder,
   }) {
     return _pickerDelegate.pickAssetsWithDelegate<Asset, Path, PickerProvider>(
       context,
+      key: key,
       delegate: delegate,
       useRootNavigator: useRootNavigator,
       pageRouteBuilder: pageRouteBuilder,

test/delegates/builder_delegate_test.dart

@@ -67,6 +67,7 @@ class TestAssetPickerDelegate extends AssetPickerDelegate {
   @override
   Future<List<AssetEntity>?> pickAssets(
     BuildContext context, {
+    Key? key,
     AssetPickerConfig pickerConfig = const AssetPickerConfig(),
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<AssetEntity>>? pageRouteBuilder,
@@ -97,6 +98,7 @@ class TestAssetPickerDelegate extends AssetPickerDelegate {
       ..hasAssetsToDisplay = true
       ..totalAssetsCount = 1;
     final Widget picker = AssetPicker<AssetEntity, AssetPathEntity>(
+      key: key,
       builder: DefaultAssetPickerBuilderDelegate(
         provider: provider,
         initialPermission: ps,