ImagePreview 图片预览

介绍

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

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { ImagePreview } from 'vant';
const app = createApp();
app.use(ImagePreview);

函数调用

为了便于使用 ImagePreview，Vant 提供了一系列辅助函数，通过辅助函数可以快速唤起全局的图片预览组件。

比如使用 showImagePreview 函数，调用后会直接在页面中渲染对应的图片预览组件。

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

代码演示

基础用法

在调用 showImagePreview 时，直接传入图片数组，即可展示图片预览。

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

指定初始位置

showImagePreview 支持传入配置对象，并通过 startPosition 选项指定图片的初始位置（索引值）。

import { showImagePreview } from 'vant';
showImagePreview({
  images: [
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  ],
  startPosition: 1,
});

展示关闭按钮

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

import { showImagePreview } from 'vant';
showImagePreview({
  images: [
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  ],
  closeable: true,
});

监听关闭事件

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

import { showToast, showImagePreview } from 'vant';
showImagePreview({
  images: [
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  ],
  onClose() {
    showToast('关闭');
  },
});

异步关闭

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

import { showImagePreview } from 'vant';
const instance = showImagePreview({
  images: [
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
    'https://fastly.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
  ],
  beforeClose: () => false,
});
setTimeout(() => {
  // 调用实例上的 close 方法手动关闭图片预览
  instance.close();
}, 2000);

使用 ImagePreview 组件

如果需要在 ImagePreview 内嵌入组件或其他自定义内容，可以直接使用 ImagePreview 组件，并使用 index 插槽进行定制。使用前需要通过 app.use 等方式注册组件。

<van-image-preview v-model:show="show" :images="images" @change="onChange">
  <template v-slot:index>第{{ index }}页</template>
</van-image-preview>

import { ref } from 'vue';
export default {
  setup() {
    const show = ref(false);
    const index = ref(0);
    const images = [
      'https://fastly.jsdelivr.net/npm/@vant/assets/apple-1.jpeg',
      'https://fastly.jsdelivr.net/npm/@vant/assets/apple-2.jpeg',
    ];
    const onChange = (newIndex) => {
      index.value = newIndex;
    };
    return {
      show,
      index,
      images,
      onChange,
    };
  },
};

使用 image 插槽

当以组件调用的方式使用 ImagePreview 时，可以通过 image 插槽来插入自定义的内容，比如展示一个视频内容。

<van-image-preview v-model:show="show" :images="images">
  <template #image="{ src }">
    <video style="width: 100%;" controls>
      <source :src="src" />
    </video>
  </template>
</van-image-preview>

import { ref } from 'vue';
export default {
  setup() {
    const show = ref(false);
    const images = [
      'https://www.w3school.com.cn/i/movie.ogg',
      'https://www.w3school.com.cn/i/movie.ogg',
      'https://www.w3school.com.cn/i/movie.ogg',
    ];
    return {
      show,
      images,
    };
  },
};

API

方法

Vant 中导出了以下 ImagePreview 相关的辅助函数：

| 方法名 | 说明 | 参数 | 返回值 | | ———————— | —————— | ————- | —————————— | ————————- | | showImagePreview | 展示图片预览 | string[] | ImagePreviewOptions | imagePreview 实例 |

ImagePreviewOptions

调用 showImagePreview 方法时，支持传入以下选项：

Props

通过组件调用 ImagePreview 时，支持以下 Props：

Events

通过组件调用 ImagePreview 时，支持以下事件：

方法

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

类型定义

组件导出以下类型定义：

import type {
  ImagePreviewProps,
  ImagePreviewOptions,
  ImagePreviewInstance,
  ImagePreviewScaleEventParams,
} from 'vant';

ImagePreviewInstance 是组件实例的类型，用法如下：

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

Slots

通过组件调用 ImagePreview 时，支持以下插槽：

onClose 回调参数

onScale 回调参数

主题定制

样式变量

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

常见问题

在桌面端无法操作组件？

参见桌面端适配。

引用 showImagePreview 时出现编译报错？

如果引用 showImagePreview 方法时出现以下报错，说明项目中使用了 babel-plugin-import 插件，导致代码被错误编译。

These dependencies were not found:
* vant/es/show-image-preview in ./src/xxx.js
* vant/es/show-image-preview/style in ./src/xxx.js

Vant 从 4.0 版本开始不再支持 babel-plugin-import 插件，请参考 迁移指南 移除该插件。