图片容器,在保留所有原生 img 的特性下,支持懒加载,自定义占位、加载失败等
基础用法#
可通过fit确定图片如何适应到容器框,同原生 object-fit。
fill
contain
cover
none
scale-down
占位内容#
可通过slot = placeholder可自定义占位内容
Default
FAILED
Custom
FAILED
加载失败#
可通过slot = error可自定义加载失败内容
Default
FAILED
Custom
懒加载#
TIP
浏览器原生支持的 loading属性在 2.2.3版本加入。 您可以使用 loading="lazy" 替换之前的lazy= true。
如果当前浏览器支持原生图片延迟加载,则先使用原生能力,否则将使用滚动监听实现相同效果。
可通过lazy开启懒加载功能, 当图片滚动到可视范围内才会加载。 可通过 scroll-container 来设置滚动容器, 若未定义,则为最近一个 overflow 值为 auto 或 scroll 的父元素。
图片预览#
可通过 previewSrcList 开启预览大图的功能。 你可以通过 initial-index 初始化第一张预览图片的位置。 默认初始位置为 0。
Image API#
Image Attributes#
| 属性名 | 说明 | 类型 | 默认值 |
| src | 图片源地址,同原生属性一致 | string |
'' |
| fit | 确定图片如何适应容器框,同原生 object-fit | enum |
'' |
| hide-on-click-modal | 当开启 preview 功能时,是否可以通过点击遮罩层关闭 preview | boolean |
false |
| loading 2.2.3 | 浏览器加载图像的策略,和 浏览器原生能力一致 | enum |
— |
| lazy | 是否使用懒加载 | boolean |
false |
| scroll-container | 开启懒加载功能后,监听 scroll 事件的容器 默认情况下,开启懒加载功能后,监听 scroll 事件的容器 | string / object |
— |
| alt | 原生属性 alt |
string |
— |
| referrerpolicy | 原生属性 referrerPolicy。 | string |
— |
| crossorigin | 原生属性 crossorigin | enum |
'anonymous' |
| preview-src-list | 开启图片预览功能 | object |
[] |
| z-index | 设置图片预览的 z-index | number |
— |
| initial-index | 初始预览图像索引,小于 url-list 的长度 |
number |
0 |
| close-on-press-escape | 是否可以通过按下 ESC 关闭 Image Viewer | boolean |
true |
| preview-teleported | image-viewer 是否插入至 body 元素上。 嵌套的父元素属性会发生修改时应该将此属性设置为 true |
boolean |
false |
| infinite | 是否可以无限循环预览 | boolean |
true |
| zoom-rate | 图像查看器缩放事件的缩放速率。 | number |
1.2 |
| min-scale 2.4.0 | 图像查看器缩放事件的最小缩放比例 | number |
0.2 |
| max-scale 2.4.0 | 图像查看器缩放事件的最大缩放比例 | number |
7 |
Image Events#
| 事件名 | 说明 | 类型 |
| load | 图片加载成功触发 | Function |
| error | 图片加载失败触发 | Function |
| switch | 切换图像时触发。 | Function |
| close | 当点击 X 按钮或者在hide-on-click-modal为 true 时点击遮罩层时触发 |
Function |
| show | 当 Viewer 显示时触发 | Function |
Image Slots#
| 插槽名 | 说明 |
| placeholder | 当图像尚未加载时,自定义的占位符内容 |
| error | 自定义图像加载失败的内容 |
| viewer | 当图像预览时自定义内容 |
Image Viewer API#
Image Viewer Attributes#
| 属性名 | 说明 | 类型 | 默认值 |
| url-list | 用于预览的图片链接列表 | object |
[] |
| z-index | 预览时遮罩层的 z-index | number / string |
— |
| initial-index | 初始预览图像索引,小于 url-list 的长度 |
number |
0 |
| infinite | 是否可以无限循环预览 | boolean |
true |
| hide-on-click-modal | 是否可以通过点击遮罩层关闭预览 | boolean |
false |
| teleported | image 自身是否插入至 body 元素上。 嵌套的父元素属性会发生修改时应该将此属性设置为 true |
boolean |
false |
| zoom-rate 2.2.27 | 图像查看器缩放事件的缩放速率。 | number |
1.2 |
| min-scale 2.4.0 | 图像查看器缩放事件的最小缩放比例 | number |
0.2 |
| max-scale 2.4.0 | 图像查看器缩放事件的最大缩放比例 | number |
7 |
| close-on-press-escape | 是否可以通过按下 ESC 关闭 Image Viewer | boolean |
true |
Image Viewer Events#
| 事件名 | 说明 | 类型 |
| close | 当点击 X 按钮或者在hide-on-click-modal为 true 时点击遮罩层时触发 |
Function |
| switch | 切换图像时触发。 | Function |
| rotate 2.3.13 | 旋转图像时触发。 | Function |
Image Viewer Exposes#
| Name | 说明 | Type |
| setActiveItem | 手动切换图片 | Function |