Skip to content

Commit 7c6a903

Browse files
AlexV525AlexV525
committed
📝 Update doc with breaking changes.
1 parent eba5c0e commit 7c6a903

File tree

2 files changed

+40
-40
lines changed

2 files changed

+40
-40
lines changed

‎README-ZH.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Language: [English](README.md) | 中文简体
5252
- [x] 🎶 音频资源支持
5353
- [x] 1️⃣ 单资源模式
5454
- [x] 💱 国际化支持
55-
- [x] ➕ 自定义 widget 构建支持（前置/后置）
55+
- [x] ➕ 特殊 widget 构建支持（前置/后置）
5656
- [x] 🗂 自定义路径排序支持
5757
- [x] 📝 自定义文本构建支持
5858
- [x] ⏳ 自定义筛选规则支持（ `photo_manager` ）
@@ -140,25 +140,25 @@ platform :ios, '9.0'
140140

141141
## 使用方法 📖
142142

143-
| 参数名 | 类型 | 描述 | 默认值 |
144-
| ------------------ | -------------------- | ------------------------------------------------ | ------------------- |
145-
| maxAssets | `int` | 最多选择的图片数量 | 9 |
146-
| pageSize | `int` | 分页加载时每页加载的资源数量。**必须为网格数的倍数。** 设置为`null`可以取消分页。 | 320 (80 * 4) |
147-
| pathThumbSize | `int` | 选择器的缩略图大小 | 80 |
148-
| gridCount | `int` | 选择器网格数量 | 4 |
149-
| previewThumbSize | `List<int>` | 预览时图片的缩略图大小 | `null` |
150-
| requestType | `RequestType` | 选择器选择资源的类型 | `RequestType.image` |
151-
| specialPickerType | `SpecialPickerType` | 提供一些特殊的选择器类型以整合非常规的选择行为 | `null` |
152-
| selectedAssets | `List<AssetEntity>` | 已选的资源。确保不重复选择。如果你允许重复选择，请将其置空。 | `null` |
153-
| themeColor | `Color` | 选择器的主题色 | `Color(0xff00bc56)` |
154-
| pickerTheme | `ThemeData` | 选择器的主题提供，包括查看器 | `null` |
155-
| sortPathDelegate | `SortPathDeleage` | 资源路径的排序实现，可自定义路径排序方法 | `CommonSortPathDelegate` |
156-
| textDelegate | `DefaultAssetsPickerTextDelegate` | 选择器的文本代理构建，用于自定义文本 | `DefaultAssetsPickerTextDelegate()` |
157-
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
158-
| customItemBuilder | `WidgetBuilder` | 自定义item的构造方法 | `null` |
159-
| customItemPosition | `CustomItemPosition` | 允许用户在选择器中添加一个自定义item，并指定位置。 | `CustomItemPosition.none` |
160-
| routeCurve | `Curve` | 选择构造路由动画的曲线 | `Curves.easeIn` |
161-
| routeDuration | `Duration` | 选择构造路由动画的时间 | `const Duration(milliseconds: 500)` |
143+
| 参数名 | 类型 | 描述 | 默认值 |
144+
| ------------------- | --------------------- | ------------------------------------------------ | ------------------- |
145+
| maxAssets | `int` | 最多选择的图片数量 | 9 |
146+
| pageSize | `int` | 分页加载时每页加载的资源数量。**必须为网格数的倍数。** 设置为`null`可以取消分页。 | 320 (80 * 4) |
147+
| pathThumbSize | `int` | 选择器的缩略图大小 | 80 |
148+
| gridCount | `int` | 选择器网格数量 | 4 |
149+
| previewThumbSize | `List<int>` | 预览时图片的缩略图大小 | `null` |
150+
| requestType | `RequestType` | 选择器选择资源的类型 | `RequestType.image` |
151+
| specialPickerType | `SpecialPickerType` | 提供一些特殊的选择器类型以整合非常规的选择行为 | `null` |
152+
| selectedAssets | `List<AssetEntity>` | 已选的资源。确保不重复选择。如果你允许重复选择，请将其置空。 | `null` |
153+
| themeColor | `Color` | 选择器的主题色 | `Color(0xff00bc56)` |
154+
| pickerTheme | `ThemeData` | 选择器的主题提供，包括查看器 | `null` |
155+
| sortPathDelegate | `SortPathDeleage` | 资源路径的排序实现，可自定义路径排序方法 | `CommonSortPathDelegate` |
156+
| textDelegate | `DefaultAssetsPickerTextDelegate` | 选择器的文本代理构建，用于自定义文本 | `DefaultAssetsPickerTextDelegate()` |
157+
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
158+
| specialItemBuilder | `WidgetBuilder` | 自定义item的构造方法 | `null` |
159+
| specialItemPosition | `SpecialItemPosition` | 允许用户在选择器中添加一个自定义item，并指定位置。 | `SpecialPosition.none` |
160+
| routeCurve | `Curve` | 选择构造路由动画的曲线 | `Curves.easeIn` |
161+
| routeDuration | `Duration` | 选择构造路由动画的时间 | `const Duration(milliseconds: 500)` |
162162

