Skip to content

ImageViewer 图片预览

图片预览

通过 createImageViewer 函数来打开图片预览

API

配置项

事件名说明类型默认值
urlList用于预览的图片链接列表string[][]
zIndex预览时遮罩层的 z-indexnumber / string
initialIndex初始预览图像索引,小于 url-list 的长度number0
infinite是否可以无限循环预览booleantrue
hideOnClickModal是否可以通过点击遮罩层关闭预览booleanfalse
teleportedimage 自身是否插入至 body 元素上。 嵌套的父元素属性会发生修改时应该将此属性设置为 truebooleanfalse
zoomRate图像查看器缩放事件的缩放速率。number1.2
minScale图像查看器缩放事件的最小缩放比例number0.2
maxScale图像查看器缩放事件的最大缩放比例number7
closeOnPressEscape是否可以通过按下 ESC 关闭booleantrue
showProgress是否显示预览图片的进度条内容booleanfalse

方法

事件名说明类型
close当点击 X 按钮或者在 hide-on-click-modal 为 true 时点击遮罩层时触发() => void
switch切换图像时触发。(index: number) => void
rotate旋转图像时触发。(deg: number) => void

这样使用:

vue
<script setup lang="ts">
import { createImageViewer } from "vitepress-theme-teek";

const handleClick = () => {
  createImageViewer({ onSwitch: () => {}, onRotate: () => {} });
};
</script>

<template>
  <button @click="handleClick">点击打开图片预览</button>
</template>
最近更新