浏览代码

docs(imagePreview): type optimization (#1691)

Drjingfubo 3 年之前
父节点
当前提交
9acbe9e6d3
共有 2 个文件被更改,包括 31 次插入4 次删除
  1. 13 2
      src/packages/__VUE/imagepreview/doc.en-US.md
  2. 18 2
      src/packages/__VUE/imagepreview/doc.md

+ 13 - 2
src/packages/__VUE/imagepreview/doc.en-US.md

@@ -302,8 +302,8 @@ app.use(ImagePreview);
 | Attribute | Description | Type | Default
 |----- | ----- | ----- | ----- 
 | show | Whether to show preview | Boolean | false
-| videos | Videos Array(Videos are before images, not support in taro) | Array<`Object`> | []
-| images | Images array | Array<`String`> | []
+| videos | Videos Array(Videos are before images, not support in taro) |  VideoArray[] | []
+| images | Images array | ImageArray[] | []
 | autoplay | Autoplay time, zero means not autoplay | Number、String  | 3000  |
 | init-no | Init no | Number | 1
 | pagination-visible | Whether to show pagination    | Boolean | false |
@@ -317,7 +317,18 @@ app.use(ImagePreview);
 | max-zoom`v3.1.23`  | Max zoom`Taro isn't supported`   | Number  | 3  | 
 | min-zoom`v3.1.23`  | Min zoom`Taro isn't supported`   | Number  | 1/3  | 
 
+### Data Structure of ImageArray 
 
+| Key | Description | Type | 
+|----- | ----- | ----- | 
+| src | img url | String | 
+
+### Data Structure of VideoArray
+
+| Key | Description | Type | 
+|----- | ----- | ----- | 
+| source | Video url and type settings | Object | 
+| options | Control video playback properties| Object | 
     
 ### Events
 

+ 18 - 2
src/packages/__VUE/imagepreview/doc.md

@@ -302,8 +302,8 @@ app.use(ImagePreview);
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
 | show | 是否展示预览图片 | Boolean | false
-| videos | 预览的视频数组(视频自动放到图片之前、taro场景暂不支持) | Array<`Object`> | []
-| images | 预览图片数组 | { src: String }[] | []
+| videos | 预览的视频数组(视频自动放到图片之前、taro场景暂不支持) | VideoArray[] | []
+| images | 预览图片数组 | ImageArray[] | []
 | autoplay | 自动轮播时长,0表示不会自动轮播 | Number、String  | 3000  |
 | init-no | 初始页码 | Number | 1
 | pagination-visible | 分页指示器是否展示    | Boolean | false |
@@ -317,6 +317,22 @@ app.use(ImagePreview);
 | max-zoom`v3.1.23`  | 手势缩放时,最大缩放比例`小程序暂不支持`   | Number  | 3  | 
 | min-zoom`v3.1.23`  | 手势缩放时,最小缩放比例`小程序暂不支持`   | Number  | 1/3  | 
 
+
+### ImageArray 数据结构
+
+| 键名 | 说明 | 类型 | 
+|----- | ----- | ----- | 
+| src | 预览图片链接 | String | 
+
+### VideoArray 数据结构
+
+| 键名 | 说明 | 类型 | 
+|----- | ----- | ----- | 
+| source | 视频地址和类型设置,等同于 Video 组件的 [source 属性](#/zh-CN/video) | Object | 
+| options | 控制视频播放属性,等同于 Video 组件的 [options 属性](#/zh-CN/video) | Object | 
+
+
+
 ### Events
 
 |字段|说明|回调参数|