163163
### 简单的使用方法
164164

‎README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ See [Migration Guide](doc/migration_guide.md).
7373
- [x] 🎶 Audio asset support
7474
- [x] 1️⃣ Single asset mode
7575
- [x] 💱 i18n support
76-
- [x] ➕ Custom item builder (prepend/append) support
76+
- [x] ➕ Special item builder (prepend/append) support
7777
- [x] 🗂 Custom sort path delegate support
7878
- [x] 📝 Custom text delegate support
7979
- [x] ⏳ Custom filter options support ( `photo_manager` )
@@ -161,25 +161,25 @@ platform :osx, '10.15'
161161

162162
## Usage 📖
163163

164-
| Name | Type | Description | Default |
165-
| ------------------ | -------------------------- | ------------------------------------------------------------ | ----------------------------------- |
166-
| maxAssets | `int` | Maximum asset that the picker can pick. | 9 |
167-
| pageSize | `int` | Assets amount when assets loaded with paging. **Must be a multiple of `gridCount`.** Nullable for non paging. | 320 (80 * 4) |
168-
| pathThumbSize | `int` | The size of thumb data in picker. | 80 |
169-
| gridCount | `int` | Grid count in picker. | 4 |
170-
| previewThumbSize | `List<int>` | Thumb size for the preview of images in the viewer. | `null` |
171-
| requestType | `RequestType` | Request type for picker. | `RequestType.image` |
172-
| specialPickerType | `SpacialPickerType` | Provide some special picker types to integrate un-common pick pattern. | `null` |
173-
| selectedAssets | `List<AssetEntity>` | Selected assets. Prevent duplicate selection. If you don't need to prevent duplicate selection, just don't pass it. | `null` |
174-
| themeColor | `Color` | Main theme color for the picker | `Color(0xff00bc56)` |
175-
| pickerTheme | `ThemeData` | Theme data provider for the picker and the viewer. | `null` |
176-
| sortPathDelegate | `SortPathDeleage` | Path entities sort delegate for the picker, sort paths as you want. | `CommonSortPathDelegate` |
177-
| textDelegate | `AssetsPickerTextDelegate` | Text delegate for the picker, for customize the texts. | `DefaultAssetsPickerTextDelegate()` |
178-
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
179-
| customItemBuilder | `WidgetBuilder` | The widget builder for the custom item. | `null` |
180-
| customItemPosition | `CustomItemPosition` | Allow users set custom item in the picker with several positions. | `CustomItemPosition.none` |
181-
| routeCurve | `Curve` | The curve which the picker use to build page route transition. | `Curves.easeIn` |
182-
| routeDuration | `Duration` | The duration which the picker use to build page route transition. | `const Duration(milliseconds: 500)` |
164+
| Name | Type | Description | Default |
165+
| ------------------- | -------------------------- | ------------------------------------------------------------ | ----------------------------------- |
166+
| maxAssets | `int` | Maximum asset that the picker can pick. | 9 |
167+
| pageSize | `int` | Assets amount when assets loaded with paging. **Must be a multiple of `gridCount`.** Nullable for non paging. | 320 (80 * 4) |
168+
| pathThumbSize | `int` | The size of thumb data in picker. | 80 |
169+
| gridCount | `int` | Grid count in picker. | 4 |
170+
| previewThumbSize | `List<int>` | Thumb size for the preview of images in the viewer. | `null` |
171+
| requestType | `RequestType` | Request type for picker. | `RequestType.image` |
172+
| specialPickerType | `SpacialPickerType` | Provide some special picker types to integrate un-common pick pattern. | `null` |
173+
| selectedAssets | `List<AssetEntity>` | Selected assets. Prevent duplicate selection. If you don't need to prevent duplicate selection, just don't pass it. | `null` |
174+
| themeColor | `Color` | Main theme color for the picker | `Color(0xff00bc56)` |
175+
| pickerTheme | `ThemeData` | Theme data provider for the picker and the viewer. | `null` |
176+
| sortPathDelegate | `SortPathDeleage` | Path entities sort delegate for the picker, sort paths as you want. | `CommonSortPathDelegate` |
177+
| textDelegate | `AssetsPickerTextDelegate` | Text delegate for the picker, for customize the texts. | `DefaultAssetsPickerTextDelegate()` |
178+
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
179+
| specialItemBuilder | `WidgetBuilder` | The widget builder for the special item. | `null` |
180+
| specialItemPosition | `SpecialItemPosition` | Allow users set a special item in the picker with several positions. | `SpecialItemPosition.none` |
181+
| routeCurve | `Curve` | The curve which the picker use to build page route transition. | `Curves.easeIn` |
182+
| routeDuration | `Duration` | The duration which the picker use to build page route transition. | `const Duration(milliseconds: 500)` |
183183

184184
### Simple usage
185185

0 commit comments

Comments
 (0)