Skip to main content
Version: 2.x

Image

图片。支持 JPG、PNG、SVG、WEBP、GIF 等格式以及云文件ID。

Note: 为实现小程序的 mode 特性，在 H5 组件中使用一个 div 容器来对内部的 img 进行展示区域的裁剪，因此请勿使用元素选择器来重置 img 的样式！

参考文档

类型​

ComponentType<ImageProps>

示例代码​

export default class PageView extends Component {
  constructor() {
    super(...arguments)
  }

  render() {
    return (
      <View className='components-page'>
        <Image
          style='width: 300px;height: 100px;background: #fff;'
          src='nerv_logo.png'
        />
        <Image
          style='width: 300px;height: 100px;background: #fff;'
          src='https://camo.githubusercontent.com/3e1b76e514b895760055987f164ce6c95935a3aa/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f6d74642f686f6d652f6c6f676f2d3278313531333833373932363730372e706e67'
        />
      </View>
    )
  }
}

ImageProps​

参数类型默认值必填说明
srcstring是图片资源地址
mode"scaleToFill" | "aspectFit" | "aspectFill" | "widthFix" | "heightFix" | "top" | "bottom" | "center" | "left" | "right" | "top left" | "top right" | "bottom left" | "bottom right""scaleToFill"否图片裁剪、缩放的模式
webpbooleanfalse否默认不解析 webP 格式，只支持网络资源
lazyLoadbooleanfalse否图片懒加载。只针对 page 与 scroll-view 下的 image 有效
showMenuByLongpressbooleanfalse否开启长按图片显示识别小程序码菜单
onErrorBaseEventOrigFunction<onErrorEventDetail>否当错误发生时，发布到 AppService 的事件名，事件对象
onLoadBaseEventOrigFunction<onLoadEventDetail>否当图片载入完毕时，发布到 AppService 的事件名，事件对象
imgPropsImgHTMLAttributes<HTMLImageElement>否为 img 标签额外增加的属性

API 支持度​

API微信小程序百度小程序支付宝小程序字节跳动小程序H5React Native
ImageProps.src✔️✔️✔️✔️✔️✔️
ImageProps.mode✔️✔️✔️✔️✔️✔️(部分支持 scaleToFill, aspectFit, aspectFill, widthFix)
ImageProps.webp✔️
ImageProps.lazyLoad✔️✔️✔️✔️✔️
ImageProps.showMenuByLongpress✔️
ImageProps.onError✔️✔️✔️✔️✔️✔️
ImageProps.onLoad✔️✔️✔️✔️✔️✔️
ImageProps.imgProps✔️

mode​

mode 的合法值

参数说明
scaleToFill缩放模式，不保持纵横比缩放图片，使图片的宽高完全拉伸至填满 image 元素
aspectFit缩放模式，保持纵横比缩放图片，使图片的长边能完全显示出来。也就是说，可以完整地将图片显示出来。
aspectFill缩放模式，保持纵横比缩放图片，只保证图片的短边能完全显示出来。也就是说，图片通常只在水平或垂直方向是完整的，另一个方向将会发生截取。
widthFix缩放模式，宽度不变，高度自动变化，保持原图宽高比不变
heightFix缩放模式，高度不变，宽度自动变化，保持原图宽高比不变
top裁剪模式，不缩放图片，只显示图片的顶部区域
bottom裁剪模式，不缩放图片，只显示图片的底部区域
center裁剪模式，不缩放图片，只显示图片的中间区域
left裁剪模式，不缩放图片，只显示图片的左边区域
right裁剪模式，不缩放图片，只显示图片的右边区域
top left裁剪模式，不缩放图片，只显示图片的左上边区域
top right裁剪模式，不缩放图片，只显示图片的右上边区域
bottom left裁剪模式，不缩放图片，只显示图片的左下边区域
bottom right裁剪模式，不缩放图片，只显示图片的右下边区域

onErrorEventDetail​

参数类型说明
errMsgstring错误信息

onLoadEventDetail​

参数类型说明
heightstring | number图片高度
widthstring | number图片宽度

API 支持度​

API微信小程序百度小程序支付宝小程序字节跳动小程序H5React Native
Image✔️✔️✔️✔️✔️✔️