diff --git a/db/TDesign.db b/db/TDesign.db index 4ec57c4b..bc771f6a 100644 Binary files a/db/TDesign.db and b/db/TDesign.db differ diff --git a/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.en-US.md b/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.en-US.md index 6fb5617d..79bd8693 100644 --- a/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.en-US.md +++ b/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.en-US.md @@ -7,26 +7,26 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N -attach | String / Function | 'body' | Typescript:`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -closeBtn | TNode | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets),Typescript: `React.CSSProperties` | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeBtn | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N closeOnEscKeydown | Boolean | true | trigger image viewer close event on `ESC` keydown | N closeOnOverlay | Boolean | - | \- | N draggable | Boolean | undefined | \- | N imageReferrerpolicy | String | - | attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)。options: no-referrer/no-referrer-when-downgrade/origin/origin-when-cross-origin/same-origin/strict-origin/strict-origin-when-cross-origin/unsafe-url | N -imageScale | Object | - | Typescript:`Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N -images | Array | [] | Typescript:`Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N +imageScale | Object | - | Typescript: `Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N +images | Array | [] | Typescript: `Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N index | Number | 0 | \- | N defaultIndex | Number | 0 | uncontrolled property | N mode | String | modal | options: modal/modeless | N -navigationArrow | TNode | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +navigationArrow | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N showOverlay | Boolean | undefined | \- | N -title | TNode | - | preview title。Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -trigger | TNode | - | trigger element。Typescript:`TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -viewerScale | Object | - | Typescript:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N +title | TNode | - | preview title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +trigger | TNode | - | trigger element。Typescript: `TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +viewerScale | Object | - | Typescript: `ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N visible | Boolean | false | hide or show image viewer | N defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N zIndex | Number | - | \- | N -onClose | Function | | Typescript:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N -onDownload | Function | | Typescript:`(url: string \| File) => void`
| N -onIndexChange | Function | | Typescript:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N +onClose | Function | | Typescript: `(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N +onDownload | Function | | Typescript: `(url: string \| File) => void`
| N +onIndexChange | Function | | Typescript: `(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N diff --git a/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.md b/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.md index ea5c7930..8b3c0a6e 100644 --- a/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.md +++ b/packages/products/tdesign-react/packages/components/image-viewer/image-viewer.md @@ -22,7 +22,7 @@ mode | String | modal | 模态预览(modal)和非模态预览(modeless)。 navigationArrow | TNode | true | 切换预览图片的左图标,可自定义。TS 类型:`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N showOverlay | Boolean | undefined | 是否显示遮罩层。`mode=modal` 时,默认显示;`mode=modeless` 时,默认不显示 | N title | TNode | - | 预览标题。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -trigger | TNode | - | 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义。TS 类型:`TNode \| TNode<{ open: (index?: number) => void }>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +trigger | TNode | - | 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图。TS 类型:`TNode \| TNode<{ open: (index?: number) => void }>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N viewerScale | Object | - | 限制预览器缩放的最小宽度和最小高度,仅 `mode=modeless` 时有效。TS 类型:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N visible | Boolean | false | 隐藏/显示预览 | N defaultVisible | Boolean | false | 隐藏/显示预览。非受控属性 | N diff --git a/packages/products/tdesign-react/packages/components/image-viewer/type.ts b/packages/products/tdesign-react/packages/components/image-viewer/type.ts index 85b25a90..1f6a09e1 100644 --- a/packages/products/tdesign-react/packages/components/image-viewer/type.ts +++ b/packages/products/tdesign-react/packages/components/image-viewer/type.ts @@ -81,7 +81,7 @@ export interface TdImageViewerProps { */ title?: TNode; /** - * 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义 + * 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图 */ trigger?: TNode | TNode<{ open: (index?: number) => void }>; /** diff --git a/packages/products/tdesign-vue-next/packages/components/common.ts b/packages/products/tdesign-vue-next/packages/components/common.ts index 2a381a71..b593c98f 100644 --- a/packages/products/tdesign-vue-next/packages/components/common.ts +++ b/packages/products/tdesign-vue-next/packages/components/common.ts @@ -41,9 +41,6 @@ export interface UploadDisplayDragEvents { export type ImageEvent = Event; -/** - * 通用全局类型 - * */ export type PlainObject = { [key: string]: any }; export type OptionData = { @@ -63,6 +60,9 @@ export type TreeOptionData = { content?: string | TNode; } & PlainObject; +/** + * 通用全局类型 + * */ export type SizeEnum = 'small' | 'medium' | 'large'; export type ShapeEnum = 'circle' | 'round'; diff --git a/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.en-US.md b/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.en-US.md index 68c752e6..7d6fc401 100644 --- a/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.en-US.md +++ b/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.en-US.md @@ -6,28 +6,28 @@ name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript:`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -closeBtn | Boolean / Slot / Function | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N +closeBtn | Boolean / Slot / Function | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N closeOnEscKeydown | Boolean | true | trigger image viewer close event on `ESC` keydown | N closeOnOverlay | Boolean | - | \- | N draggable | Boolean | undefined | \- | N imageReferrerpolicy | String | - | attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)。options: no-referrer/no-referrer-when-downgrade/origin/origin-when-cross-origin/same-origin/strict-origin/strict-origin-when-cross-origin/unsafe-url | N -imageScale | Object | - | Typescript:`Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N -images | Array | [] | Typescript:`Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N +imageScale | Object | - | Typescript: `Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N +images | Array | [] | Typescript: `Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N index | Number | 0 | `v-model:index` is supported | N defaultIndex | Number | 0 | uncontrolled property | N mode | String | modal | options: modal/modeless | N -navigationArrow | Boolean / Slot / Function | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N +navigationArrow | Boolean / Slot / Function | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N showOverlay | Boolean | undefined | \- | N -title | String / Slot / Function | - | preview title。Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -trigger | String / Slot / Function | - | trigger element。Typescript:`TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -viewerScale | Object | - | Typescript:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N +title | String / Slot / Function | - | preview title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N +trigger | String / Slot / Function | - | trigger element。Typescript: `TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N +viewerScale | Object | - | Typescript: `ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N visible | Boolean | false | hide or show image viewer。`v-model` and `v-model:visible` is supported | N defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N zIndex | Number | - | \- | N -onClose | Function | | Typescript:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N -onDownload | Function | | Typescript:`(url: string \| File) => void`
| N -onIndexChange | Function | | Typescript:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N +onClose | Function | | Typescript: `(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N +onDownload | Function | | Typescript: `(url: string \| File) => void`
| N +onIndexChange | Function | | Typescript: `(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N ### ImageViewer Events diff --git a/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.md b/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.md index d40ddfb6..7d6d8d87 100644 --- a/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.md +++ b/packages/products/tdesign-vue-next/packages/components/image-viewer/image-viewer.md @@ -20,7 +20,7 @@ mode | String | modal | 模态预览(modal)和非模态预览(modeless)。 navigationArrow | Boolean / Slot / Function | true | 切换预览图片的左图标,可自定义。TS 类型:`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N showOverlay | Boolean | undefined | 是否显示遮罩层。`mode=modal` 时,默认显示;`mode=modeless` 时,默认不显示 | N title | String / Slot / Function | - | 预览标题。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -trigger | String / Slot / Function | - | 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义。TS 类型:`TNode \| TNode<{ open: (index?: number) => void }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N +trigger | String / Slot / Function | - | 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图。TS 类型:`TNode \| TNode<{ open: (index?: number) => void }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N viewerScale | Object | - | 限制预览器缩放的最小宽度和最小高度,仅 `mode=modeless` 时有效。TS 类型:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/image-viewer/type.ts) | N visible | Boolean | false | 隐藏/显示预览。支持语法糖 `v-model` 或 `v-model:visible` | N defaultVisible | Boolean | false | 隐藏/显示预览。非受控属性 | N diff --git a/packages/products/tdesign-vue-next/packages/components/image-viewer/props.ts b/packages/products/tdesign-vue-next/packages/components/image-viewer/props.ts index e5f23892..a502d283 100644 --- a/packages/products/tdesign-vue-next/packages/components/image-viewer/props.ts +++ b/packages/products/tdesign-vue-next/packages/components/image-viewer/props.ts @@ -80,7 +80,7 @@ export default { title: { type: [String, Function] as PropType, }, - /** 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义 */ + /** 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图 */ trigger: { type: [String, Function] as PropType, }, diff --git a/packages/products/tdesign-vue-next/packages/components/image-viewer/type.ts b/packages/products/tdesign-vue-next/packages/components/image-viewer/type.ts index 0482b61b..59b44e30 100644 --- a/packages/products/tdesign-vue-next/packages/components/image-viewer/type.ts +++ b/packages/products/tdesign-vue-next/packages/components/image-viewer/type.ts @@ -80,7 +80,7 @@ export interface TdImageViewerProps { */ title?: string | TNode; /** - * 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义 + * 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图 */ trigger?: TNode | TNode<{ open: (index?: number) => void }>; /** diff --git a/packages/products/tdesign-vue/src/image-viewer/image-viewer.en-US.md b/packages/products/tdesign-vue/src/image-viewer/image-viewer.en-US.md index f32d03e9..7548419f 100644 --- a/packages/products/tdesign-vue/src/image-viewer/image-viewer.en-US.md +++ b/packages/products/tdesign-vue/src/image-viewer/image-viewer.en-US.md @@ -6,28 +6,28 @@ name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript:`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -closeBtn | Boolean / Slot / Function | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +closeBtn | Boolean / Slot / Function | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N closeOnEscKeydown | Boolean | true | trigger image viewer close event on `ESC` keydown | N closeOnOverlay | Boolean | - | \- | N draggable | Boolean | undefined | \- | N imageReferrerpolicy | String | - | attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)。options: no-referrer/no-referrer-when-downgrade/origin/origin-when-cross-origin/same-origin/strict-origin/strict-origin-when-cross-origin/unsafe-url | N -imageScale | Object | - | Typescript:`Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N -images | Array | [] | Typescript:`Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N +imageScale | Object | - | Typescript: `Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N +images | Array | [] | Typescript: `Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N index | Number | 0 | `.sync` is supported | N defaultIndex | Number | 0 | uncontrolled property | N mode | String | modal | options: modal/modeless | N -navigationArrow | Boolean / Slot / Function | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +navigationArrow | Boolean / Slot / Function | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N showOverlay | Boolean | undefined | \- | N -title | String / Slot / Function | - | preview title。Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -trigger | String / Slot / Function | - | trigger element。Typescript:`TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -viewerScale | Object | - | Typescript:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N +title | String / Slot / Function | - | preview title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +trigger | String / Slot / Function | - | trigger element。Typescript: `TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +viewerScale | Object | - | Typescript: `ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N visible | Boolean | false | hide or show image viewer。`v-model` is supported | N defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N zIndex | Number | - | \- | N -onClose | Function | | Typescript:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N -onDownload | Function | | Typescript:`(url: string \| File) => void`
| N -onIndexChange | Function | | Typescript:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N +onClose | Function | | Typescript: `(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N +onDownload | Function | | Typescript: `(url: string \| File) => void`
| N +onIndexChange | Function | | Typescript: `(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N ### ImageViewer Events diff --git a/packages/products/tdesign-vue/src/image-viewer/image-viewer.md b/packages/products/tdesign-vue/src/image-viewer/image-viewer.md index e36dc3d3..0a82a9e6 100644 --- a/packages/products/tdesign-vue/src/image-viewer/image-viewer.md +++ b/packages/products/tdesign-vue/src/image-viewer/image-viewer.md @@ -20,7 +20,7 @@ mode | String | modal | 模态预览(modal)和非模态预览(modeless)。 navigationArrow | Boolean / Slot / Function | true | 切换预览图片的左图标,可自定义。TS 类型:`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N showOverlay | Boolean | undefined | 是否显示遮罩层。`mode=modal` 时,默认显示;`mode=modeless` 时,默认不显示 | N title | String / Slot / Function | - | 预览标题。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -trigger | String / Slot / Function | - | 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义。TS 类型:`TNode \| TNode<{ open: (index?: number) => void }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +trigger | String / Slot / Function | - | 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图。TS 类型:`TNode \| TNode<{ open: (index?: number) => void }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N viewerScale | Object | - | 限制预览器缩放的最小宽度和最小高度,仅 `mode=modeless` 时有效。TS 类型:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/image-viewer/type.ts) | N visible | Boolean | false | 隐藏/显示预览。支持语法糖 `v-model` | N defaultVisible | Boolean | false | 隐藏/显示预览。非受控属性 | N diff --git a/packages/products/tdesign-vue/src/image-viewer/props.ts b/packages/products/tdesign-vue/src/image-viewer/props.ts index cd2ce57f..d2e5421f 100644 --- a/packages/products/tdesign-vue/src/image-viewer/props.ts +++ b/packages/products/tdesign-vue/src/image-viewer/props.ts @@ -80,7 +80,7 @@ export default { title: { type: [String, Function] as PropType, }, - /** 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义 */ + /** 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图 */ trigger: { type: [String, Function] as PropType, }, diff --git a/packages/products/tdesign-vue/src/image-viewer/type.ts b/packages/products/tdesign-vue/src/image-viewer/type.ts index ca02d549..b5c64ddb 100644 --- a/packages/products/tdesign-vue/src/image-viewer/type.ts +++ b/packages/products/tdesign-vue/src/image-viewer/type.ts @@ -80,7 +80,7 @@ export interface TdImageViewerProps { */ title?: string | TNode; /** - * 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义 + * 触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图 */ trigger?: TNode | TNode<{ open: (index?: number) => void }>; /** diff --git a/packages/scripts/api.json b/packages/scripts/api.json index b8ad803f..c3816aa4 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -67070,7 +67070,7 @@ ], "field_default_value": "", "field_enum": "", - "field_desc_zh": "触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义", + "field_desc_zh": "触发图片预览的元素,可能是一个预览按钮,可能是一张缩略图,完全自定义,默认为预览图片的缩略图", "field_desc_en": "trigger element", "field_required": 0, "event_input": "",