ContextQMD
Back to Vant Weapp

Image 图片

packages/image/README.md

1.11.74.3 KB
Original Source

Image 图片

介绍

增强版的 img 标签，提供多种图片填充模式，支持图片懒加载、加载中提示、加载失败提示。

引入

在app.json或index.json中引入组件，详细介绍见快速上手。

json
"usingComponents": {
  "van-image": "@vant/weapp/image/index"
}

Vant Weapp 1.0 版本开始支持此组件，升级方式参见快速上手。

代码演示

基础用法

基础用法与原生 image 标签一致，可以设置src、width、height等原生属性。

html
<van-image width="100" height="100" src="https://img.yzcdn.cn/vant/cat.jpeg" />

填充模式

通过fit属性可以设置图片填充模式，可选值见下方表格。

html
<van-image
  width="10rem"
  height="10rem"
  fit="contain"
  src="https://img.yzcdn.cn/vant/cat.jpeg"
/>

圆形图片

通过round属性可以设置图片变圆，注意当图片宽高不相等且fit为contain或scale-down时，将无法填充一个完整的圆形。

html
<van-image
  round
  width="10rem"
  height="10rem"
  src="https://img.yzcdn.cn/vant/cat.jpeg"
/>

图片懒加载

图片懒加载，在即将进入一定范围（上下三屏）时才开始加载。

html
<van-image
  width="100"
  height="100"
  lazy-load
  src="https://img.yzcdn.cn/vant/cat.jpeg"
/>

加载中提示

Image组件提供了默认的加载中提示，支持通过loading插槽自定义内容。

html
<van-image use-loading-slot>
  <van-loading slot="loading" type="spinner" size="20" vertical />
</van-image>

加载失败提示

Image组件提供了默认的加载失败提示，支持通过error插槽自定义内容。

html
<van-image use-error-slot>
  <text slot="error">加载失败</text>
</van-image>

API

Props

参数说明类型默认值
src图片链接string-
fit图片填充模式stringfill
alt替代文本string-
width宽度，默认单位为pxstring | number-
height高度，默认单位为pxstring | number-
radius圆角大小，默认单位为pxstring | number0
round是否显示为圆形booleanfalse
lazy-load是否懒加载booleanfalse
webp v1.10.11是否解析 webp 格式booleanfalse
show-error是否展示图片加载失败提示booleantrue
show-loading是否展示图片加载中提示booleantrue
use-error-slot是否使用 error 插槽booleanfalse
use-loading-slot是否使用 loading 插槽booleanfalse
show-menu-by-longpress是否开启长按图片显示识别小程序码菜单booleanfalse

图片填充模式 

名称含义
contain保持宽高缩放图片，使图片的长边能完全显示出来
cover保持宽高缩放图片，使图片的短边能完全显示出来，裁剪长边
fill拉伸图片，使图片填满元素
widthFix缩放模式，宽度不变，高度自动变化，保持原图宽高比不变
heightFix缩放模式，高度不变，宽度自动变化，保持原图宽高比不变
none保持图片原有尺寸

Events

事件名说明回调参数
bind:click点击图片时触发event: Event
bind:load图片加载完毕时触发event: Event
bind:error图片加载失败时触发event: Event

Slots

名称说明
loading自定义加载中的提示内容
error自定义加载失败时的提示内容

外部样式类

类名说明
custom-class根节点样式类
image-class图片样式类
loading-classloading 样式类
error-classerror 样式类