<image>

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

注意: 在代码中请使用 <image> 标签, <img> 的存在只是因为兼容性原因,在将来的版本中可能删除。

注意: jsn 没有内置的图片库,因为一些开源项目如 SDWebImagePicasso已经能很好的解决这个问题, 所以在使用 <image> 之前,请在 native 侧先接入相应的 adapter 或者 handler。

基本用法

注意: width, heightsrc必须被提供,否则图片无法渲染。

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

子组件

<image>不支持子组件。

样式

支持通用样式

属性

属性名 类型 默认值
placeholder String {URL / Base64} -
resize String cover / contain / stretch stretch
src String {URL / Base64 } -
ignorevisibility String true / false -

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

placeholder

占位图的 URL,在图片下载过程中将展示占位图,图片下载完成后将显示src中指定的图片。

resize

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

resize属性和[background-size]的理念很相似。

src

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

支持的图片格式

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

Note: Android 默认的Image Adapter不支持 gif。

ignorevisibility

图片元素渲染时在可见区域之外的情况下,可能会导致不显示的问题,设置ignorevisibilitytrue,能在加载时正常显示,仅在H5环境下有效

Component 方法

save v0.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) :

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

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

const $image = this.$refs.poster
$image.save(result => {
if (result.success) {
// Do something to hanlde success
} else {
console.log(result.errorDesc)
// Do something to hanlde failure
}
})

事件

支持 通用事件

load

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

事件对象:

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

处理 load 事件

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

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

增加事件处理函数:

export default {
methods: {
onImageLoad (event) {
if (event.success) {
// Do something to hanlde success
}
}
}
}

使用说明

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