image

<image> 用于在界面中显示单个图片。

注意:在HTML中通常使用的 <img> 标签在 Weex 中不支持,你应该使用<image>

注意: Weex 没有内置的图片下载器,因为相关的下载、缓存、解码机制非常复杂,一些开源的工具如 SDWebImage 已经处理得很好, 所以在使用 <image> 之前,请在 native 侧先接入相应的 adapter 或者 handler。

参见: Android adapteriOS handler

基本用法

注意: 必须指定样式中的宽度和高度,否则无法工作。

  1. <imagestyle="width:500px;height:500px"src="https://vuejs.org/images/logo.png"></image>

参见示例

属性

属性名类型默认值
placeholderString{URL / Base64}-
resizeStringconver / contain / stretchstretch
srcString{URL / Base64 }-

注意:您可以指定一个相对 bundle URL 的相对路径,相对路径将被重写为绝对资源路径(本地或远程)。参见: 资源路径

placeholder

占位图的 URL,当由 src 表示的图片下载完成并展示后将被删除。 (示例)

resize

image-resize-property.png

  • contain:缩放图片以完全装入<image>区域,可能背景区部分空白。 (示例)
  • cover:缩放图片以完全覆盖<image>区域,可能图片部分看不见。 (示例)
  • stretch默认值. 按照<image>区域的宽高比例缩放图片。(示例)

参见: background-size.

src

要显示图片的 URL,该属性是 <image> 组件的强制属性。

支持的图片格式

Weex没有提供必须支持的图片格式列表,主要依赖于你正在使用的图片 adapter 或者 handler。例如,如果你使用 SDWebImage 作为iOS上的图片 handler,你可以使用像 JPEG、PNG、GIF、WebP 等图片格式。

Component 方法

v0.16.0+" class="reference-link">savev0.16.0+

保存图片内容到本地文件或相册,此操作可能需要设备相关权限。

参数:

  • callback:{Function} 在图片被写入到本地文件或相册后的回调,回调参数:
    • result:{Object} 回调结果对象,属性列表:
      • success:{Boolean} 标记图片是否已写入完成。
      • errorDesc:{String} 如果图像没有成功写入,该字符串包含了详细的错误描述。

返回值: null

注意: 你必须加入NSPhotoLibraryAddUsageDescriptionNSPhotoLibraryAddUsageDescription (iOS 11) 以获得访问 iOS 系统相册权限. 参见: Cocoa Keys

使用 save 方法

<image>标签上增加 ref 属性 (Vue.js Child Component Refs) :

  1. <imageref="poster"src="path/to/image.png"></image>

获取组件引用并使用 save 方法:

  1. const $image =this.$refs.poster
  2. $image.save(result =>{
  3. if(result.success){
  4. // Do something to hanlde success
  5. }else{
  6. console.log(result.errorDesc)
  7. // Do something to hanlde failure
  8. }
  9. })

参见 完整例子.

事件

支持 通用事件.

load

当加载完成 src 指定的图片时,load事件将被触发。

事件对象:

  • success: {Boolean} 标记图片是否成功加载。
  • size: {Object} 加载的图片大小对象,属性列表:
    • naturalWidth: {Number} 图片宽度,如果图片加载失败则为0。
    • naturalHeight: {Number} 图片高度,如果图片加载失败则为0。

处理 load 事件

<image> 标签上绑定 load 事件:

  1. <image @load="onImageLoad"src="path/to/image.png"></image>

增加事件处理函数:

  1. exportdefault{
  2. methods:{
  3. onImageLoad (event){
  4. if(event.success){
  5. // Do something to hanlde success
  6. }
  7. }
  8. }
  9. }

参见完整示例

样式

支持通用样式

使用说明

  • 在使用 <image> 之前,请在 native 侧先接入相应的 adapter 或者 handler。
  • <image> 必须指定样式中的宽度和高度。
  • <image> 不支持内嵌子组件。

示例