alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: type highlight (#4264)

Browse Source
This commit is contained in:
neverland
2019-08-27 22:09:21 +08:00
committed by GitHub
parent a79750d00c
commit ecbdc2bede
129 changed files with 1493 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/image-preview/README.md
+28 -28
View File
@@ -90,37 +90,37 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| images | Images URL list | `string[]` | `[]` | - |
| startPosition | Start position | `number` | `0` | - |
| showIndex | Whether to show index | `boolean` | `true` | - |
| showIndicators | Whether to show indicators | `boolean` | `false` | - |
| loop | Whether to enable loop | `boolean` | `true` | - |
| swipeDuration | Animation duration (ms) | `number` | `500` | - |
| onClose | Triggered when close | `Function` | - | - |
| onChange | Triggered when current image change | `Function` | - | 2.0.3 |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` | - |
| asyncClose | Whether to enable async close | `boolean` | `false` | - |
| className | Custom className | `any` | - | - |
| lazyLoad | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
| maxZoom | Max zoom | `number` | `3` | - |
| minZoom | Min zoom | `number` | `1/3` | - |
| images | Images URL list | *string[]* | `[]` | - |
| startPosition | Start position | *number* | `0` | - |
| showIndex | Whether to show index | *boolean* | `true` | - |
| showIndicators | Whether to show indicators | *boolean* | `false` | - |
| loop | Whether to enable loop | *boolean* | `true` | - |
| swipeDuration | Animation duration (ms) | *number* | `500` | - |
| onClose | Triggered when close | *Function* | - | - |
| onChange | Triggered when current image change | *Function* | - | 2.0.3 |
| closeOnPopstate | Whether to close when popstate | *boolean* | `false` | - |
| asyncClose | Whether to enable async close | *boolean* | `false` | - |
| className | Custom className | *any* | - | - |
| lazyLoad | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | - |
| maxZoom | Max zoom | *number* | `3` | - |
| minZoom | Min zoom | *number* | `1/3` | - |
### Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| images | Images URL list | `string[]` | `[]` | - |
| start-position | Start position | `number` | `0` | - |
| show-index | Whether to show index | `boolean` | `true` | - |
| show-indicators | Whether to show indicators | `boolean` | `false` | - |
| loop | Whether to enable loop | `boolean` | `true` | - |
| swipe-duration | Animation duration (ms) | `number` | `500` | - |
| async-close | Whether to enable async close | `boolean` | `false` | - |
| close-on-popstate | Whether to close when popstate | `boolean` | `false` | - |
| class-name | Custom className | `any` | - | - |
| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
| max-zoom | Max zoom | `number` | `3` | - |
| min-zoom | Min zoom | `number` | `1/3` | - |
| images | Images URL list | *string[]* | `[]` | - |
| start-position | Start position | *number* | `0` | - |
| show-index | Whether to show index | *boolean* | `true` | - |
| show-indicators | Whether to show indicators | *boolean* | `false` | - |
| loop | Whether to enable loop | *boolean* | `true` | - |
| swipe-duration | Animation duration (ms) | *number* | `500` | - |
| async-close | Whether to enable async close | *boolean* | `false` | - |
| close-on-popstate | Whether to close when popstate | *boolean* | `false` | - |
| class-name | Custom className | *any* | - | - |
| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | - |
| max-zoom | Max zoom | *number* | `3` | - |
| min-zoom | Min zoom | *number* | `1/3` | - |
### Events
@@ -139,5 +139,5 @@ export default {
| Attribute | Description | Type |
|------|------|------|
| url | Url of current image | `number` |
| index | Index of current image | `string` |
| url | Url of current image | *number* |
| index | Index of current image | *string* |
src/image-preview/README.zh-CN.md
+28 -28
View File
@@ -102,20 +102,20 @@ export default {
| 参数名 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| images | 需要预览的图片 URL 数组 | `string[]` | `[]` | - |
| startPosition | 图片预览起始位置索引 | `number` | `0` | - |
| showIndex | 是否显示页码 | `boolean` | `true` | - |
| showIndicators | 是否显示轮播指示器 | `boolean` | `false` | - |
| loop | 是否开启循环播放 | `boolean` | `true` | - |
| swipeDuration | 动画时长，单位为 ms | `number` | `500` | - |
| onClose | 关闭时的回调函数 | `Function` | - | - |
| onChange | 切换图片时的回调函数，回调参数为当前索引 | `Function` | - | 2.0.3 |
| asyncClose | 是否开启异步关闭 | `boolean` | `false` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | `boolean` | `false` | - |
| className | 自定义类名 | `any` | - | - |
| lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | - |
| maxZoom | 手势缩放时，最大缩放比例 | `number` | `3` | - |
| minZoom | 手势缩放时，最小缩放比例 | `number` | `1/3` | - |
| images | 需要预览的图片 URL 数组 | *string[]* | `[]` | - |
| startPosition | 图片预览起始位置索引 | *number* | `0` | - |
| showIndex | 是否显示页码 | *boolean* | `true` | - |
| showIndicators | 是否显示轮播指示器 | *boolean* | `false` | - |
| loop | 是否开启循环播放 | *boolean* | `true` | - |
| swipeDuration | 动画时长，单位为 ms | *number* | `500` | - |
| onClose | 关闭时的回调函数 | *Function* | - | - |
| onChange | 切换图片时的回调函数，回调参数为当前索引 | *Function* | - | 2.0.3 |
| asyncClose | 是否开启异步关闭 | *boolean* | `false` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | *boolean* | `false` | - |
| className | 自定义类名 | *any* | - | - |
| lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | - |
| maxZoom | 手势缩放时，最大缩放比例 | *number* | `3` | - |
| minZoom | 手势缩放时，最小缩放比例 | *number* | `1/3` | - |
### Props
@@ -123,18 +123,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| images | 需要预览的图片 URL 数组 | `string[]` | `[]` | - |
| start-position | 图片预览起始位置索引 | `number` | `0` | - |
| show-index | 是否显示页码 | `boolean` | `true` | - |
| show-indicators | 是否显示轮播指示器 | `boolean` | `false` | - |
| loop | 是否开启循环播放 | `boolean` | `true` | - |
| swipe-duration | 动画时长，单位为 ms | `number` | `500` | - |
| async-close | 是否开启异步关闭 | `boolean` | `false` | - |
| close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` | - |
| class-name | 自定义类名 | `any` | - | - |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | - |
| max-zoom | 手势缩放时，最大缩放比例 | `number` | `3` | - |
| min-zoom | 手势缩放时，最小缩放比例 | `number` | `1/3` | - |
| images | 需要预览的图片 URL 数组 | *string[]* | `[]` | - |
| start-position | 图片预览起始位置索引 | *number* | `0` | - |
| show-index | 是否显示页码 | *boolean* | `true` | - |
| show-indicators | 是否显示轮播指示器 | *boolean* | `false` | - |
| loop | 是否开启循环播放 | *boolean* | `true` | - |
| swipe-duration | 动画时长，单位为 ms | *number* | `500` | - |
| async-close | 是否开启异步关闭 | *boolean* | `false` | - |
| close-on-popstate | 是否在页面回退时自动关闭 | *boolean* | `false` | - |
| class-name | 自定义类名 | *any* | - | - |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | - |
| max-zoom | 手势缩放时，最大缩放比例 | *number* | `3` | - |
| min-zoom | 手势缩放时，最小缩放比例 | *number* | `1/3` | - |
### Events
@@ -157,5 +157,5 @@ export default {
| 参数名 | 说明 | 类型 |
|------|------|------|
| url | 当前图片 URL | `string` |
| index | 当前图片的索引值 | `number` |
| url | 当前图片 URL | *string* |
| index | 当前图片的索引值 | *number* |