vant/packages/image-preview/en-US.md

ImagePreview

Install

import { ImagePreview } from 'vant';

Usage

Basic Usage

ImagePreview([
  'https://img.yzcdn.cn/1.jpg',
  'https://img.yzcdn.cn/2.jpg'
]);

Custom config

ImagePreview({
  images: [
    'https://img.yzcdn.cn/1.jpg',
    'https://img.yzcdn.cn/2.jpg'
  ],
  startPosition: 1,
  onClose() {
    // do something
  }
});

Async Close

const instance = ImagePreview({
  images: [
    'https://img.yzcdn.cn/1.jpg',
    'https://img.yzcdn.cn/2.jpg'
  ],
  asyncClose: true
});

setTimeout(() => {
  instance.close();
}, 1000);

Arguments

Attribute	Description	Type	Default
images	Images URL list	Array	[]
startPosition	Start position	Number	0
showIndex	Whether to show index	Boolean	true
showIndicators	Whether to show indicators	Boolean	false
loop	Whether to enable loop	Boolean	true
onClose	Close callback	Function	-
asyncClose	Whether to enable async close	Boolean	false

onClose Parematers

Attribute	Description	Type
url	Url of current image	Number
index	Index of current image	String