跳到正文

FaImage 图片 ​

默认启用懒加载、图片预览和 Teleport,并提供团队图片地址转换与完整 Viewer 插槽。

自 2.0.28 起,preview-src-list 可传入多张原图,未提供有效列表时使用 src。preview=false 关闭预览。#viewerPlaceholder 和 #viewerError 分别用于预览加载中和加载失败,均接收 { activeIndex, src }。从 2.0.27 升级时,将 #viewer-error 改为 #viewerError。

图片适应、预览与错误插槽

可操作示例
查看代码
Vue
<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

属性来源说明类型默认值
hideOnClickModalFast 修改点击图片预览遮罩时是否关闭预览。BooleanFasttrueELfalse
srcFast 修改图片地址或 Base64 图片内容。StringFast""EL""
lazyFast 修改是否启用懒加载。BooleanFasttrueELfalse
previewSrcListFast 修改图片预览列表。ArrayFast[]EL[]
previewTeleportedFast 修改图片预览层是否挂载到 body。BooleanFasttrueELfalse
base64Fast 新增将值作为 Base64 图片内容。Booleanfalse
originalFast 新增使用原始图片地址。Booleanfalse
normalFast 新增使用标准图地址后缀。Booleanfalse
smallFast 新增使用小图地址后缀。Booleanfalse
thumbFast 新增使用缩略图地址后缀。Booleanfalse
previewFast 新增是否允许图片预览。Booleantrue
fitEL 原生内容如何适应容器。String""
loadingEL 原生加载状态。String—
scrollContainerEL 原生图片懒加载时监听滚动的容器。String / Object—
zIndexEL 原生图片预览层的 CSS z-index。Number—
initialIndexEL 原生打开预览时的图片下标,须小于图片列表长度。Number0
infiniteEL 原生预览时是否在首尾图片之间循环切换。Booleantrue
closeOnPressEscapeEL 原生是否允许按 Esc 关闭图片预览。Booleantrue
zoomRateEL 原生每次缩放时使用的倍率。Number1.2
scaleEL 原生图片预览打开时的缩放比例。Number1
minScaleEL 原生图片预览的最小缩放比例。Number0.2
maxScaleEL 原生图片预览的最大缩放比例。Number7
showProgressEL 原生是否显示当前图片的预览进度。Booleanfalse
crossoriginEL 原生图片的原生 crossorigin 属性。String—

Events 事件

名称来源说明参数 / 类型
loadEL 原生资源加载成功时触发。—
errorEL 原生资源加载或组件处理失败时触发。—
switchEL 原生图片预览器切换当前图片时触发。—
closeEL 原生关闭流程完成时触发。—
showEL 原生图片预览器显示时触发。—

Slots 插槽

名称来源说明参数 / 类型
placeholderEL 原生图片加载过程中的占位内容。—
errorEL 原生表单校验错误或图片加载失败时的自定义内容。—
viewer({ src })EL 原生自定义图片预览器内容。({ src })
progressEL 原生自定义图片加载进度内容。—
toolbarEL 原生自定义图片预览工具栏。—
viewer-errorEL 原生图片预览器加载失败时的自定义内容。—
image viewer slotsEL 原生 · 未透传启用大图预览后,可使用查看器除 default 外的插槽。—

实例成员

名称来源说明参数 / 类型
showPreviewEL 原生打开 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。