🧑‍💻 Add more comments and notices

Author: AlexV525

README-ZH.md

@@ -433,10 +433,9 @@ Future<dio.MultipartFile> multipartFileFromAssetEntity(AssetEntity entity) async
 更多用法请查看示例中的 `Custom` 页面，
 该页面包含一个以 `<File, Directory>` 为类型基础的选择器。
 
-你可以在「Custom」页面尝试自定义的选择器。
-目前我们提供了一个基于 `Directory` 和 `File`
-（与 `photo_manager` 完全无关）实现的选择器，
-以及一个多 Tab 页切换的选择器。
+想要了解如何完全自定义主题、widget 和布局，前往 [示例](example/lib/customs/pickers)
+查看已有的自定义选择器的实现。
+
 如果你觉得你的实现有价值或能帮助到其他人，欢迎以 PR 的形式进行提交。
 更多细节请阅读 [贡献自定义实现][]。
 

README.md

@@ -448,9 +448,10 @@ You can extend them and use your own
 type with generic type `<A: Asset, P: Path>`,
 then implement abstract methods.
 
-We've defined a picker that integrates with `Directory` and `File`
-(completely out of the `photo_manager` scope),
-and a picker with multiple tabs switching in the "Custom" page.
+To know about how to fully customize themes, widgets or layouts.
+See how to customize delegates in the custom pickers page in the
+[example](example/lib/customs/pickers).
+
 You can submit PRs to create your own implementation
 if you found your implementation might be useful for others.
 See [Contribute custom implementations][] for more details.

example/lib/l10n/app_en.arb

@@ -7,6 +7,7 @@
   "navSingle": "Single",
   "navCustom": "Custom",
   "selectedAssetsText": "Selected Assets",
+  "pickMethodNotice": "Pickers in this page are located at the {dist}, defined by `pickMethods`.",
   "pickMethodImageName": "Image picker",
   "pickMethodImageDescription": "Only pick image from device.",
   "pickMethodVideoName": "Video picker",
@@ -33,15 +34,15 @@
   "pickMethodChangeLanguagesDescription": "Pass AssetPickerTextDelegate to change between languages (e.g. EnglishAssetPickerTextDelegate).",
   "pickMethodPreventGIFPickedName": "Prevent GIF being picked",
   "pickMethodPreventGIFPickedDescription": "Use selectPredicate to banned GIF picking when tapped.",
-  "pickMethodCustomizableThemeName": "Customizable theme",
+  "pickMethodCustomizableThemeName": "Customizable theme (ThemeData)",
   "pickMethodCustomizableThemeDescription": "Picking assets with the light theme or with a different color.",
   "pickMethodPathNameBuilderName": "Path name builder",
   "pickMethodPathNameBuilderDescription": "Add \uD83C\uDF6D after paths name.",
   "pickMethodWeChatMomentName": "WeChat Moment",
   "pickMethodWeChatMomentDescription": "Pick assets with images or only 1 video.",
   "pickMethodCustomImagePreviewThumbSizeName": "Custom image preview thumb size",
   "pickMethodCustomImagePreviewThumbSizeDescription": "You can reduce the thumb size to get faster load speed.",
-  "customPickerNotice": "This page contains customized pickers with different asset types, different UI layouts, or some use case for specific apps. Contribute to add your custom picker are welcomed.",
+  "customPickerNotice": "This page contains customized pickers with different asset types, different UI layouts, or some use case for specific apps. Contribute to add your custom picker are welcomed.\nPickers in this page are located at the lib/customs/pickers folder.",
   "customPickerCallThePickerButton": "\uD83C\uDF81 Call the Picker",
   "customPickerDirectoryAndFileName": "Directory+File picker",
   "customPickerDirectoryAndFileDescription": "This is a custom picker built for `File`.\nBy browsing this picker, we want you to know that you can build your own picker components using the entity's type you desired.\n\nIn this page, picker will grab files from `getExternalStorageDirectory`, then check whether it contains images. Put files into the path to see how this custom picker work.",

example/lib/l10n/app_zh.arb

@@ -7,6 +7,7 @@
   "navSingle": "单选",
   "navCustom": "自定义",
   "selectedAssetsText": "已选的资源",
+  "pickMethodNotice": "该页面的所有选择器的代码位于 {dist}，由 `pickMethods` 定义。",
   "pickMethodCommonName": "常用选择",
   "pickMethodCommonDescription": "选择图片和视频。",
   "pickMethodImageName": "图片选择",
