Skip to content

Commit c60a7a1

Browse files
committed
📝 Update README with type annotation
1 parent 25a7d41 commit c60a7a1

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

README-ZH.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ platform :ios, '9.0'
132132
| themeColor | `Color` | 选择器的主题色 | `Color(0xff00bc56)` |
133133
| pickerTheme | `ThemeData` | 选择器的主题提供,包括查看器 | `null` |
134134
| sortPathDelegate | `SortPathDeleage` | 资源路径的排序实现,可自定义路径排序方法 | `CommonSortPathDelegate` |
135-
| textDelegate | `TextDelegate` | 选择器的文本代理构建,用于自定义文本 | `DefaultTextDelegate()` |
135+
| textDelegate | `DefaultAssetsPickerTextDelegate` | 选择器的文本代理构建,用于自定义文本 | `DefaultAssetsPickerTextDelegate()` |
136136
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
137137
| customItemBuilder | `WidgetBuilder` | 自定义item的构造方法 | `null` |
138138
| customItemPosition | `CustomItemPosition` | 允许用户在选择器中添加一个自定义item,并指定位置。 | `CustomItemPosition.none` |

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -137,25 +137,25 @@ Add following content to `info.plist`.
137137

138138
## Usage 📖
139139

140-
| Name | Type | Description | Default |
141-
| ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
142-
| maxAssets | `int` | Maximum asset that the picker can pick. | 9 |
143-
| pageSize | `int` | Assets amount when assets loaded with paging. **Must be a multiple of `gridCount`.** Nullable for non paging. | 320 (80 * 4) |
144-
| pathThumbSize | `int` | The size of thumb data in picker. | 80 |
145-
| gridCount | `int` | Grid count in picker. | 4 |
146-
| previewThumbSize | `List<int>` | Thumb size for the preview of images in the viewer. | `null` |
147-
| requestType | `RequestType` | Request type for picker. | `RequestType.image` |
148-
| specialPickerType | `SpacialPickerType` | Provide some special picker types to integrate un-common pick pattern. | `null` |
149-
| selectedAssets | `List<AssetEntity>` | Selected assets. Prevent duplicate selection. If you don't need to prevent duplicate selection, just don't pass it. | `null` |
150-
| themeColor | `Color` | Main theme color for the picker | `Color(0xff00bc56)` |
151-
| pickerTheme | `ThemeData` | Theme data provider for the picker and the viewer. | `null` |
152-
| sortPathDelegate | `SortPathDeleage` | Path entities sort delegate for the picker, sort paths as you want. | `CommonSortPathDelegate` |
153-
| textDelegate | `TextDelegate` | Text delegate for the picker, for customize the texts. | `DefaultTextDelegate()` |
154-
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
155-
| customItemBuilder | `WidgetBuilder` | The widget builder for the custom item. | `null` |
156-
| customItemPosition | `CustomItemPosition` | Allow users set custom item in the picker with several positions. | `CustomItemPosition.none` |
157-
| routeCurve | `Curve` | The curve which the picker use to build page route transition. | `Curves.easeIn` |
158-
| routeDuration | `Duration` | The duration which the picker use to build page route transition. | `const Duration(milliseconds: 500)` |
140+
| Name | Type | Description | Default |
141+
| ------------------ | -------------------------- | ------------------------------------------------------------ | ----------------------------------- |
142+
| maxAssets | `int` | Maximum asset that the picker can pick. | 9 |
143+
| pageSize | `int` | Assets amount when assets loaded with paging. **Must be a multiple of `gridCount`.** Nullable for non paging. | 320 (80 * 4) |
144+
| pathThumbSize | `int` | The size of thumb data in picker. | 80 |
145+
| gridCount | `int` | Grid count in picker. | 4 |
146+
| previewThumbSize | `List<int>` | Thumb size for the preview of images in the viewer. | `null` |
147+
| requestType | `RequestType` | Request type for picker. | `RequestType.image` |
148+
| specialPickerType | `SpacialPickerType` | Provide some special picker types to integrate un-common pick pattern. | `null` |
149+
| selectedAssets | `List<AssetEntity>` | Selected assets. Prevent duplicate selection. If you don't need to prevent duplicate selection, just don't pass it. | `null` |
150+
| themeColor | `Color` | Main theme color for the picker | `Color(0xff00bc56)` |
151+
| pickerTheme | `ThemeData` | Theme data provider for the picker and the viewer. | `null` |
152+
| sortPathDelegate | `SortPathDeleage` | Path entities sort delegate for the picker, sort paths as you want. | `CommonSortPathDelegate` |
153+
| textDelegate | `AssetsPickerTextDelegate` | Text delegate for the picker, for customize the texts. | `DefaultAssetsPickerTextDelegate()` |
154+
| filterOptions | `FilterOptionGroup` | Allow users to customize assets filter options. | `null` |
155+
| customItemBuilder | `WidgetBuilder` | The widget builder for the custom item. | `null` |
156+
| customItemPosition | `CustomItemPosition` | Allow users set custom item in the picker with several positions. | `CustomItemPosition.none` |
157+
| routeCurve | `Curve` | The curve which the picker use to build page route transition. | `Curves.easeIn` |
158+
| routeDuration | `Duration` | The duration which the picker use to build page route transition. | `const Duration(milliseconds: 500)` |
159159

160160
### Simple usage
161161

0 commit comments

Comments
 (0)