Skip to content

Commit 9e76b04

Browse files
anlyyaoanlyyao
authored
docs(ImageViewer): add trigger source for close event (#729)
1 parent c8e693a commit 9e76b04

File tree

9 files changed

+22
-18
lines changed

9 files changed

+22
-18
lines changed

‎db/TDesign.db‎

0 Bytes
Binary file not shown.

‎packages/products/tdesign-mobile-react/src/image-viewer/image-viewer.en-US.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ deleteBtn | TNode | false | Typescript：`boolean \| TNode`。[see more ts defin
1313
images | Array | [] | Typescript：`Array<string \| ImageInfo>` `interface ImageInfo { url: string; align: 'start' \| 'center' \| 'end' }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/image-viewer/type.ts) | N
1414
index | Number | 0 | \- | N
1515
defaultIndex | Number | 0 | uncontrolled property | N
16-
maxZoom | Number | 3 | Typescript：`Number` | N
16+
maxZoom | Number | 3 | \- | N
1717
showIndex | Boolean | false | \- | N
1818
visible | Boolean | false | hide or show image viewer | N
1919
defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N
20-
onClose | Function | | Typescript：`(context: { trigger: 'overlay' \| 'close-btn', visible: boolean, index: number }) => void`<br/> | N
20+
onClose | Function | | Typescript：`(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number }) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/image-viewer/type.ts)。<br/>`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`<br/> | N
2121
onDelete | Function | | Typescript：`(index: number) => void`<br/> | N
2222
onIndexChange | Function | | Typescript：`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/> | N

‎packages/products/tdesign-mobile-react/src/image-viewer/image-viewer.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ deleteBtn | TNode | false | 是否显示删除操作，前提需要开启页码
1313
images | Array | [] | 图片数组。TS 类型：`Array<string \| ImageInfo>` `interface ImageInfo { url: string; align: 'start' \| 'center' \| 'end' }`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/image-viewer/type.ts) | N
1414
index | Number | 0 | 当前预览图片所在的下标 | N
1515
defaultIndex | Number | 0 | 当前预览图片所在的下标。非受控属性 | N
16-
maxZoom | Number | 3 | 【开发中】最大放大比例。TS 类型：`Number` | N
16+
maxZoom | Number | 3 | 【开发中】最大放大比例 | N
1717
showIndex | Boolean | false | 是否显示页码 | N
1818
visible | Boolean | false | 隐藏/显示预览 | N
1919
defaultVisible | Boolean | false | 隐藏/显示预览。非受控属性 | N
20-
onClose | Function | | TS 类型：`(context: { trigger: 'overlay' \| 'close-btn', visible: boolean, index: number }) => void`<br/>关闭时触发 | N
20+
onClose | Function | | TS 类型：`(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number }) => void`<br/>关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/image-viewer/type.ts)。<br/>`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`<br/> | N
2121
onDelete | Function | | TS 类型：`(index: number) => void`<br/>点击删除操作按钮时触发 | N
2222
onIndexChange | Function | | TS 类型：`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/>预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片 | N

‎packages/products/tdesign-mobile-react/src/image-viewer/type.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface TdImageViewerProps {
3636
* 【开发中】最大放大比例
3737
* @default 3
3838
*/
39-
maxZoom?: Number;
39+
maxZoom?: number;
4040
/**
4141
* 是否显示页码
4242
* @default false
@@ -55,7 +55,7 @@ export interface TdImageViewerProps {
5555
/**
5656
* 关闭时触发
5757
*/
58-
onClose?: (context: { trigger: 'overlay' | 'close-btn'; visible: boolean; index: number }) => void;
58+
onClose?: (context: { trigger: ImageViewerCloseTrigger; visible: boolean; index: number }) => void;
5959
/**
6060
* 点击删除操作按钮时触发
6161
*/
@@ -70,3 +70,5 @@ export interface ImageInfo {
7070
url: string;
7171
align: 'start' | 'center' | 'end';
7272
}
73+
74+
export type ImageViewerCloseTrigger = 'image' | 'overlay' | 'close-btn';

‎packages/products/tdesign-mobile-vue/src/image-viewer/image-viewer.en-US.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ deleteBtn | Boolean / Slot / Function | false | Typescript：`boolean \| TNode`
1111
images | Array | [] | Typescript：`Array<string \| ImageInfo>` `interface ImageInfo { url: string; align: 'start' \| 'center' \| 'end' }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts) | N
1212
index | Number | - | `v-model:index` is supported | N
1313
defaultIndex | Number | - | uncontrolled property | N
14-
maxZoom | Number | 3 | Typescript：`Number` | N
14+
maxZoom | Number | 3 | \- | N
1515
showIndex | Boolean | false | \- | N
1616
visible | Boolean | false | hide or show image viewer。`v-model` and `v-model:visible` is supported | N
1717
defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N
18-
onClose | Function | | Typescript：`(context: { trigger: 'overlay' \| 'close-btn', visible: boolean, index: number }) => void`<br/> | N
18+
onClose | Function | | Typescript：`(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number }) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。<br/>`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`<br/> | N
1919
onDelete | Function | | Typescript：`(index: number) => void`<br/> | N
2020
onIndexChange | Function | | Typescript：`(index: number, context: { trigger: 'prev' \| 'next' }) => void`<br/> | N
2121