@@ -33,15 +34,15 @@
   "pickMethodChangeLanguagesDescription": "传入 AssetPickerTextDelegate 手动更改选择器的语言（例如 EnglishAssetPickerTextDelegate）。",
   "pickMethodPreventGIFPickedName": "禁止选择 GIF 图片",
   "pickMethodPreventGIFPickedDescription": "通过 selectPredicate 来禁止 GIF 图片在点击时被选择。",
-  "pickMethodCustomizableThemeName": "自定义主题",
+  "pickMethodCustomizableThemeName": "自定义主题 (ThemeData)",
   "pickMethodCustomizableThemeDescription": "可以用亮色或其他颜色及自定义的主题进行选择。",
   "pickMethodPathNameBuilderName": "构建路径名称",
   "pickMethodPathNameBuilderDescription": "在路径后添加 \uD83C\uDF6D 进行自定义。",
   "pickMethodWeChatMomentName": "微信朋友圈模式",
   "pickMethodWeChatMomentDescription": "允许选择图片或仅 1 个视频。",
   "pickMethodCustomImagePreviewThumbSizeName": "自定义图片预览的缩略图大小",
   "pickMethodCustomImagePreviewThumbSizeDescription": "通过降低缩略图的质量来获得更快的加载速度。",
-  "customPickerNotice": "本页面包含了多种方式、不同界面和特定应用的自定义选择器。欢迎贡献添加你自定义的选择器。",
+  "customPickerNotice": "本页面包含了多种方式、不同界面和特定应用的自定义选择器。欢迎贡献添加你自定义的选择器。\n该页面的所有选择器的代码位于 lib/customs/pickers 目录。",
   "customPickerCallThePickerButton": "\uD83C\uDF81 开始选择资源",
   "customPickerDirectoryAndFileName": "Directory+File 选择器",
   "customPickerDirectoryAndFileDescription": "为 `File` 构建的自定义选择器。\n通过阅读该选择器的源码，你可以学习如何完全以你自定义的资源类型来构建并选择器的界面。\n\n该选择器会从 `getExternalStorageDirectory` 目录获取资源，然后检查它是否包含图片。你需要将图片放在该目录来查看选择器的效果。",

example/lib/l10n/gen/app_localizations.dart

