ImagePreview和其他組件不同,不是通過HTML結(jié)構(gòu)的方式來使用,而是通過函數(shù)調(diào)用的方式。使用前需要先引入它。
import Vue from 'vue';
import { ImagePreview } from 'vant';
Vue.use(ImagePreview);
直接傳入圖片數(shù)組,即可展示圖片預(yù)覽
ImagePreview([
'https://img.yzcdn.cn/1.jpg',
'https://img.yzcdn.cn/2.jpg'
]);
通過傳入配置對象,可以指定初始圖片的位置、監(jiān)聽關(guān)閉事件
ImagePreview({
images: [
'https://img.yzcdn.cn/1.jpg',
'https://img.yzcdn.cn/2.jpg'
],
startPosition: 1,
onClose() {
// do something
}
});
通過asyncClose屬性可以開啟異步關(guān)閉,開啟后異步關(guān)閉后,只能通過實例上的 close 方法關(guān)閉圖片預(yù)覽
const instance = ImagePreview({
images: [
'https://img.yzcdn.cn/1.jpg',
'https://img.yzcdn.cn/2.jpg'
],
asyncClose: true
});
setTimeout(() => {
instance.close();
}, 1000);
如果需要在圖片預(yù)覽內(nèi)嵌入組件或其他自定義內(nèi)容,可以使用組件調(diào)用的方式,調(diào)用前需要通過 Vue.use 注冊組件
<van-image-preview v-model="show" :images="images" @change="onChange">
<template v-slot:index>第{{ index }}頁</template>
</van-image-preview>
export default {
data() {
return {
show: false,
index: 0,
images: [
'https://img.yzcdn.cn/1.jpg',
'https://img.yzcdn.cn/2.jpg'
]
};
},
methods: {
onChange(index) {
this.index = index;
}
}
}
通過函數(shù)調(diào)用 ImagePreview 時,支持傳入以下選項:
參數(shù)名 | 說明 | 類型 | 默認值 |
---|---|---|---|
images | 需要預(yù)覽的圖片 URL 數(shù)組 | string[] | [] |
startPosition | 圖片預(yù)覽起始位置索引 | number | string | 0 |
swipeDuration | 動畫時長,單位為ms | number | string | 500 |
showIndex | 是否顯示頁碼 | boolean | true |
showIndicators | 是否顯示輪播指示器 | boolean | false |
loop | 是否開啟循環(huán)播放 | boolean | true |
onClose | 關(guān)閉時的回調(diào)函數(shù) | Function | - |
onChange v2.0.3 | 切換圖片時的回調(diào)函數(shù),回調(diào)參數(shù)為當(dāng)前索引 | Function | - |
asyncClose | 是否開啟異步關(guān)閉 | boolean | false |
closeOnPopstate | 是否在頁面回退時自動關(guān)閉 | boolean | false |
className | 自定義類名 | any | - |
lazyLoad | 是否開啟圖片懶加載,須配合 Lazyload 組件使用 | boolean | false |
maxZoom | 手勢縮放時,最大縮放比例 | number | string | 3 |
minZoom | 手勢縮放時,最小縮放比例 | number | string | 1/3 |
通過組件調(diào)用 ImagePreview 時,支持以下 Props:
參數(shù) | 說明 | 類型 | 默認值 |
---|---|---|---|
images | 需要預(yù)覽的圖片 URL 數(shù)組 | string[] | [] |
start-position | 圖片預(yù)覽起始位置索引 | number | string | 0 |
swipe-duration | 動畫時長,單位為 ms | number | string | 500 |
show-index | 是否顯示頁碼 | boolean | true |
show-indicators | 是否顯示輪播指示器 | boolean | false |
loop | 是否開啟循環(huán)播放 | boolean | true |
async-close | 是否開啟異步關(guān)閉 | boolean | false |
close-on-popstate | 是否在頁面回退時自動關(guān)閉 | boolean | false |
class-name | 自定義類名 | any | - |
lazy-load | 是否開啟圖片懶加載,須配合 Lazyload 組件使用 | boolean | false |
max-zoom | 手勢縮放時,最大縮放比例 | number | string | 3 |
min-zoom | 手勢縮放時,最小縮放比例 | number | string | 1/3 |
通過組件調(diào)用 ImagePreview 時,支持以下事件:
事件 | 說明 | 回調(diào)參數(shù) |
---|---|---|
close | 關(guān)閉時觸發(fā) | { index: 索引, url: 圖片鏈接 } |
change | 切換當(dāng)前圖片時觸發(fā) | index, 當(dāng)前圖片的索引 |
通過組件調(diào)用 ImagePreview 時,支持以下插槽:
名稱 | 說明 |
---|---|
index | 自定義頁碼內(nèi)容 |
cover | 自定義覆蓋在圖片預(yù)覽上方的內(nèi)容 |
參數(shù)名 | 說明 | 類型 |
---|---|---|
url | 當(dāng)前圖片 URL | string |
index | 當(dāng)前圖片的索引值 | number |
參見在桌面端使用。
更多建議: