ImagePreview 图片预览

介绍

图片放大预览,支持函数调用和组件调用两种方式。

函数调用

ImagePreview 是一个函数,调用函数后会直接在页面中展示图片预览界面。

  1. import { ImagePreview } from 'vant';
  2. ImagePreview(['https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg']);

组件调用

通过组件调用 ImagePreview 时,可以通过下面的方式进行注册。

  1. import { createApp } from 'vue';
  2. import { ImagePreview } from 'vant';
  3. // 全局注册
  4. const app = createApp();
  5. app.use(ImagePreview);
  6. // 局部注册
  7. export default {
  8. components: {
  9. [ImagePreview.Component.name]: ImagePreview.Component,
  10. },
  11. };

script setup 中,可以通过以下方式使用:

  1. <script setup>
  2. const VanImagePreview = ImagePreview.Component;
  3. </script>
  4. <template>
  5. <!-- 中划线命名 -->
  6. <van-image-preview />
  7. <!-- 也支持大驼峰命名 -->
  8. <VanImagePreview>
  9. </template>

代码演示

基础用法

直接传入图片数组,即可展示图片预览。

  1. ImagePreview([
  2. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
  3. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  4. ]);

指定初始位置

ImagePreview 支持传入配置对象,并通过 startPosition 选项指定图片的初始位置(索引值)。

  1. ImagePreview({
  2. images: [
  3. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
  4. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  5. ],
  6. startPosition: 1,
  7. });

展示关闭按钮

设置 closeable 属性后,会在弹出层的右上角显示关闭图标,并且可以通过 close-icon 属性自定义图标,使用close-icon-position 属性可以自定义图标位置。

  1. ImagePreview({
  2. images: [
  3. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
  4. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  5. ],
  6. closeable: true,
  7. });

监听关闭事件

通过 onClose 选项监听图片预览的关闭事件。

  1. import { Toast } from 'vant';
  2. ImagePreview({
  3. images: [
  4. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
  5. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  6. ],
  7. onClose() {
  8. Toast('关闭');
  9. },
  10. });

异步关闭

通过 beforeClose 属性可以拦截关闭行为。

  1. const instance = ImagePreview({
  2. images: [
  3. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
  4. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  5. ],
  6. beforeClose: () => false,
  7. });
  8. setTimeout(() => {
  9. // 调用实例上的 close 方法手动关闭图片预览
  10. instance.close();
  11. }, 2000);

组件调用

如果需要在图片预览内嵌入组件或其他自定义内容,可以使用组件调用的方式,调用前需要通过 app.use 注册组件。

  1. <van-image-preview v-model:show="show" :images="images" @change="onChange">
  2. <template v-slot:index>第{{ index }}页</template>
  3. </van-image-preview>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const show = ref(false);
  5. const index = ref(0);
  6. const images = [
  7. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
  8. 'https://cdn.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  9. ];
  10. const onChange = (newIndex) => {
  11. index.value = newIndex;
  12. };
  13. return {
  14. show,
  15. index,
  16. images,
  17. onChange,
  18. };
  19. },
  20. };

API

Options

通过函数调用 ImagePreview 时,支持传入以下选项:

参数名说明类型默认值
images需要预览的图片 URL 数组string[][]
startPosition图片预览起始位置索引number | string0
swipeDuration动画时长,单位为 msnumber | string300
showIndex是否显示页码booleantrue
showIndicators是否显示轮播指示器booleanfalse
loop是否开启循环播放booleantrue
onClose关闭时的回调函数Function-
onChange切换图片时的回调函数,回调参数为当前索引Function-
onScale缩放图片时的回调函数,回调参数为当前索引和当前缩放值组成的对象Function-
beforeClose关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise(active: number) => boolean | Promise<boolean>-
closeOnPopstate是否在页面回退时自动关闭booleantrue
className自定义类名string | Array | object-
maxZoom手势缩放时,最大缩放比例number | string3
minZoom手势缩放时,最小缩放比例number | string1/3
closeable是否显示关闭图标booleanfalse
closeIcon关闭图标名称或图片链接stringclear
closeIconPosition关闭图标位置,可选值为 top-left
bottom-left bottom-right
stringtop-right
transition v3.0.8动画类名,等价于 transitionname 属性stringvan-fade
overlayClass v3.2.8自定义遮罩层类名string | Array | object-
overlayStyle v3.0.8自定义遮罩层样式object-
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element-

