Image 图片

介绍

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

引入

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

  1. import { createApp } from 'vue';
  2. import { Image as VanImage } from 'vant';
  3. const app = createApp();
  4. app.use(VanImage);

代码演示

基础用法

基础用法与原生 img 标签一致,可以设置 srcwidthheightalt 等原生属性。

  1. <van-image
  2. width="100"
  3. height="100"
  4. src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg"
  5. />

填充模式

通过 fit 属性可以设置图片填充模式,等同于原生的 object-fit 属性,可选值见下方表格。

  1. <van-image
  2. width="10rem"
  3. height="10rem"
  4. fit="contain"
  5. src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg"
  6. />

图片位置

通过 position 属性可以设置图片位置,结合 fit 属性使用,等同于原生的 object-position 属性。

  1. <van-image
  2. width="10rem"
  3. height="10rem"
  4. fit="cover"
  5. position="left"
  6. src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg"
  7. />

圆形图片

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

  1. <van-image
  2. round
  3. width="10rem"
  4. height="10rem"
  5. src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg"
  6. />

图片懒加载

设置 lazy-load 属性来开启图片懒加载,需要搭配 Lazyload 组件使用。

  1. <van-image
  2. width="100"
  3. height="100"
  4. lazy-load
  5. src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg"
  6. />
  1. import { createApp } from 'vue';
  2. import { Lazyload } from 'vant';
  3. const app = createApp();
  4. app.use(Lazyload);

加载中提示

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

  1. <van-image src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg">
  2. <template v-slot:loading>
  3. <van-loading type="spinner" size="20" />
  4. </template>
  5. </van-image>

加载失败提示

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

  1. <van-image src="https://fastly.jsdelivr.net/npm/@vant/assets/cat.jpeg">
  2. <template v-slot:error>加载失败</template>
  3. </van-image>

API

Props

参数说明类型默认值
src图片链接string-
fit图片填充模式,等同于原生的 object-fit 属性stringfill
position v3.4.2图片位置,等同于原生的 object-position 属性,可选值为 top right bottom leftstringstringcenter
alt替代文本string-
width宽度,默认单位为 pxnumber | string-
height高度,默认单位为 pxnumber | string-
radius圆角大小,默认单位为 pxnumber | string0
round是否显示为圆形booleanfalse
block 3.6.3是否将根节点设置为块级元素,默认情况下为 inline-block 元素booleanfalse
lazy-load是否开启图片懒加载,须配合 Lazyload 组件使用booleanfalse
show-error是否展示图片加载失败提示booleantrue
show-loading是否展示图片加载中提示booleantrue
error-icon失败时提示的图标名称或图片链接,等同于 Icon 组件的 name 属性stringphoto-fail
loading-icon加载时提示的图标名称或图片链接,等同于 Icon 组件的 name 属性stringphoto
icon-size v3.0.11加载图标和失败图标的大小number | string32px
icon-prefix图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringvan-icon

图片填充模式

名称含义
contain保持宽高缩放图片,使图片的长边能完全显示出来
cover保持宽高缩放图片,使图片的短边能完全显示出来,裁剪长边
fill拉伸图片,使图片填满元素
none保持图片原有尺寸
scale-downnonecontain 中较小的一个

Events

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

Slots

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

类型定义

组件导出以下类型定义:

  1. import type { ImageFit, ImagePosition, ImageProps } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-image-placeholder-text-colorvar(—van-text-color-2)-
—van-image-placeholder-font-sizevar(—van-font-size-md)-
—van-image-placeholder-background-colorvar(—van-background-color)-
—van-image-loading-icon-size32px-
—van-image-loading-icon-colorvar(—van-gray-4)-
—van-image-error-icon-size32px-
—van-image-error-icon-colorvar(—van-gray-4)-

常见问题

如何引用本地图片?

在 .vue 文件中通过相对路径引用本地图片时,需要在图片的链接外包上一层 require(),将图片 URL 转换为 webpack 模块请求,并结合 file-loader 或者 url-loader 进行处理。

  1. <!-- 错误写法 -->
  2. <van-image src="./image.png" />
  3. <!-- 正确写法 -->
  4. <van-image :src="require('./image.png')" />

对此更详细的解释可以参考 vue-loader 的处理资源路径章节。

使用 image 标签无法渲染?

使用 Image 组件时,可能会遇到将 <image> 作为标签名时无法渲染的问题,比如下面的写法:

  1. <template>
  2. <image src="xxx" />
  3. </template>
  4. <script>
  5. import { Image } from 'vant';
  6. export default {
  7. components: {
  8. Image,
  9. },
  10. };
  11. <script>

这是因为 <image> 标签是原生的 SVG 标签,Vue 不允许将原生标签名注册为组件名,使用 <van-image> 即可规避这个问题。

Image 图片 - 图1