Skip to content

fix(image-viewer): fix z-index to 3000 #6128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

fix(image-viewer): fix z-index to 3000 #6128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae75e9e
fix(image-viewer): fix z-index to 3000
liweijie0812 Nov 4, 2025
e223ccf
chore: update snapshot
liweijie0812 Nov 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/components/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ export interface UploadDisplayDragEvents {

export type ImageEvent = Event;

/**
* 通用全局类型
* */
export type PlainObject = { [key: string]: any };

export type OptionData = {
Expand All @@ -63,6 +60,9 @@ export type TreeOptionData<T = string | number> = {
content?: string | TNode;
} & PlainObject;

/**
* 通用全局类型
* */
export type SizeEnum = 'small' | 'medium' | 'large';

export type ShapeEnum = 'circle' | 'round';
Expand Down
1 change: 0 additions & 1 deletion packages/components/image-viewer/__tests__/__snapshots__/image-viewer.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
exports[`Image-viewer > :props > defaultVisible 1`] = `
<div
class="t-image-viewer t-image-viewer-preview-image"
style="z-index: 2600;"
tabindex="-1"
>
<div
Expand Down
22 changes: 11 additions & 11 deletions packages/components/image-viewer/image-viewer.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<img>`, [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<ImageScale>` `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<string \| File \| ImageInfo>` `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<ImageScale>` `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<string \| File \| ImageInfo>` `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`<br/> | N
onDownload | Function | | Typescript：`(url: string \| File) => void`<br/> | N
onIndexChange | Function | | Typescript：`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/> | N
onClose | Function | | Typescript: `(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`<br/> | N
onDownload | Function | | Typescript: `(url: string \| File) => void`<br/> | N
onIndexChange | Function | | Typescript: `(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/> | N

### ImageViewer Events

Expand Down
2 changes: 1 addition & 1 deletion packages/components/image-viewer/image-viewer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`<br/>关闭时触发，事件参数包含触发关闭的来源：关闭按钮、遮罩层、ESC 键 | N
onDownload | Function | | TS 类型：`(url: string \| File) => void`<br/>自定义预览图片下载操作，url为图片链接 | N
onIndexChange | Function | | TS 类型：`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/>预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片 | N
Expand Down
7 changes: 3 additions & 4 deletions packages/components/image-viewer/image-viewer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};
Expand Down Expand Up @@ -259,7 +258,7 @@ export default defineComponent({
<>
{renderTNodeJSX('trigger', { params: { open: openHandler } }) || renderDefaultTrigger()}
<TImageViewerModal
zIndex={zIndexValue.value}
zIndex={props.zIndex}
visible={visibleValue.value}
index={indexValue.value}
images={images.value}
Expand Down Expand Up @@ -293,7 +292,7 @@ export default defineComponent({
ref={divRef}
v-show={visibleValue.value}
class={wrapClass.value}
style={{ zIndex: zIndexValue.value }}
style={{ zIndex: props.zIndex }}
onWheel={onWheel}
tabindex={-1}
onKeydown={keydownHandler}
Expand All @@ -314,7 +313,7 @@ export default defineComponent({
)}
{renderCloseBtn()}
<TImageViewerUtils
zIndex={zIndexValue.value + 1}
zIndex={props.zIndex + 1}
onZoomIn={onZoomIn}
onZoomOut={onZoomOut}
onMirror={onMirror}
Expand Down
4 changes: 2 additions & 2 deletions packages/components/image-viewer/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
* */

import { PropType } from 'vue';
import { TdImageViewerProps } from './type';
import { PropType } from 'vue';

export default {
/** 指定挂载节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body */
Expand Down Expand Up @@ -108,7 +108,7 @@ export default {
},
/** 隐藏/显示预览，非受控属性 */
defaultVisible: Boolean,
/** 层级，默认为 2000 */
/** 层级，默认为 3000 */
zIndex: {
type: Number,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/components/image-viewer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export interface TdImageViewerProps {
*/
modelValue?: boolean;
/**
* 层级，默认为 2000
* 层级，默认为 3000
*/
zIndex?: number;
/**
Expand Down
Loading