Merge pull request #29 from CaiJingLong/add-pathlist

close #27

CHANGELOG.md

@@ -1,5 +1,7 @@
 # CHANGELOG
 
+## [0.2.1] add params photoList
+
 ## [0.2.0]
 
 **break change**

README.md

@@ -37,7 +37,7 @@ import 'package:photo_manager/photo_manager.dart';
 ## use
 
 ```dart
-void _pickImage() async {
+void pickAsset() async {
     List<AssetEntity> imgList = await PhotoPicker.pickAsset(
       context: context,
       // BuildContext requied
@@ -73,10 +73,20 @@ void _pickImage() async {
       loadingDelegate:
           this, // if you want to build custom loading widget,extends LoadingDelegate [see example/lib/main.dart]
 
+      badgeDelegate: const DefaultBadgeDelegate(), /// or custom class extends [BadgeDelegate]
+
       pickType: type, // all/image/video
+
+      List<AssetPathEntity> photoPathList, /// when [photoPathList] is not null , [pickType] invalid .
     );
 ```
 
+### about photoPathList params
+
+You can use [photo_manager] package to get `List<AssetPathEntity>` and handle or cache.
+
+This parameter is then passed into the `pickAsset` method, where the incoming photoList is rendered instead of the data in the album.
+
 ## whole example
 
 you can see [github](https://github.com/caijinglong/flutter_photo/blob/master/example/) [main.dart](https://github.com/caijinglong/flutter_photo/blob/master/example/lib/main.dart)

example/lib/main.dart

@@ -30,7 +30,84 @@ class MyHomePage extends StatefulWidget {
 class _MyHomePageState extends State<MyHomePage> with LoadingDelegate {
   String currentSelected = "";
 
-  void _pickAsset(PickType type) async {
+  @override
+  Widget buildBigImageLoading(
+      BuildContext context, AssetEntity entity, Color themeColor) {
+    return Center(
+      child: Container(
+        width: 50.0,
+        height: 50.0,
+        child: CupertinoActivityIndicator(
+          radius: 25.0,
+        ),
+      ),
+    );
+  }
+
+  @override
+  Widget buildPreviewLoading(
+      BuildContext context, AssetEntity entity, Color themeColor) {
+    return Center(
+      child: Container(
+        width: 50.0,
+        height: 50.0,
+        child: CupertinoActivityIndicator(
+          radius: 25.0,
+        ),
+      ),
+    );
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return new Scaffold(
+      appBar: new AppBar(
+        title: new Text(widget.title),
+        actions: <Widget>[
+          FlatButton(
+            child: Icon(Icons.image),
+            onPressed: _testPhotoListParams,
+          ),
+        ],
+      ),
+      body: Container(
+        child: SingleChildScrollView(
+          child: Column(
+            children: <Widget>[
+              IconTextButton(
+                  icon: Icons.photo,
+                  text: "photo",
+                  onTap: () => _pickAsset(PickType.onlyImage)),
+              IconTextButton(
+                  icon: Icons.videocam,
+                  text: "video",
+                  onTap: () => _pickAsset(PickType.onlyVideo)),
+              IconTextButton(
+                  icon: Icons.album,
+                  text: "all",
+                  onTap: () => _pickAsset(PickType.all)),
+              Text(
+                '$currentSelected',
+                textAlign: TextAlign.center,
+              ),
+            ],
+          ),
+        ),
+      ),
+      floatingActionButton: new FloatingActionButton(
+        onPressed: () => _pickAsset(PickType.all),
+        tooltip: 'pickImage',
+        child: new Icon(Icons.add),
+      ),
+    );
+  }
+
+  void _testPhotoListParams() async {
+    var assetPathList = await PhotoManager.getImageAsset();
+    _pickAsset(PickType.all, pathList: assetPathList);
+  }
+
+  void _pickAsset(PickType type, {List<AssetPathEntity> pathList}) async {
     List<AssetEntity> imgList = await PhotoPicker.pickAsset(
       // BuildContext required
       context: context,
@@ -72,6 +149,8 @@ class _MyHomePageState extends State<MyHomePage> with LoadingDelegate {
       // badgeDelegate to show badge widget
 
       pickType: type,
+
+      photoPathList: pathList,
     );
 
     if (imgList == null) {
@@ -86,61 +165,6 @@ class _MyHomePageState extends State<MyHomePage> with LoadingDelegate {
     }
     setState(() {});
   }
-
-  @override
-  Widget buildBigImageLoading(BuildContext context, AssetEntity entity, Color themeColor) {
-    return Center(
-      child: Container(
-        width: 50.0,
-        height: 50.0,
-        child: CupertinoActivityIndicator(
-          radius: 25.0,
-        ),
-      ),
-    );
-  }
-
-  @override
-  Widget buildPreviewLoading(BuildContext context, AssetEntity entity, Color themeColor) {
-    return Center(
-      child: Container(
-        width: 50.0,
-        height: 50.0,
-        child: CupertinoActivityIndicator(
-          radius: 25.0,
-        ),
-      ),
-    );
-  }
-
-  @override
-  Widget build(BuildContext context) {
-    return new Scaffold(
-      appBar: new AppBar(
-        title: new Text(widget.title),
-      ),
-      body: Container(
-        child: SingleChildScrollView(
-          child: Column(
-            children: <Widget>[
-              IconTextButton(icon: Icons.photo, text: "photo", onTap: () => _pickAsset(PickType.onlyImage)),
-              IconTextButton(icon: Icons.videocam, text: "video", onTap: () => _pickAsset(PickType.onlyVideo)),
-              IconTextButton(icon: Icons.album, text: "all", onTap: () => _pickAsset(PickType.all)),
-              Text(
-                '$currentSelected',
-                textAlign: TextAlign.center,
-              ),
-            ],
-          ),
-        ),
-      ),
-      floatingActionButton: new FloatingActionButton(
-        onPressed: () => _pickAsset(PickType.all),
-        tooltip: 'pickImage',
-        child: new Icon(Icons.add),
-      ),
-    );
-  }
 }
 
 class IconTextButton extends StatelessWidget {
@@ -148,7 +172,8 @@ class IconTextButton extends StatelessWidget {
   final String text;
   final Function onTap;
 
-  const IconTextButton({Key key, this.icon, this.text, this.onTap}) : super(key: key);
+  const IconTextButton({Key key, this.icon, this.text, this.onTap})
+      : super(key: key);
 
   @override
   Widget build(BuildContext context) {

lib/photo.dart

@@ -3,6 +3,9 @@ library photo;
 import 'dart:async';
 
 import 'package:flutter/material.dart';
+
+import 'package:photo_manager/photo_manager.dart';
+
 import 'package:photo/src/delegate/badge_delegate.dart';
 import 'package:photo/src/delegate/checkbox_builder_delegate.dart';
 import 'package:photo/src/delegate/loading_delegate.dart';
@@ -11,12 +14,11 @@ import 'package:photo/src/entity/options.dart';
 import 'package:photo/src/provider/i18n_provider.dart';
 import 'package:photo/src/ui/dialog/not_permission_dialog.dart';
 import 'package:photo/src/ui/photo_app.dart';
-import 'package:photo_manager/photo_manager.dart';
-
 export 'package:photo/src/delegate/checkbox_builder_delegate.dart';
 export 'package:photo/src/delegate/loading_delegate.dart';
 export 'package:photo/src/delegate/sort_delegate.dart';
-export 'package:photo/src/provider/i18n_provider.dart' show I18NCustomProvider, I18nProvider, CNProvider, ENProvider;
+export 'package:photo/src/provider/i18n_provider.dart'
+    show I18NCustomProvider, I18nProvider, CNProvider, ENProvider;
 export 'package:photo/src/entity/options.dart' show PickType;
 export 'package:photo/src/delegate/badge_delegate.dart';
 
@@ -42,6 +44,8 @@ class PhotoPicker {
   ///
   ///   当用户取消时返回一个空数组
   ///
+  ///   [photoPathList] 一旦设置 则 [pickType]参数无效
+  ///
   /// 关于参数可以查看readme文档介绍
   ///
   /// if user not grand permission, then return null and show a dialog to help user open setting.
@@ -53,6 +57,8 @@ class PhotoPicker {
   ///
   ///   when user cancel selected,result is empty list
   ///
+  ///   when [photoPathList] is not null , [pickType] invalid
+  ///
   /// params see readme.md
   static Future<List<AssetEntity>> pickAsset({
     @required BuildContext context,
@@ -71,6 +77,7 @@ class PhotoPicker {
     LoadingDelegate loadingDelegate,
     PickType pickType = PickType.all,
     BadgeDelegate badgeDelegate = const DefaultBadgeDelegate(),
+    List<AssetPathEntity> photoPathList,
   }) {
     assert(provider != null, "provider must be not null");
     assert(context != null, "context must be not null");
@@ -107,6 +114,7 @@ class PhotoPicker {
       context,
       options,
       provider,
+      photoPathList,
     );
   }
 
@@ -114,6 +122,7 @@ class PhotoPicker {
     BuildContext context,
     Options options,
     I18nProvider provider,
+    List<AssetPathEntity> photoList,
   ) async {
     var requestPermission = await PhotoManager.requestPermission();
     if (requestPermission != true) {
@@ -129,15 +138,21 @@ class PhotoPicker {
       return null;
     }
 
-    return _openGalleryContentPage(context, options, provider);
+    return _openGalleryContentPage(context, options, provider, photoList);
   }
 
-  Future<List<AssetEntity>> _openGalleryContentPage(BuildContext context, Options options, I18nProvider provider) async {
+  Future<List<AssetEntity>> _openGalleryContentPage(
+    BuildContext context,
+    Options options,
+    I18nProvider provider,
+    List<AssetPathEntity> photoList,
+  ) async {
     return Navigator.of(context).push(
       MaterialPageRoute(
         builder: (ctx) => PhotoApp(
               options: options,
               provider: provider,
+              photoList: photoList,
             ),
       ),
     );

lib/src/delegate/sort_delegate.dart

@@ -60,6 +60,7 @@ class CommonSortDelegate extends SortDelegate {
   }
 
   bool _isScreenShot(AssetPathEntity entity) {
-    return entity.name.toUpperCase() == "screenshots".toUpperCase() || entity.name.toUpperCase() == "screenshot".toUpperCase();
+    return entity.name.toUpperCase() == "screenshots".toUpperCase() ||
+        entity.name.toUpperCase() == "screenshot".toUpperCase();
   }
 }

lib/src/provider/config_provider.dart

@@ -18,5 +18,6 @@ class ConfigProvider extends InheritedWidget {
     return true;
   }
 
-  static ConfigProvider of(BuildContext context) => context.inheritFromWidgetOfExactType(ConfigProvider);
+  static ConfigProvider of(BuildContext context) =>
+      context.inheritFromWidgetOfExactType(ConfigProvider);
 }

lib/src/provider/i18n_provider.dart

@@ -102,7 +102,7 @@ class ENProvider extends I18nProvider {
 
   @override
   String getAllGalleryText(Options options) {
-    return "all";
+    return "Recent";
   }
 
   @override

lib/src/ui/dialog/change_gallery_dialog.dart

@@ -1,10 +1,19 @@
 import 'package:flutter/material.dart';
+import 'package:photo/src/entity/options.dart';
+import 'package:photo/src/provider/i18n_provider.dart';
 import 'package:photo_manager/photo_manager.dart';
 
 class ChangeGalleryDialog extends StatefulWidget {
   final List<AssetPathEntity> galleryList;
+  final I18nProvider i18n;
+  final Options options;
 
-  const ChangeGalleryDialog({Key key, this.galleryList}) : super(key: key);
+  const ChangeGalleryDialog({
+    Key key,
+    this.galleryList,
+    this.i18n,
+    this.options,
+  }) : super(key: key);
 
   @override
   _ChangeGalleryDialogState createState() => _ChangeGalleryDialogState();
@@ -23,9 +32,17 @@ class _ChangeGalleryDialogState extends State<ChangeGalleryDialog> {
 
   Widget _buildItem(BuildContext context, int index) {
     var entity = widget.galleryList[index];
+    String text;
+
+    if (entity.isAll) {
+      text = widget.i18n?.getAllGalleryText(widget.options);
+    }
+
+    text = text ?? entity.name;
+
     return FlatButton(
       child: ListTile(
-        title: Text(entity.name),
+        title: Text(text),
       ),
       onPressed: () {
         Navigator.pop(context, entity);

lib/src/ui/page/photo_main_page.dart

@@ -17,18 +17,21 @@ import 'package:photo_manager/photo_manager.dart';
 class PhotoMainPage extends StatefulWidget {
   final ValueChanged<List<AssetEntity>> onClose;
   final Options options;
+  final List<AssetPathEntity> photoList;
 
   const PhotoMainPage({
     Key key,
     this.onClose,
     this.options,
+    this.photoList,
   }) : super(key: key);
 
   @override
   _PhotoMainPageState createState() => _PhotoMainPageState();
 }
 
-class _PhotoMainPageState extends State<PhotoMainPage> with SelectedProvider, GalleryListProvider {
+class _PhotoMainPageState extends State<PhotoMainPage>
+    with SelectedProvider, GalleryListProvider {
   Options get options => widget.options;
 
   I18nProvider get i18nProvider => ConfigProvider.of(context).provider;
@@ -52,6 +55,13 @@ class _PhotoMainPageState extends State<PhotoMainPage> with SelectedProvider, Ga
     _currentPath = value;
   }
 
+  String get currentGalleryName {
+    if (currentPath.isAll) {
+      return i18nProvider.getAllGalleryText(options);
+    }
+    return currentPath.name;
+  }
+
   GlobalKey scaffoldKey;
   ScrollController scrollController;
 
@@ -95,7 +105,9 @@ class _PhotoMainPageState extends State<PhotoMainPage> with SelectedProvider, Ga
                 splashColor: Colors.transparent,
                 child: Text(
                   i18nProvider.getSureText(options, selectedCount),
-                  style: selectedCount == 0 ? textStyle.copyWith(color: options.disableColor) : textStyle,
+                  style: selectedCount == 0
+                      ? textStyle.copyWith(color: options.disableColor)
+                      : textStyle,
                 ),
                 onPressed: selectedCount == 0 ? null : sure,
               ),
@@ -106,7 +118,7 @@ class _PhotoMainPageState extends State<PhotoMainPage> with SelectedProvider, Ga
             key: scaffoldKey,
             provider: i18nProvider,
             options: options,
-            galleryName: currentPath.name,
+            galleryName: currentGalleryName,
             onGalleryChange: _onGalleryChange,
             onTapPreview: selectedList.isEmpty ? null : _onTapPreview,
             selectedProvider: this,
@@ -152,7 +164,27 @@ class _PhotoMainPageState extends State<PhotoMainPage> with SelectedProvider, Ga
     );
   }
 
-  Future<void> _refreshList() async {
+  void _refreshList() {
+    if (widget.photoList != null && widget.photoList.isNotEmpty) {
+      _refreshListFromWidget();
+      return;
+    }
+
+    _refreshListFromGallery();
+  }
+
+  Future<void> _refreshListFromWidget() async {
+    galleryPathList.clear();
+    galleryPathList.addAll(widget.photoList);
+    this.list.clear();
+    var assetList = await galleryPathList[0].assetList;
+    this.list.addAll(assetList);
+    setState(() {
+      _isInit = true;
+    });
+  }
+
+  Future<void> _refreshListFromGallery() async {
     List<AssetPathEntity> pathList;
     switch (options.pickType) {
       case PickType.onlyImage:
@@ -483,7 +515,8 @@ class __BottomWidgetState extends State<_BottomWidget> {
                   height: 44.0,
                   alignment: Alignment.center,
                   child: Text(
-                    i18nProvider.getPreviewText(options, widget.selectedProvider),
+                    i18nProvider.getPreviewText(
+                        options, widget.selectedProvider),
                     style: textStyle,
                   ),
                   padding: textPadding,
@@ -501,6 +534,8 @@ class __BottomWidgetState extends State<_BottomWidget> {
       context: context,
       builder: (ctx) => ChangeGalleryDialog(
             galleryList: widget.galleryListProvider.galleryPathList,
+            i18n: i18nProvider,
+            options: options,
           ),
     );
 
@@ -539,7 +574,8 @@ class ImageItem extends StatelessWidget {
       future: entity.thumbDataWithSize(size, size),
       builder: (BuildContext context, AsyncSnapshot<Uint8List> snapshot) {
         var futureData = snapshot.data;
-        if (snapshot.connectionState == ConnectionState.done && futureData != null) {
+        if (snapshot.connectionState == ConnectionState.done &&
+            futureData != null) {
           ImageLruCache.setData(entity, size, futureData);
           return _buildImageItem(context, futureData);
         }
@@ -566,7 +602,8 @@ class ImageItem extends StatelessWidget {
       future: entity.videoDuration,
       builder: (ctx, snapshot) {
         if (snapshot.hasData && snapshot != null) {
-          var buildBadge = badgeDelegate?.buildBadge(context, entity.type, snapshot.data);
+          var buildBadge =
+              badgeDelegate?.buildBadge(context, entity.type, snapshot.data);
           if (buildBadge == null) {
             return Container();
           } else {

lib/src/ui/photo_app.dart

@@ -1,15 +1,22 @@
 import 'package:flutter/material.dart';
+
+import 'package:photo_manager/photo_manager.dart';
+
 import 'package:photo/src/entity/options.dart';
 import 'package:photo/src/provider/config_provider.dart';
 import 'package:photo/src/provider/i18n_provider.dart';
 import 'package:photo/src/ui/page/photo_main_page.dart';
-import 'package:photo_manager/photo_manager.dart';
 
 class PhotoApp extends StatelessWidget {
   final Options options;
   final I18nProvider provider;
-
-  const PhotoApp({Key key, this.options, this.provider}) : super(key: key);
+  final List<AssetPathEntity> photoList;
+  const PhotoApp({
+    Key key,
+    this.options,
+    this.provider,
+    this.photoList,
+  }) : super(key: key);
 
   @override
   Widget build(BuildContext context) {
@@ -21,6 +28,7 @@ class PhotoApp extends StatelessWidget {
           Navigator.pop(context, value);
         },
         options: options,
+        photoList: photoList,
       ),
     );
   }

pubspec.lock

@@ -5,28 +5,28 @@ packages:
     dependency: transitive
     description:
       name: async
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "2.0.8"
   boolean_selector:
     dependency: transitive
     description:
       name: boolean_selector
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.0.4"
   charcode:
     dependency: transitive
     description:
       name: charcode
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.1.2"
   collection:
     dependency: transitive
     description:
       name: collection
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.14.11"
   flutter:
@@ -43,42 +43,42 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "0.12.3+1"
   meta:
     dependency: transitive
     description:
       name: meta
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.1.6"
   path:
     dependency: transitive
     description:
       name: path
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.6.2"
   pedantic:
     dependency: transitive
     description:
       name: pedantic
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.4.0"
   photo_manager:
     dependency: "direct main"
     description:
       name: photo_manager
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "0.2.1"
   quiver:
     dependency: transitive
     description:
       name: quiver
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "2.0.1"
   sky_engine:
@@ -90,56 +90,56 @@ packages:
     dependency: transitive
     description:
       name: source_span
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
-    version: "1.5.3"
+    version: "1.5.4"
   stack_trace:
     dependency: transitive
     description:
       name: stack_trace
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.9.3"
   stream_channel:
     dependency: transitive
     description:
       name: stream_channel
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.6.8"
   string_scanner:
     dependency: transitive
     description:
       name: string_scanner
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.0.4"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.1.0"
   test_api:
     dependency: transitive
     description:
       name: test_api
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "0.2.2"
   typed_data:
     dependency: transitive
     description:
       name: typed_data
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "1.1.6"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
-      url: "https://pub.dartlang.org"
+      url: "https://pub.flutter-io.cn"
     source: hosted
     version: "2.0.8"
 sdks:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: photo
 description: image picker, multi picker support video / icloud asset ,use flutter as ui, if you want to build custom ui,you just use photo_manager.
-version: 0.2.0
+version: 0.2.1
 author: caijinglong<cjl_spy@163.com>
 homepage: https://github.com/CaiJingLong/flutter_photo