💬 A -> Asset, P -> Path

Author: AlexV525

guides/migration_guide.md

@@ -62,7 +62,7 @@ you can stop reading._
 Before:
 
 ```dart
-void switchPath(P pathEntity);
+void switchPath(Path pathEntity);
 ```
 
 After:
@@ -93,4 +93,4 @@ For how to implement a custom picker, see the example's custom page for more imp
   `previewAssets`.
 
 - If you have extended an `AssetPickerProvider` or `AssetPickerViewerProvider`, it now requires you
-  to pass generic type `A` and `P`, and handle the entities on your own.
+  to pass generic type `Asset` and `Path`, and handle the entities on your own.

lib/src/delegates/asset_picker_builder_delegate.dart

@@ -24,9 +24,9 @@ typedef IndicatorBuilder = Widget Function(
 ///
 /// By extending the delegate, you can customize every components on you own.
 /// Delegate requires two generic types:
-///  * [A] "Asset": The type of your assets. Defaults to [AssetEntity].
-///  * [P] "Path": The type of your paths. Defaults to [AssetPathEntity].
-abstract class AssetPickerBuilderDelegate<A, P> {
+///  * [Asset] The type of your assets. Defaults to [AssetEntity].
+///  * [Path] The type of your paths. Defaults to [AssetPathEntity].
+abstract class AssetPickerBuilderDelegate<Asset, Path> {
   AssetPickerBuilderDelegate({
     required this.provider,
     required this.initialPermission,
@@ -49,7 +49,7 @@ abstract class AssetPickerBuilderDelegate<A, P> {
 
   /// [ChangeNotifier] for asset picker.
   /// 资源选择器状态保持
-  final AssetPickerProvider<A, P> provider;
+  final AssetPickerProvider<Asset, Path> provider;
 
   /// The [PermissionState] when the picker is called.
   /// 当选择器被拉起时的权限状态
@@ -179,7 +179,7 @@ abstract class AssetPickerBuilderDelegate<A, P> {
   /// 路径单独条目选择组件
   Widget pathEntityWidget({
     required BuildContext context,
-    required Map<P, Uint8List?> list,
+    required Map<Path, Uint8List?> list,
     required int index,
     bool isAudio = false,
   });
@@ -203,7 +203,7 @@ abstract class AssetPickerBuilderDelegate<A, P> {
 
   /// GIF image type indicator.
   /// GIF类型图片指示
-  Widget gifIndicator(BuildContext context, A asset) {
+  Widget gifIndicator(BuildContext context, Asset asset) {
     return PositionedDirectional(
       start: 0,
       bottom: 0,
@@ -245,29 +245,29 @@ abstract class AssetPickerBuilderDelegate<A, P> {
 
   /// Audio asset type indicator.
   /// 音频类型资源指示
-  Widget audioIndicator(BuildContext context, A asset);
+  Widget audioIndicator(BuildContext context, Asset asset);
 
   /// Video asset type indicator.
   /// 视频类型资源指示
-  Widget videoIndicator(BuildContext context, A asset);
+  Widget videoIndicator(BuildContext context, Asset asset);
 
   /// Animated backdrop widget for items.
   /// 部件选中时的动画遮罩部件
   Widget selectedBackdrop(
     BuildContext context,
     int index,
-    A asset,
+    Asset asset,
   );
 
   /// Indicator for assets selected status.
   /// 资源是否已选的指示器
-  Widget selectIndicator(BuildContext context, A asset);
+  Widget selectIndicator(BuildContext context, Asset asset);
 
   /// Indicator when the asset cannot be selected.
   /// 当资源无法被选中时的遮罩
-  Widget itemBannedIndicator(BuildContext context, A asset) {
-    return Consumer<AssetPickerProvider<A, P>>(
-      builder: (_, AssetPickerProvider<A, P> p, __) {
+  Widget itemBannedIndicator(BuildContext context, Asset asset) {
+    return Consumer<AssetPickerProvider<Asset, Path>>(
+      builder: (_, AssetPickerProvider<Asset, Path> p, __) {
         if (!p.selectedAssets.contains(asset) && p.selectedMaximumAssets) {
           return Container(
             color: theme.colorScheme.background.withOpacity(.85),
@@ -282,8 +282,8 @@ abstract class AssetPickerBuilderDelegate<A, P> {
   /// 加载指示器
   Widget loadingIndicator(BuildContext context) {
     return Center(
-      child: Selector<AssetPickerProvider<A, P>, bool>(
-        selector: (_, AssetPickerProvider<A, P> provider) =>
+      child: Selector<AssetPickerProvider<Asset, Path>, bool>(
+        selector: (_, AssetPickerProvider<Asset, Path> provider) =>
             provider.isAssetsEmpty,
         builder: (BuildContext c, bool isAssetsEmpty, Widget? w) {
           if (loadingIndicatorBuilder != null) {
@@ -338,7 +338,7 @@ abstract class AssetPickerBuilderDelegate<A, P> {
   /// 为 Grid 布局指示如何找到可复用的 [RenderObject]。
   int? findChildIndexBuilder({
     required String id,
-    required List<A> assets,
+    required List<Asset> assets,
     int placeholderCount = 0,
   }) =>
       null;
@@ -347,7 +347,7 @@ abstract class AssetPickerBuilderDelegate<A, P> {
   /// 为资源列表提供内容数量计算的方法
   int assetsGridItemCount({
     required BuildContext context,
-    required List<A> assets,
+    required List<Asset> assets,
     int placeholderCount = 0,
   });
 
@@ -356,23 +356,23 @@ abstract class AssetPickerBuilderDelegate<A, P> {
   Widget assetGridItemBuilder(
     BuildContext context,
     int index,
-    List<A> currentAssets,
+    List<Asset> currentAssets,
   );
 
   /// The item builder for audio type of asset.
   /// 音频资源的部件构建
   Widget audioItemBuilder(
     BuildContext context,
     int index,
-    A asset,
+    Asset asset,
   );
 
   /// The item builder for images and video type of asset.
   /// 图片和视频资源的部件构建
   Widget imageAndVideoItemBuilder(
     BuildContext context,
     int index,
-    A asset,
+    Asset asset,
   );
 
   /// Preview button to preview selected assets.
@@ -563,7 +563,7 @@ abstract class AssetPickerBuilderDelegate<A, P> {
       value: overlayStyle,
       child: Theme(
         data: theme,
-        child: ChangeNotifierProvider<AssetPickerProvider<A, P>>.value(
+        child: ChangeNotifierProvider<AssetPickerProvider<Asset, Path>>.value(
           value: provider,
           builder: (BuildContext c, __) => Material(
             color: theme.canvasColor,

lib/src/delegates/asset_picker_viewer_builder_delegate.dart

@@ -14,7 +14,7 @@ import '../constants/constants.dart';
 import '../widget/builder/value_listenable_builder_2.dart';
 import '../widget/custom_checkbox.dart';
 
-abstract class AssetPickerViewerBuilderDelegate<A, P> {
+abstract class AssetPickerViewerBuilderDelegate<Asset, Path> {
   AssetPickerViewerBuilderDelegate({
     required this.previewAssets,
     required this.themeData,
@@ -27,23 +27,23 @@ abstract class AssetPickerViewerBuilderDelegate<A, P> {
 
   /// [ChangeNotifier] for photo selector viewer.
   /// 资源预览器的状态保持
-  final AssetPickerViewerProvider<A>? provider;
+  final AssetPickerViewerProvider<Asset>? provider;
 
   /// Assets provided to preview.
   /// 提供预览的资源
-  final List<A> previewAssets;
+  final List<Asset> previewAssets;
 
   /// Theme for the viewer.
   /// 主题
   final ThemeData themeData;
 
   /// Selected assets.
   /// 已选的资源
-  final List<A>? selectedAssets;
+  final List<Asset>? selectedAssets;
 
   /// Provider for [AssetPicker].
   /// 资源选择器的状态保持
-  final AssetPickerProvider<A, P>? selectorProvider;
+  final AssetPickerProvider<Asset, Path>? selectorProvider;
 
   /// [StreamController] for viewing page index update.
   /// 用于更新当前正在浏览的资源页码的流控制器
@@ -61,7 +61,7 @@ abstract class AssetPickerViewerBuilderDelegate<A, P> {
 
   /// The [State] for a viewer.
   /// 预览器的状态实例
-  late final AssetPickerViewerState<A, P> viewerState;
+  late final AssetPickerViewerState<Asset, Path> viewerState;
 
   /// The [TickerProvider] for animations.
   /// 用于动画的 [TickerProvider]
@@ -81,7 +81,7 @@ abstract class AssetPickerViewerBuilderDelegate<A, P> {
 
   /// Getter for the current asset.
   /// 当前资源的Getter
-  A get currentAsset => previewAssets.elementAt(currentIndex);
+  Asset get currentAsset => previewAssets.elementAt(currentIndex);
 
   /// Height for bottom preview widget.
   /// 底栏预览部件的高度
@@ -99,7 +99,10 @@ abstract class AssetPickerViewerBuilderDelegate<A, P> {
 
   /// Call when viewer is calling [initState].
   /// 当预览器调用 [initState] 时注册 [State] 和 [TickerProvider]。
-  void initStateAndTicker(AssetPickerViewerState<A, P> s, TickerProvider v) {
+  void initStateAndTicker(
+    AssetPickerViewerState<Asset, Path> s,
+    TickerProvider v,
+  ) {
     viewerState = s;
     vsync = v;
   }
@@ -127,7 +130,7 @@ abstract class AssetPickerViewerBuilderDelegate<A, P> {
   late final ValueNotifier<int> selectedNotifier =
       ValueNotifier<int>(selectedCount);
 
-  void unSelectAsset(A entity) {
+  void unSelectAsset(Asset entity) {
     provider?.unSelectAssetEntity(entity);
     if (!isSelectedPreviewing) {
       selectedAssets?.remove(entity);
@@ -137,7 +140,7 @@ abstract class AssetPickerViewerBuilderDelegate<A, P> {
     }
   }
 
-  void selectAsset(A entity) {
+  void selectAsset(Asset entity) {
     if (maxAssets != null && selectedCount >= maxAssets!) {
       return;
     }

lib/src/provider/asset_picker_provider.dart

@@ -14,15 +14,15 @@ import '../constants/constants.dart';
 /// The provider maintain all methods that control assets and paths.
 /// By extending it you can customize how you can get all assets or paths,
 /// how to fetch the next page of assets, how to get the thumb data of a path.
-abstract class AssetPickerProvider<A, P> extends ChangeNotifier {
+abstract class AssetPickerProvider<Asset, Path> extends ChangeNotifier {
   AssetPickerProvider({
     this.maxAssets = 9,
     this.pageSize = 320,
     this.pathThumbSize = 80,
-    List<A>? selectedAssets,
+    List<Asset>? selectedAssets,
   }) {
     if (selectedAssets?.isNotEmpty == true) {
-      _selectedAssets = List<A>.from(selectedAssets!);
+      _selectedAssets = List<Asset>.from(selectedAssets!);
     }
   }
 
@@ -123,9 +123,9 @@ abstract class AssetPickerProvider<A, P> extends ChangeNotifier {
   ///
   /// Using [Map] in order to save the thumb data for the first asset under the path.
   /// 使用[Map]来保存路径下第一个资源的缩略数据。
-  final Map<P, Uint8List?> _pathEntityList = <P, Uint8List?>{};
+  final Map<Path, Uint8List?> _pathEntityList = <Path, Uint8List?>{};
 
-  Map<P, Uint8List?> get pathEntityList => _pathEntityList;
+  Map<Path, Uint8List?> get pathEntityList => _pathEntityList;
 
   /// How many path has a valid thumb data.
   /// 当前有多少目录已经正常载入了缩略图
@@ -138,11 +138,11 @@ abstract class AssetPickerProvider<A, P> extends ChangeNotifier {
 
   /// The path which is currently using.
   /// 正在查看的资源路径
-  P? _currentPathEntity;
+  Path? _currentPathEntity;
 
-  P? get currentPathEntity => _currentPathEntity;
+  Path? get currentPathEntity => _currentPathEntity;
 
-  set currentPathEntity(P? value) {
+  set currentPathEntity(Path? value) {
     if (value == null || value == _currentPathEntity) {
       return;
     }
@@ -152,29 +152,29 @@ abstract class AssetPickerProvider<A, P> extends ChangeNotifier {
 
   /// Assets under current path entity.
   /// 正在查看的资源路径下的所有资源
-  List<A> _currentAssets = <A>[];
+  List<Asset> _currentAssets = <Asset>[];
 
-  List<A> get currentAssets => _currentAssets;
+  List<Asset> get currentAssets => _currentAssets;
 
-  set currentAssets(List<A> value) {
+  set currentAssets(List<Asset> value) {
     if (value == _currentAssets) {
       return;
     }
-    _currentAssets = List<A>.from(value);
+    _currentAssets = List<Asset>.from(value);
     notifyListeners();
   }
 
   /// Selected assets.
   /// 已选中的资源
-  List<A> _selectedAssets = <A>[];
+  List<Asset> _selectedAssets = <Asset>[];
 
-  List<A> get selectedAssets => _selectedAssets;
+  List<Asset> get selectedAssets => _selectedAssets;
 
-  set selectedAssets(List<A> value) {
+  set selectedAssets(List<Asset> value) {
     if (value == _selectedAssets) {
       return;
     }
-    _selectedAssets = List<A>.from(value);
+    _selectedAssets = List<Asset>.from(value);
     notifyListeners();
   }
 
@@ -186,7 +186,7 @@ abstract class AssetPickerProvider<A, P> extends ChangeNotifier {
   /// 它为预览部件的选中部分的 [Selector] 提供了是否重建的条件。
   String get selectedDescriptions => _selectedAssets.fold(
         <String>[],
-        (List<String> list, A a) => list..add(a.toString()),
+        (List<String> list, Asset a) => list..add(a.toString()),
       ).join();
 
   /// 选中资源是否为空
@@ -201,38 +201,38 @@ abstract class AssetPickerProvider<A, P> extends ChangeNotifier {
 
   /// Get thumb data from the first asset under the specific path entity.
   /// 获取指定路径下的第一个资源的缩略数据
-  Future<Uint8List?> getFirstThumbFromPathEntity(P pathEntity);
+  Future<Uint8List?> getFirstThumbFromPathEntity(Path pathEntity);
 
   /// Get assets under the specific path entity.
   /// 获取指定路径下的资源
-  Future<void> getAssetsFromEntity(int page, P pathEntity);
+  Future<void> getAssetsFromEntity(int page, Path pathEntity);
 
   /// Load more assets.
   /// 加载更多资源
   Future<void> loadMoreAssets();
 
   /// Select asset.
   /// 选中资源
-  void selectAsset(A item) {
+  void selectAsset(Asset item) {
     if (selectedAssets.length == maxAssets || selectedAssets.contains(item)) {
       return;
     }
-    final List<A> _set = List<A>.from(selectedAssets);
+    final List<Asset> _set = List<Asset>.from(selectedAssets);
     _set.add(item);
     selectedAssets = _set;
   }
 
   /// Un-select asset.
   /// 取消选中资源
-  void unSelectAsset(A item) {
-    final List<A> _set = List<A>.from(selectedAssets);
+  void unSelectAsset(Asset item) {
+    final List<Asset> _set = List<Asset>.from(selectedAssets);
     _set.remove(item);
     selectedAssets = _set;
   }
 
   /// Switch path entity.
   /// 切换路径
-  Future<void> switchPath([P? pathEntity]);
+  Future<void> switchPath([Path? pathEntity]);
 }
 
 class DefaultAssetPickerProvider