Language: English | 中文
基于微信 UI 的 资源选择器， 基于 photo_manager 实现资源相关功能， extended_image 用于查看图片， provider 用于协助管理选择器的状态。
需要拍照及录制视频，请查看示例的详细用法， 并前往 wechat_camera_picker。
当前的界面设计基于的微信版本：8.x 界面更新将在微信版本更新后随时进行跟进。
注意： 如果你觉得你的自定义实现会在某些程度上帮助其他人实现他们的需求， 你可以通过 PR 提交你的自定义实现。更多信息请参考 贡献自定义实现 。
查看 迁移指南。
- ♻️ 支持基于代理重载的全量自定义
- 💚 99% 的微信风格
- ⚡️ 根据参数可调的性能优化
- 📷 图片资源支持
- 🔬 HEIF 格式图片支持
- 🎥 视频资源支持
- 🎶 音频资源支持
⚠️ 由于 iOS/macOS 系统限制，仅支持应用沙盒内获取音频资源
- 1️⃣ 单资源模式
- 💱 国际化支持
- ⏪ RTL 语言支持
- ➕ 特殊 widget 构建支持（前置/后置）
- 🗂 自定义路径排序支持
- 📝 自定义文本构建支持
- ⏳ 自定义筛选规则支持（
photo_manager） - 🎏 完整的自定义主题
- 💻 支持 MacOS
 |
 |
 |
|---|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
 |