@@ -135,6 +135,12 @@ abstract class AppLocalizations {
   /// **'Selected Assets'**
   String get selectedAssetsText;
 
+  /// No description provided for @pickMethodNotice.
+  ///
+  /// In en, this message translates to:
+  /// **'Pickers in this page are located at the {dist}, defined by `pickMethods`.'**
+  String pickMethodNotice(Object dist);
+
   /// No description provided for @pickMethodImageName.
   ///
   /// In en, this message translates to:
@@ -294,7 +300,7 @@ abstract class AppLocalizations {
   /// No description provided for @pickMethodCustomizableThemeName.
   ///
   /// In en, this message translates to:
-  /// **'Customizable theme'**
+  /// **'Customizable theme (ThemeData)'**
   String get pickMethodCustomizableThemeName;
 
   /// No description provided for @pickMethodCustomizableThemeDescription.
@@ -342,7 +348,7 @@ abstract class AppLocalizations {
   /// No description provided for @customPickerNotice.
   ///
   /// In en, this message translates to:
-  /// **'This page contains customized pickers with different asset types, different UI layouts, or some use case for specific apps. Contribute to add your custom picker are welcomed.'**
+  /// **'This page contains customized pickers with different asset types, different UI layouts, or some use case for specific apps. Contribute to add your custom picker are welcomed.\nPickers in this page are located at the lib/customs/pickers folder.'**
   String get customPickerNotice;
 
   /// No description provided for @customPickerCallThePickerButton.

example/lib/l10n/gen/app_localizations_en.dart

@@ -27,6 +27,11 @@ class AppLocalizationsEn extends AppLocalizations {
   @override
   String get selectedAssetsText => 'Selected Assets';
 
+  @override
+  String pickMethodNotice(Object dist) {
+    return 'Pickers in this page are located at the $dist, defined by `pickMethods`.';
+  }
+
   @override
   String get pickMethodImageName => 'Image picker';
 
@@ -106,7 +111,7 @@ class AppLocalizationsEn extends AppLocalizations {
   String get pickMethodPreventGIFPickedDescription => 'Use selectPredicate to banned GIF picking when tapped.';
 
   @override
-  String get pickMethodCustomizableThemeName => 'Customizable theme';
+  String get pickMethodCustomizableThemeName => 'Customizable theme (ThemeData)';
 
   @override
   String get pickMethodCustomizableThemeDescription => 'Picking assets with the light theme or with a different color.';
@@ -130,7 +135,7 @@ class AppLocalizationsEn extends AppLocalizations {
   String get pickMethodCustomImagePreviewThumbSizeDescription => 'You can reduce the thumb size to get faster load speed.';
 
   @override
-  String get customPickerNotice => 'This page contains customized pickers with different asset types, different UI layouts, or some use case for specific apps. Contribute to add your custom picker are welcomed.';
+  String get customPickerNotice => 'This page contains customized pickers with different asset types, different UI layouts, or some use case for specific apps. Contribute to add your custom picker are welcomed.\nPickers in this page are located at the lib/customs/pickers folder.';
 
   @override
   String get customPickerCallThePickerButton => '🎁 Call the Picker';

example/lib/l10n/gen/app_localizations_zh.dart

@@ -27,6 +27,11 @@ class AppLocalizationsZh extends AppLocalizations {
   @override
   String get selectedAssetsText => '已选的资源';
 
+  @override
+  String pickMethodNotice(Object dist) {
+    return '该页面的所有选择器的代码位于 $dist，由 `pickMethods` 定义。';
+  }
+
   @override
   String get pickMethodImageName => '图片选择';
 
@@ -106,7 +111,7 @@ class AppLocalizationsZh extends AppLocalizations {
   String get pickMethodPreventGIFPickedDescription => '通过 selectPredicate 来禁止 GIF 图片在点击时被选择。';
 
   @override
-  String get pickMethodCustomizableThemeName => '自定义主题';
+  String get pickMethodCustomizableThemeName => '自定义主题 (ThemeData)';
 
   @override
   String get pickMethodCustomizableThemeDescription => '可以用亮色或其他颜色及自定义的主题进行选择。';
@@ -130,7 +135,7 @@ class AppLocalizationsZh extends AppLocalizations {
   String get pickMethodCustomImagePreviewThumbSizeDescription => '通过降低缩略图的质量来获得更快的加载速度。';
 
   @override
-  String get customPickerNotice => '本页面包含了多种方式、不同界面和特定应用的自定义选择器。欢迎贡献添加你自定义的选择器。';
+  String get customPickerNotice => '本页面包含了多种方式、不同界面和特定应用的自定义选择器。欢迎贡献添加你自定义的选择器。\n该页面的所有选择器的代码位于 lib/customs/pickers 目录。';
 
   @override
   String get customPickerCallThePickerButton => '🎁 开始选择资源';

example/lib/pages/multi_assets_page.dart

@@ -18,6 +18,9 @@ class MultiAssetsPage extends StatefulWidget {
 
 class _MultiAssetsPageState extends State<MultiAssetsPage>
     with AutomaticKeepAliveClientMixin, ExamplePageMixin {
+  @override
+  String get noticeText => 'lib/pages/multi_assets_page.dart';
+
   @override
   int get maxAssetsCount => 9;
 

example/lib/pages/page_mixin.dart

@@ -9,6 +9,7 @@ import 'package:wechat_assets_picker/wechat_assets_picker.dart'
         DefaultAssetPickerProvider,
         DefaultAssetPickerBuilderDelegate;
 
+import '../constants/extensions.dart';
 import '../constants/picker_method.dart';
 import '../widgets/method_list_view.dart';
 import '../widgets/selected_assets_list_view.dart';
@@ -31,6 +32,8 @@ mixin ExamplePageMixin<T extends StatefulWidget> on State<T> {
 
   List<PickMethod> pickMethods(BuildContext context);
 
+  String get noticeText;
+
   /// These fields are for the keep scroll position feature.
   late DefaultAssetPickerProvider keepScrollProvider =
       DefaultAssetPickerProvider();
@@ -69,6 +72,10 @@ mixin ExamplePageMixin<T extends StatefulWidget> on State<T> {
     super.build(context);
     return Column(
       children: <Widget>[
+        Padding(
+          padding: const EdgeInsets.all(20.0),
+          child: Text(context.l10n.pickMethodNotice(noticeText)),
+        ),
         Expanded(
           child: MethodListView(
             pickMethods: pickMethods(context),

example/lib/pages/single_assets_page.dart

@@ -18,6 +18,9 @@ class SingleAssetPage extends StatefulWidget {
 
 class _SingleAssetPageState extends State<SingleAssetPage>
     with AutomaticKeepAliveClientMixin, ExamplePageMixin {
+  @override
+  String get noticeText => 'lib/pages/single_assets_page.dart';
+
   @override
   int get maxAssetsCount => 1;