2222
### ImageViewer Events
2323

2424
name | params | description
2525
-- | -- | --
26-
close | `(context: { trigger: 'overlay' \| 'close-btn', visible: boolean, index: number })` | \-
26+
close | `(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number })` | [see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。<br/>`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`<br/>
2727
delete | `(index: number)` | \-
2828
index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | \-

‎packages/products/tdesign-mobile-vue/src/image-viewer/image-viewer.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ deleteBtn | Boolean / Slot / Function | false | 是否显示删除操作，前
1111
images | Array | [] | 图片数组。TS 类型：`Array<string \| ImageInfo>` `interface ImageInfo { url: string; align: 'start' \| 'center' \| 'end' }`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts) | N
1212
index | Number | - | 当前预览图片所在的下标。支持语法糖 `v-model:index` | N
1313
defaultIndex | Number | - | 当前预览图片所在的下标。非受控属性 | N
14-
maxZoom | Number | 3 | 【开发中】最大放大比例。TS 类型：`Number` | N
14+
maxZoom | Number | 3 | 【开发中】最大放大比例 | N
1515
showIndex | Boolean | false | 是否显示页码 | N
1616
visible | Boolean | false | 隐藏/显示预览。支持语法糖 `v-model` 或 `v-model:visible` | N
1717
defaultVisible | Boolean | false | 隐藏/显示预览。非受控属性 | N
18-
onClose | Function | | TS 类型：`(context: { trigger: 'overlay' \| 'close-btn', visible: boolean, index: number }) => void`<br/>关闭时触发 | N
18+
onClose | Function | | TS 类型：`(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number }) => void`<br/>关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。<br/>`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`<br/> | N
1919
onDelete | Function | | TS 类型：`(index: number) => void`<br/>点击删除操作按钮时触发 | N
2020
onIndexChange | Function | | TS 类型：`(index: number, context: { trigger: 'prev' \| 'next' }) => void`<br/>预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片 | N
2121

2222
### ImageViewer Events
2323

2424
名称 | 参数 | 描述
2525
-- | -- | --
26-
close | `(context: { trigger: 'overlay' \| 'close-btn', visible: boolean, index: number })` | 关闭时触发
26+
close | `(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number })` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。<br/>`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`<br/>
2727
delete | `(index: number)` | 点击删除操作按钮时触发
2828
index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | 预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片

‎packages/products/tdesign-mobile-vue/src/image-viewer/props.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ export default {
1111
/** 是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以完全自定义关闭按钮 */
1212
closeBtn: {
1313
type: [Boolean, Function] as PropType<TdImageViewerProps['closeBtn']>,
14-
default: true,
14+
default: true as TdImageViewerProps['closeBtn'],
1515
},
1616
/** 是否显示删除操作，前提需要开启页码 */
1717
deleteBtn: {
1818
type: [Boolean, Function] as PropType<TdImageViewerProps['deleteBtn']>,
19-
default: false,
19+
default: false as TdImageViewerProps['deleteBtn'],
2020
},
2121
/** 图片数组 */
2222
images: {

‎packages/products/tdesign-mobile-vue/src/image-viewer/type.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface TdImageViewerProps {
3434
* 【开发中】最大放大比例
3535
* @default 3
3636
*/
37-
maxZoom?: Number;
37+
maxZoom?: number;
3838
/**
3939
* 是否显示页码
4040
* @default false
@@ -58,7 +58,7 @@ export interface TdImageViewerProps {
5858
/**
5959
* 关闭时触发
6060
*/
61-
onClose?: (context: { trigger: 'overlay' | 'close-btn'; visible: boolean; index: number }) => void;
61+
onClose?: (context: { trigger: ImageViewerCloseTrigger; visible: boolean; index: number }) => void;
6262
/**
6363
* 点击删除操作按钮时触发
6464
*/
@@ -73,3 +73,5 @@ export interface ImageInfo {
7373
url: string;
7474
align: 'start' | 'center' | 'end';
7575
}
76+
77+
export type ImageViewerCloseTrigger = 'image' | 'overlay' | 'close-btn';

‎packages/scripts/api.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68985,7 +68985,7 @@
6898568985
"create_time": "2022-07-04 12:06:31",
6898668986
"update_time": "2022-07-04 12:06:31",
6898768987
"event_output": null,
68988-
"custom_field_type": "Number",
68988+
"custom_field_type": "",
6898968989
"syntactic_sugar": null,
6899068990
"readonly": 1,
6899168991
"html_attribute": 0,
@@ -69545,7 +69545,7 @@
6954569545
"field_desc_zh": "关闭时触发",
6954669546
"field_desc_en": null,
6954769547
"field_required": 0,
69548-
"event_input": "(context: { trigger: 'overlay' | 'close-btn', visible: boolean, index: number })",
69548+
"event_input": "(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number })【type ImageViewerCloseTrigger = 'image' | 'overlay' | 'close-btn'】",
6954969549
"create_time": "2023-05-18 02:56:23",
6955069550
"update_time": "2023-05-18 02:56:23",
6955169551
"event_output": null,

0 commit comments

Comments
 (0)