该库与 photo_manager 有强关联性， 大部分方法的行为是由 photo_manager 进行控制的。 当你有与相关的 API 和行为的疑问时，你可以查看 photo_manager API 文档 了解更多细节。
众多使用场景都已包含在示例中。 在你提出任何问题之前，请仔细并完整地查看和使用示例。
| 2.8.0 | 2.10.0 | 3.0.0 | 3.3.0 | |
|---|---|---|---|---|
| 8.0.0+ | 不适用 | 不适用 | ✅ | ✅ |
| 7.3.0+ | 不适用 | 不适用 | ✅ | ✅ |
| 7.0.0+ | ✅ | ✅ | ❌ | ❌ |
| 6.3.0+ | ✅ | ✅ | ❌ | ❌ |
如果在 flutter pub get 时遇到了 resolve conflict 失败问题，
请使用 dependency_overrides 解决。
执行 flutter pub add wechat_assets_picker，
或者将 wechat_assets_picker 手动添加至 pubspec.yaml 引用。
dependencies:
wechat_assets_picker: ^latest_version最新的 稳定 版本是:
最新的 开发 版本是:
在你的代码中导入：
import 'package:wechat_assets_picker/wechat_assets_picker.dart';需要声明的权限：READ_EXTERNAL_STORAGE（已声明）.
可选声明的权限：WRITE_EXTERNAL_STORAGE、ACCESS_MEDIA_LOCATION.
如果你的目标 SDK 版本大于 29，
你必须声明在 AndroidManifest.xml 的 <application> 节点中
声明 requestLegacyExternalStorage。
详情请参考示例。
如果你发现有一些与 Glide 有关的警告日志输出，
那么主项目就需要实现 AppGlideModule。
详细信息请查看 Generated API 文档。
- 在
ios/Podfile中指定最低构建版本至 9.0。
platform :ios, '9.0'- 将以下内容添加至
info.plist。
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
<key>NSPhotoLibraryUsageDescription</key>
<string>你的相册权限描述</string>- 在
macos/Podfile中指定最低构建版本至 10.15。
platform :osx, '10.15'- 使用 Xcode 打开
macos/Runner.xcworkspace。 接着根据下面的截图将最低构建版本提升至 10.15。 - 与 iOS 一样，添加相同的内容到
info.plist里。
final List<AssetEntity>? result = await AssetPicker.pickAssets(context);你可以使用 AssetPickerConfig 来调整选择时的行为。
final List<AssetEntity>? result = await AssetPicker.pickAssets(
context,
pickerConfig: const AssetPickerConfig(),
);AssetPickerConfig 的成员说明：
| 参数名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| selectedAssets | List<AssetEntity>? |
已选的资源。确保不重复选择。 | null |
| maxAssets | int |
最多选择的图片数量 | 9 |
| pageSize | int |
分页加载时每页加载的资源数量。**必须为网格数的倍数。 | 80 |
| gridThumbnailSize | ThumbnailSize |
预览网格的缩略图大小 | ThumbnailSize.square(200) |
| pathThumbnailSize | ThumbnailSize |
路径选择器的缩略图大小 | ThumbnailSize.square(80) |
| previewThumbnailSize | ThumbnailSize? |
预览时图片的缩略图大小 | null |
| requestType | RequestType |
选择器选择资源的类型 | RequestType.common |
| specialPickerType | SpecialPickerType? |
提供一些特殊的选择器类型以整合非常规的选择行为 | null |
| keepScrollOffset | bool |
选择器是否可以从同样的位置开始选择 | null |
| sortPathDelegate | SortPathDelegate<AssetPathEntity>? |
资源路径的排序实现，可自定义路径排序方法 | CommonSortPathDelegate |
| sortPathsByModifiedDate | bool |
是否结合 FilterOptionGroup.containsPathModified 进行路径排序 |
false |
| filterOptions | FilterOptionGroup? |
允许用户自定义资源过滤条件 | null |
| gridCount | int |
选择器网格数量 | 4 |
| themeColor | Color? |
选择器的主题色 | Color(0xff00bc56) |
| pickerTheme | ThemeData? |
选择器的主题提供，包括查看器 | null |
| textDelegate | AssetPickerTextDelegate? |
选择器的文本代理构建，用于自定义文本 | AssetPickerTextDelegate() |
| specialItemPosition | SpecialItemPosition |
允许用户在选择器中添加一个自定义item，并指定位置。 | SpecialPosition.none |
| specialItemBuilder | SpecialItemBuilder? |
自定义item的构造方法 | null |
| loadingIndicatorBuilder | IndicatorBuilder? |
加载器的实现 | null |
| selectPredicate | AssetSelectPredicate |
判断资源可否被选择 | null |
| shouldRevertGrid | bool? |
判断资源网格是否需要倒序排列 | null |
| limitedPermissionOverlayPredicate | LimitedPermissionOverlayPredicate? |
判断有限的权限情况下是否展示提示页面 | null |
| pathNameBuilder | PathNameBuilder<AssetPathEntity>? |
构建自定义路径名称 | null |
我们已将常用的调用方法封装在 example 中。
你只能在使用 pickAssetsWithDelegate 方法时
使用 keepScrollOffset 的功能。
更多细节请查看示例内的 Keep scroll offset 方法。
想要了解更多关于自定义代理实现的内容，
查阅 example/lib/customs。
你可以在 example/lib/pages/multi_assets_page.dart 和
example/lib/pages/single_assets_page.dart
找到 List<PickMethod> pickMethods，
它分别定义了多选和单选可用的选择模式。
在选择资源后，资源会暂存并展示在页面下方。
页面中的最大选择数是 9，你可以按需修改。
某些模式只能在多选下使用，例如「朋友圈」(WeChat Moment) 模式。
一次只能且最多能选择一个资源。
你可以在「Custom」页面尝试自定义的选择器。
目前我们提供了一个基于 Directory 和 File
（与 photo_manager 完全无关）实现的选择器，
以及一个多 Tab 页切换的选择器。
如果你觉得你的实现有价值或能帮助到其他人，欢迎以 PR 的形式进行提交。
更多细节请阅读 贡献自定义实现。
AssetEntityImage 和 AssetEntityImageProvider
可以为 图片 & 视频 展示缩略图，以及展示 图片的原图。
它的使用方法与常见的 Image 和 ImageProvider 一致。
/// AssetEntityImage
AssetEntityImage(asset, isOriginal: false);
/// AssetEntityImageProvider
Image(image: AssetEntityImageProvider(asset, isOriginal: false));/// 注册回调
AssetPicker.registerObserve();
/// 取消注册回调
AssetPicker.unregisterObserve();AssetPickerBuilderDelegate、AssetPickerViewerBuilderDelegate、
AssetPickerProvider 及 AssetPickerViewerProvider 均已暴露且可重载。
使用者可以使用自定义的泛型类型 <A: 资源, P: 路径>，
配合继承与重载，实现对应抽象类和类中的方法。
更多用法请查看示例中的 Custom 页面，
该页面包含一个以 <File, Directory> 为类型基础的选择器。
查看 photo_manager#561 了解详细的解决方法。
你不需要获得路径（也许）。
File 对象可以通过 entity.file 或 entity.originFile 获得，
如果需要 Uint8List 则使用 entity.originBytes。
如果再此之后你仍然需要路径，
那么可以通过已获得的 File 对象获取：
final File file = await entity.file; // 缩略图或编辑后的视频
final File originFile = await entity.originFile; // 原图或者原视频
final String path = file.path;
final String originPath = originFile.path;如果需要使用此库结合一些拍照需求，
可通过以下方法将 File 或 Uint8List 转为 AssetEntity。
final File file = your_file; // 你的 File 对象
final String path = file.path;
final AssetEntity fileEntity = await PhotoManager.editor.saveImageWithPath(
path,
title: basename(path),
); // 存入手机并生成 AssetEntity
final Uint8List data = your_data; // 你的 Uint8List 对象
final AssetEntity imageEntity = await PhotoManager.editor.saveImage(
file.path,
title: '带有后缀的名称.jpg',
); // 存入手机并生成 AssetEntity注意：如果不想保留文件，请尽量用 File 承载中间操作，
否则在调用 AssetEntity 的删除时，某些系统下会触发系统弹窗事件：
final List<String> result = await PhotoManager.editor.deleteWithIds(
<String>[entity.id],
);参考文档：photo_manager#insert-new-item
W/Glide (21133): Failed to find GeneratedAppGlideModule. You should include an annotationProcessor complie dependency on com.github.bumptech.glide:compiler in you application ana a @GlideModule annotated AppGlideModule implementation or LibraryGlideModules will be silently ignored.
Glide 通过注解来保证单例，防止单例或版本之间的冲突，
而因为 photo_manager 使用了 Glide 提供部分图片功能，
所以使用它的项目必须实现自己的 AppGlideModule。
请移步 Android 部分了解如何实现。
IntelliJ IDEA 的每个方面都旨在最大化开发者生产力。结合智能编码辅助与符合人体工程学的设计，让开发不仅高效，更成为一种享受。
感谢 JetBrains 为开源项目提供免费的 IntelliJ IDEA 等 IDE 的授权。