Props

通过组件调用 ImagePreview 时,支持以下 Props:

参数说明类型默认值
v-model:show是否展示图片预览booleanfalse
images需要预览的图片 URL 数组string[][]
start-position图片预览起始位置索引number | string0
swipe-duration动画时长,单位为 msnumber | string300
show-index是否显示页码booleantrue
show-indicators是否显示轮播指示器booleanfalse
loop是否开启循环播放booleantrue
before-close关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise(active: number) => boolean | Promise<boolean>-
close-on-popstate是否在页面回退时自动关闭booleantrue
class-name自定义类名string | Array | object-
max-zoom手势缩放时,最大缩放比例number | string3
min-zoom手势缩放时,最小缩放比例number | string1/3
closeable是否显示关闭图标booleanfalse
close-icon关闭图标名称或图片链接stringclear
close-icon-position关闭图标位置,可选值为 top-left
bottom-left bottom-right
stringtop-right
transition v3.0.8动画类名,等价于 transitionname 属性stringvan-fade
overlay-class v3.2.8自定义遮罩层类名string | Array | object-
overlay-style v3.0.8自定义遮罩层样式object-
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element-

Events

通过组件调用 ImagePreview 时,支持以下事件:

事件说明回调参数
close关闭时触发{ index: 索引, url: 图片链接 }
closed关闭且且动画结束后触发-
change切换当前图片时触发index: 当前图片的索引
scale缩放当前图片时触发{ index: 当前图片的索引, scale: 当前缩放的值 }

方法

通过组件调用 ImagePreview 时,通过 ref 可以获取到 ImagePreview 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
swipeTo 2.9.0切换到指定位置index: number, options?: SwipeToOptions-

类型定义

组件导出以下类型定义:

  1. import type {
  2. ImagePreviewProps,
  3. ImagePreviewOptions,
  4. ImagePreviewInstance,
  5. ImagePreviewScaleEventParams,
  6. } from 'vant';

ImagePreviewInstance 是组件实例的类型,用法如下:

  1. import { ref } from 'vue';
  2. import type { ImagePreviewInstance } from 'vant';
  3. const imagePreviewRef = ref<ImagePreviewInstance>();
  4. imagePreviewRef.value?.swipeTo(1);

Slots

通过组件调用 ImagePreview 时,支持以下插槽:

名称说明参数
index自定义页码内容{ index: 当前图片的索引 }
cover自定义覆盖在图片预览上方的内容-

onClose 回调参数

参数名说明类型
url当前图片 URLstring
index当前图片的索引值number

onScale 回调参数

参数名说明类型
index当前图片的索引值number
scale当前图片的缩放值number

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-image-preview-index-text-colorvar(—van-white)-
—van-image-preview-index-font-sizevar(—van-font-size-md)-
—van-image-preview-index-line-heightvar(—van-line-height-md)-
—van-image-preview-index-text-shadow0 1px 1px var(—van-gray-8)-
—van-image-preview-overlay-background-colorrgba(0, 0, 0, 0.9)-
—van-image-preview-close-icon-size22px-
—van-image-preview-close-icon-colorvar(—van-gray-5)-
—van-image-preview-close-icon-marginvar(—van-padding-md)-
—van-image-preview-close-icon-z-index1-

常见问题

在桌面端无法操作组件?

参见桌面端适配

在 JSX 中渲染 ImagePreview 组件无法展示?

请注意 ImagePreview 是一个函数,ImagePreview.Component 才是 ImagePreview 对应的组件。JSX 调用图片预览的正确姿势如下:

  1. export default {
  2. setup() {
  3. const show = ref(false);
  4. return () => <ImagePreview.Component v-model={[show, 'show']} />;
  5. },
  6. };

ImagePreview 图片预览 - 图1