Skip to content

Image 图片

13:10

此组件为 uni-app 的image组件的加强版,在继承了原有功能外,还支持淡入动画、加载中、加载失败提示、圆角值和形状等。
我们推荐您在任何使用图片场景的地方,都优先考虑使用这个小巧,精致而实用的组件。

平台差异说明

AppH5微信小程序支付宝小程序百度小程序头条小程序QQ 小程序

基本使用

配置图片的width宽和height高,以及src路径即可使用。

html
<template>
  <u-image width="100%" height="300rpx" :src="src"></u-image>
</template>

<script setup lang="ts">
import { ref } from 'vue'

// 定义响应式数据
const src = ref<string>("https://cdn.uviewui.com/uview/example/fade.jpg");
</script>

填充模式

通过mode参数配置填充模式,此模式用法与 uni-app 的image组件的mode参数完全一致,详见:Image

html
<u-image src="https://cdn.uviewui.com/uview/example/fade.jpg" mode="widthFix"></u-image>

图片形状

  • 通过shape参数设置图片的形状,circle为圆形,square为方形
  • 如果为方形时,还可以通过border-radius参数设置圆角值
html
<u-image src="https://cdn.uviewui.com/uview/example/fade.jpg" shape="circle"></u-image>

懒加载

注意:此功能只对微信小程序、App、百度小程序、字节跳动小程序有效,默认开启。

html
<u-image src="https://cdn.uviewui.com/uview/example/fade.jpg" :lazy-load="true"></u-image>

加载中提示

图片加载过程中,为加载中状态(默认显示一个小图标),可以通过loading自定义插槽,结合 uView 的u-loading组件,实现加载的动画效果。

html
<u-image src="https://cdn.uviewui.com/uview/example/fade.jpg">
  <template #loading>
    <u-loading></u-loading>
  </template>
</u-image>

加载错误提示

图片加载失败时,默认显示一个错误提示图标,可以通过error自定义插槽,实现个性化的提示方式。

html
<u-image src="https://cdn.uviewui.com/uview/example/fade.jpg">
  <template #error>
    <view style="font-size: 24rpx;">加载失败</view>
  </template>
</u-image>

淡入动画

组件自带了加载完成时的淡入动画效果:

  • 通过fade参数配置是否开启动画效果
  • 通过duration参数配置动画的过渡时间,单位 ms
html
<u-image
  src="https://cdn.uviewui.com/uview/example/fade.jpg"
  :fade="true"
  duration="450"
></u-image>

事件冒泡

默认情况下,组件是允许内部向外事件冒泡的,因为很多情况下,我们都希望点击图片,同时图片所在的父元素的点击事件也能触发。
如果您想避免事件冒泡,那么您可以在组件外面嵌套一个view,同时给它加上@tap.stop即可。

html
<!-- 点击图片将不会触发clickHandler -->
<view @tap="clickHandler">
  <view @tap.stop>
    <u-image src="https://cdn.uviewui.com/uview/example/fade.jpg"></u-image>
  </view>
</view>

API

Props

参数说明类型默认值可选值
src图片地址,强烈建议使用绝对或者网络路径String--
mode裁剪模式,见上方说明StringaspectFill-
width宽度,单位任意,如果为数值,则为 rpx 单位String | Number100%-
height高度,单位任意,如果为数值,则为 rpx 单位String | Numberauto-
shape图片形状,circle-圆形,square-方形Stringsquarecircle
border-radius圆角值,单位任意,如果为数值,则为 rpx 单位String | Number0-
lazy-load是否懒加载,仅微信小程序、App、百度小程序、字节跳动小程序有效Booleantrue-
show-menu-by-longpress是否开启长按图片显示识别小程序码菜单,仅微信小程序有效Booleantrue-
loading-icon加载中的图标,或者小图片Stringphoto-
error-icon加载失败的图标,或者小图片Stringerror-circle-
show-loading是否显示加载中的图标或者自定义的 slotBooleantruefalse
show-error是否显示加载错误的图标或者自定义的 slotBooleantruefalse
fade是否需要淡入效果Booleantruefalse
webp只支持网络资源,只对微信小程序有效Booleanfalsetrue
duration搭配fade参数的过渡时间,单位 msString | Number500-
bg-color背景颜色String#f3f4f6-

Slot

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

CellItem Events

事件名说明回调参数
click点击图片时触发-
error图片加载失败时触发err: 错误信息
load图片加载成功时触发-