5.0 refactor

Author: AlexV525

.github/workflows/build_test.yml

@@ -1,10 +1,6 @@
 name: Build test
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 jobs:
   test_iOS:

.github/workflows/minimum_stable_version_test.yml

@@ -1,10 +1,6 @@
 name: Minumum stable version capability test
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 jobs:
   analysis:

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 5.0.0-dev.1
+
+- Allow users build their own picker with custom assets types. (See example.)
+
+### Breaking changes
+
+- Abstract `AssetPickerBuilderDelegate<A, P>`, `AssetPickerViewerBuilderDelegate<A, P>`,
+  `AssetPickerProvider<A, P>`, and minify the `AssetPickerViewerProvider<A>`. Support
+  custom types by generic type.
+
+- The `assets` param in `AssetPickerViewer.pushToViewer` is now `previewAssets`.
+
 ## 4.2.2
 
 - Suppress deprecated usage in example.
@@ -50,7 +62,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Experimenting status bar hidden on iOS.
 - Remove video player listener before pause.
 
-## Breaking changes
+### Breaking changes
 
 - `TextDelegate` -> `AssetsPickerTextDelegate` .
 
@@ -113,7 +125,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Enlarge preview button's detector area size.
 - Fix wrong properties usage causing infinite build when the page reaches the end.
 
-## Breaking changes
+### Breaking changes
 
 - `videoIndicatorBuilder` -> `durationIndicatorBuilder`.
 

README-ZH.md

@@ -17,6 +17,7 @@ Language: [English](README.md) | 中文简体
 
 ## 目录 🗂
 
+* [迁移指南](#迁移指南-)
 * [特性](#特性-)
 * [截图](#截图-)
 * [准备工作](#准备工作-)
@@ -38,6 +39,10 @@ Language: [English](README.md) | 中文简体
   * [从`File`或`Uint8List`创建`AssetEntity`的方法](#从file或uint8list创建assetentity的方法)
   * [控制台提示 'Failed to find GeneratedAppGlideModule'](#控制台提示-failed-to-find-generatedappglidemodule)
 
+## 迁移指南 ♻️
+
+查看 [迁移指南](doc/migration_guide.md).
+
 ## 特性 ✨
 
 - [x] 💚 99%的微信风格

README.md

@@ -38,6 +38,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
 
 ## Category 🗂
 
+* [Migration Guide](#migration-guide-)
 * [Features](#features-)
 * [Screenshots](#screenshots-)
 * [Preparing for use](#preparing-for-use-)
@@ -59,6 +60,10 @@ This project follows the [all-contributors](https://github.com/all-contributors/
   * [Create `AssetEntity` from `File` or `Uint8List` (rawData)](#create-assetentity-from-file-or-uint8list-rawdata)
   * [Console warning 'Failed to find GeneratedAppGlideModule'](#glide-warning-failed-to-find-generatedappglidemodule)
 
+## Migration Guide ♻️
+
+See [Migration Guide](doc/migration_guide.md).
+
 ## Features ✨
 
 - [x] 💚 99% simillar to WeChat style.

doc/migration_guide.md

@@ -0,0 +1,33 @@
+# Migration Guide
+
+## Migrate to 5.0.0
+
+### Summary
+
+_If you only use the `AssetPicker.pickAssets` and `AssetEntityImageProvider`,
+didn't use `AssetPickerViewer`, `AssetPickerProvider`, or other components separately,
+you can stop reading._
+
+`AssetPicker` and `AssetPickerViewer` are only a builder since 5.x, all widgets construct were moved
+to `AssetPickerBuilderDelegate` and `AssetPickerViewerBuilderDelegate`, and these delegates are both
+abstract.
+
+By splitting delegates, now you can build your own picker with custom types, style, and widgets.
+
+### Migration steps
+
+For how to implement a custom picker, see the example's custom page for more implementation details.
+
+* If you have ever use `AssetPickerViewer.pushToViewer`, the properties `assets` has changed to
+  `previewAssets`.
+
+* If you have extends an `AssetPickerProvider` or `AssetPickerViewerProvider`, it now requires you
+  to pass generic type `A` and `P`, and handle the entities on your own.
+
+### References
+
+API documentation:
+* `AssetPickerBuilderDelegate`: https://pub.dev/documentation/wechat_assets_picker/latest/wechat_assets_picker/AssetPickerBuilderDelegate-class.html
+* `AssetPickerViewerBuilderDelegate`: https://pub.dev/documentation/wechat_assets_picker/latest/wechat_assets_picker/AssetPickerViewerBuilderDelegate-class.html
+* `AssetPickerProvider`: https://pub.dev/documentation/wechat_assets_picker/latest/wechat_assets_picker/AssetPickerProvider-class.html
+* `AssetPickerViewerProvider`: https://pub.dev/documentation/wechat_assets_picker/latest/wechat_assets_picker/AssetPickerViewerProvider-class.html

example/lib/constants/resource.dart

@@ -1,7 +1,6 @@
 /// Generate by [resource_generator](https://github.com/CaiJingLong/flutter_resource_generator) library.
 /// PLEASE DO NOT EDIT MANUALLY.
 class R {
-  /// ![preview](file:///assets/flutter_candies_logo.png)
   static const String ASSETS_FLUTTER_CANDIES_LOGO_PNG =
       'assets/flutter_candies_logo.png';
 }