# ImagePreview 图片预览

### 介绍

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

### 函数调用

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

```js
import { ImagePreview } from 'vant';

ImagePreview(['https://img01.yzcdn.cn/vant/apple-1.jpg']);
```

### 组件调用

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

```js
import { createApp } from 'vue';
import { ImagePreview } from 'vant';

// 全局注册
const app = createApp();
app.use(ImagePreview);

// 局部注册
export default {
  components: {
    [ImagePreview.Component.name]: ImagePreview.Component,
  },
};
```

## 代码演示

### 基础用法

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

```js
ImagePreview([
  'https://img01.yzcdn.cn/vant/apple-1.jpg',
  'https://img01.yzcdn.cn/vant/apple-2.jpg',
]);
```

### 指定初始位置

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

```js
ImagePreview({
  images: [
    'https://img01.yzcdn.cn/vant/apple-1.jpg',
    'https://img01.yzcdn.cn/vant/apple-2.jpg',
  ],
  startPosition: 1,
});
```

### 展示关闭按钮

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

```js
ImagePreview({
  images: [
    'https://img01.yzcdn.cn/vant/apple-1.jpg',
    'https://img01.yzcdn.cn/vant/apple-2.jpg',
  ],
  closeable: true,
});
```

### 监听关闭事件

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

```js
import { Toast } from 'vant';

ImagePreview({
  images: [
    'https://img01.yzcdn.cn/vant/apple-1.jpg',
    'https://img01.yzcdn.cn/vant/apple-2.jpg',
  ],
  onClose() {
    Toast('关闭');
  },
});
```

### 异步关闭

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

```js
const instance = ImagePreview({
  images: [
    'https://img01.yzcdn.cn/vant/apple-1.jpg',
    'https://img01.yzcdn.cn/vant/apple-2.jpg',
  ],
  beforeClose: () => false,
});

setTimeout(() => {
  // 调用实例上的 close 方法手动关闭图片预览
  instance.close();
}, 2000);
```

### 组件调用

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

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

```js
import { reactive } from 'vue';

export default {
  setup() {
    const state = reactive({
      show: false,
      index: 0,
    });
    const onChange = (index) => {
      state.index = index;
    };

    return {
      state,
      images: [
        'https://img01.yzcdn.cn/vant/apple-1.jpg',
        'https://img01.yzcdn.cn/vant/apple-2.jpg',
      ],
      onChange,
    };
  },
};
```

## API

### Options

通过函数调用 `ImagePreview` 时，支持传入以下选项：

| 参数名            | 说明                                                              | 类型                             | 默认值      |
|-------------------|-----------------------------------------------------------------|----------------------------------|-------------|
| images            | 需要预览的图片 URL 数组                                           | _string[]_                       | `[]`        |
| startPosition     | 图片预览起始位置索引                                              | _number \| string_               | `0`         |
| swipeDuration     | 动画时长，单位为 `ms`                                              | _number \| string_               | `300`       |
| showIndex         | 是否显示页码                                                      | _boolean_                        | `true`      |
| showIndicators    | 是否显示轮播指示器                                                | _boolean_                        | `false`     |
| loop              | 是否开启循环播放                                                  | _boolean_                        | `true`      |
| onClose           | 关闭时的回调函数                                                  | _Function_                       | -           |
| onChange          | 切换图片时的回调函数，回调参数为当前索引                           | _Function_                       | -           |
| onScale           | 缩放图片时的回调函数，回调参数为当前索引和当前缩放值组成的对象     | _Function_                       | -           |
| beforeClose       | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise         | _(active) => boolean \| Promise_ | -           |
| closeOnPopstate   | 是否在页面回退时自动关闭                                          | _boolean_                        | `true`      |
| className         | 自定义类名                                                        | _string \| Array \| object_      | -           |
| maxZoom           | 手势缩放时，最大缩放比例                                           | _number \| string_               | `3`         |
| minZoom           | 手势缩放时，最小缩放比例                                           | _number \| string_               | `1/3`       |
| closeable         | 是否显示关闭图标                                                  | _boolean_                        | `false`     |
| closeIcon         | 关闭图标名称或图片链接                                            | _string_                         | `clear`     |
| closeIconPosition | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right`  | _string_                         | `top-right` |
| teleport          | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_              | -           |

### Props

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

| 参数                | 说明                                                              | 类型                             | 默认值      |
|---------------------|-----------------------------------------------------------------|----------------------------------|-------------|
| images              | 需要预览的图片 URL 数组                                           | _string[]_                       | `[]`        |
| start-position      | 图片预览起始位置索引                                              | _number \| string_               | `0`         |
| swipe-duration      | 动画时长，单位为 ms                                                | _number \| string_               | `300`       |
| show-index          | 是否显示页码                                                      | _boolean_                        | `true`      |
| show-indicators     | 是否显示轮播指示器                                                | _boolean_                        | `false`     |
| loop                | 是否开启循环播放                                                  | _boolean_                        | `true`      |
| before-close        | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise         | _(active) => boolean \| Promise_ | -           |
| close-on-popstate   | 是否在页面回退时自动关闭                                          | _boolean_                        | `true`      |
| class-name          | 自定义类名                                                        | _string \| Array \| object_      | -           |
| max-zoom            | 手势缩放时，最大缩放比例                                           | _number \| string_               | `3`         |
| min-zoom            | 手势缩放时，最小缩放比例                                           | _number \| string_               | `1/3`       |
| closeable           | 是否显示关闭图标                                                  | _boolean_                        | `false`     |
| close-icon          | 关闭图标名称或图片链接                                            | _string_                         | `clear`     |
| close-icon-position | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right`   | _string_                         | `top-right` |
| teleport            | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_              | -           |

### Events

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

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

### 方法

通过组件调用 `ImagePreview` 时，通过 ref 可以获取到 ImagePreview 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。

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

### Slots

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

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

### onClose 回调参数

| 参数名 | 说明             | 类型     |
|--------|----------------|----------|
| url    | 当前图片 URL     | _string_ |
| index  | 当前图片的索引值 | _number_ |

### onScale 回调参数

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

### 样式变量

组件提供了下列 Less 变量，可用于自定义样式，使用方法请参考[主题定制](#/zh-CN/theme)。

| 名称                                    | 默认值               | 描述 |
|-----------------------------------------|----------------------|------|
| @image-preview-index-text-color         | `@white`             | -    |
| @image-preview-index-font-size          | `@font-size-md`      | -    |
| @image-preview-index-line-height        | `@line-height-md`    | -    |
| @image-preview-index-text-shadow        | `0 1px 1px @gray-8`  | -    |
| @image-preview-overlay-background-color | `rgba(0, 0, 0, 0.9)` | -    |
| @image-preview-close-icon-size          | `22px`               | -    |
| @image-preview-close-icon-color         | `@gray-5`            | -    |
| @image-preview-close-icon-active-color  | `@gray-6`            | -    |
| @image-preview-close-icon-margin        | `@padding-md`        | -    |
| @image-preview-close-icon-z-index       | `1`                  | -    |

## 常见问题

### 在桌面端无法操作组件？

参见[桌面端适配](#/zh-CN/advanced-usage#zhuo-mian-duan-gua-pei)。
