diff --git a/packages/components/common.ts b/packages/components/common.ts index 2a381a710f..b593c98fe9 100644 --- a/packages/components/common.ts +++ b/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/components/image-viewer/__tests__/__snapshots__/image-viewer.test.tsx.snap b/packages/components/image-viewer/__tests__/__snapshots__/image-viewer.test.tsx.snap index 66c878a7df..20b9c5c4da 100644 --- a/packages/components/image-viewer/__tests__/__snapshots__/image-viewer.test.tsx.snap +++ b/packages/components/image-viewer/__tests__/__snapshots__/image-viewer.test.tsx.snap @@ -3,7 +3,6 @@ exports[`Image-viewer > :props > defaultVisible 1`] = `
`, [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/components/image-viewer/image-viewer.md b/packages/components/image-viewer/image-viewer.md index 1f47b8391a..7d6d8d878a 100644 --- a/packages/components/image-viewer/image-viewer.md +++ b/packages/components/image-viewer/image-viewer.md @@ -24,7 +24,7 @@ trigger | String / Slot / Function | - | 触发图片预览的元素,可能是 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 -zIndex | Number | - | 层级,默认为 2600 | N +zIndex | Number | - | 层级,默认为 3000 | N onClose | Function | | TS 类型:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
关闭时触发,事件参数包含触发关闭的来源:关闭按钮、遮罩层、ESC 键 | N onDownload | Function | | TS 类型:`(url: string \| File) => void`
自定义预览图片下载操作,url为图片链接 | N onIndexChange | Function | | TS 类型:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
预览图片切换时触发,`context.prev` 切换到上一张图片,`context.next` 切换到下一张图片 | N diff --git a/packages/components/image-viewer/image-viewer.tsx b/packages/components/image-viewer/image-viewer.tsx index 167c267a24..a6eb4e1378 100644 --- a/packages/components/image-viewer/image-viewer.tsx +++ b/packages/components/image-viewer/image-viewer.tsx @@ -53,7 +53,6 @@ export default defineComponent({ [`${classPrefix.value}-is-show`]: isExpand.value, }, ]); - const zIndexValue = computed(() => props.zIndex ?? 2600); const toggleExpand = () => { isExpand.value = !isExpand.value; }; @@ -259,7 +258,7 @@ export default defineComponent({ <> {renderTNodeJSX('trigger', { params: { open: openHandler } }) || renderDefaultTrigger()} document.body */ @@ -108,7 +108,7 @@ export default { }, /** 隐藏/显示预览,非受控属性 */ defaultVisible: Boolean, - /** 层级,默认为 2000 */ + /** 层级,默认为 3000 */ zIndex: { type: Number, }, diff --git a/packages/components/image-viewer/type.ts b/packages/components/image-viewer/type.ts index 66087e9fe6..59b44e306a 100644 --- a/packages/components/image-viewer/type.ts +++ b/packages/components/image-viewer/type.ts @@ -103,7 +103,7 @@ export interface TdImageViewerProps { */ modelValue?: boolean; /** - * 层级,默认为 2000 + * 层级,默认为 3000 */ zIndex?: number; /**