FaImage 图片
默认启用懒加载、图片预览和 Teleport,并提供团队图片地址转换与完整 Viewer 插槽。
自 2.0.28 起,preview-src-list 可传入多张原图,未提供有效列表时使用 src。preview=false 关闭预览。#viewerPlaceholder 和 #viewerError 分别用于预览加载中和加载失败,均接收 { activeIndex, src }。从 2.0.27 升级时,将 #viewer-error 改为 #viewerError。
图片适应、预览与错误插槽
可操作示例查看代码
<template>
<div class="demo-image-grid">
<div>
<FaImage :src="image" original fit="cover" style="width: 100%; height: 140px" />
<span>{{ english ? "Cover · click to preview" : "Cover · 点击预览" }}</span>
</div>
<div><FaImage :src="image" original fit="contain" style="width: 100%; height: 140px" /><span>Contain</span></div>
<div>
<FaImage src="data:image/png;base64,AA==" original :preview="false" style="width: 100%; height: 140px">
<template #error
><div class="demo-image-error">{{ english ? "Custom image error" : "自定义加载失败" }}</div></template
>
</FaImage>
<span>{{ english ? "Error slot" : "错误插槽" }}</span>
</div>
</div>
</template>
<script setup lang="ts">
import { computed } from "vue";
const props = defineProps<{ language?: string }>();
const english = computed(() => props.language === "en-US");
const image = `data:image/svg+xml;charset=UTF-8,${encodeURIComponent(
'<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 360"><defs><linearGradient id="g"><stop stop-color="#409eff"/><stop offset="1" stop-color="#36cfc9"/></linearGradient></defs><rect width="640" height="360" fill="url(#g)"/><circle cx="500" cy="80" r="45" fill="#fff" opacity=".65"/><text x="48" y="205" font-size="54" fill="white">Fast.Element.Plus</text></svg>'
)}`;
</script>FaImage 完整 API
Props 属性
EL 默认值取自导入 Fast 前的 Element Plus。 2.14.7
| 属性 | 来源 | 说明 | 类型 | 默认值 |
|---|---|---|---|---|
hideOnClickModal | Fast 修改 | 点击图片预览遮罩时是否关闭预览。 | Boolean | FasttrueELfalse |
src | Fast 修改 | 图片地址或 Base64 图片内容。 | String | Fast""EL"" |
lazy | Fast 修改 | 是否启用懒加载。 | Boolean | FasttrueELfalse |
previewSrcList | Fast 修改 | 图片预览列表。 | Array | Fast[]EL[] |
previewTeleported | Fast 修改 | 图片预览层是否挂载到 body。 | Boolean | FasttrueELfalse |
base64 | Fast 新增 | 将值作为 Base64 图片内容。 | Boolean | false |
original | Fast 新增 | 使用原始图片地址。 | Boolean | false |
normal | Fast 新增 | 使用标准图地址后缀。 | Boolean | false |
small | Fast 新增 | 使用小图地址后缀。 | Boolean | false |
thumb | Fast 新增 | 使用缩略图地址后缀。 | Boolean | false |
preview | Fast 新增 | 是否允许图片预览。 | Boolean | true |
fit | EL 原生 | 内容如何适应容器。 | String | "" |
loading | EL 原生 | 加载状态。 | String | — |
scrollContainer | EL 原生 | 图片懒加载时监听滚动的容器。 | String / Object | — |
zIndex | EL 原生 | 图片预览层的 CSS z-index。 | Number | — |
initialIndex | EL 原生 | 打开预览时的图片下标,须小于图片列表长度。 | Number | 0 |
infinite | EL 原生 | 预览时是否在首尾图片之间循环切换。 | Boolean | true |
closeOnPressEscape | EL 原生 | 是否允许按 Esc 关闭图片预览。 | Boolean | true |
zoomRate | EL 原生 | 每次缩放时使用的倍率。 | Number | 1.2 |
scale | EL 原生 | 图片预览打开时的缩放比例。 | Number | 1 |
minScale | EL 原生 | 图片预览的最小缩放比例。 | Number | 0.2 |
maxScale | EL 原生 | 图片预览的最大缩放比例。 | Number | 7 |
showProgress | EL 原生 | 是否显示当前图片的预览进度。 | Boolean | false |
crossorigin | EL 原生 | 图片的原生 crossorigin 属性。 | String | — |
Events 事件
| 名称 | 来源 | 说明 | 参数 / 类型 |
|---|---|---|---|
load | EL 原生 | 资源加载成功时触发。 | — |
error | EL 原生 | 资源加载或组件处理失败时触发。 | — |
switch | EL 原生 | 图片预览器切换当前图片时触发。 | — |
close | EL 原生 | 关闭流程完成时触发。 | — |
show | EL 原生 | 图片预览器显示时触发。 | — |
Slots 插槽
| 名称 | 来源 | 说明 | 参数 / 类型 |
|---|---|---|---|
placeholder | EL 原生 | 图片加载过程中的占位内容。 | — |
error | EL 原生 | 表单校验错误或图片加载失败时的自定义内容。 | — |
viewer({ src }) | EL 原生 | 自定义图片预览器内容。 | ({ src }) |
progress | EL 原生 | 自定义图片加载进度内容。 | — |
toolbar | EL 原生 | 自定义图片预览工具栏。 | — |
viewer-error | EL 原生 | 图片预览器加载失败时的自定义内容。 | — |
image viewer slots | EL 原生 · 未透传 | 启用大图预览后,可使用查看器除 default 外的插槽。 | — |
实例成员
| 名称 | 来源 | 说明 | 参数 / 类型 |
|---|---|---|---|
showPreview | EL 原生 | 打开 ElImage 图片预览器。 | — |
FaImage 实例方法
以下代码为调用片段。行、选项和字段应对应实际数据。
showPreview 预览
手动打开图片预览。
签名
ts
showPreview(): void;示例
vue
<template>
<FaImage ref="componentRef" />
<button type="button" @click="handleExample">调用方法</button>
</template>
<script setup lang="ts">
import { ref } from "vue";
import { FaImage } from "fast-element-plus";
const componentRef = ref<InstanceType<typeof FaImage>>();
function handleExample() {
componentRef.value?.showPreview();
}
</script>输入: 无参数。
返回: void。
