xtf-image

组件说明

xtf-image 是图片，用于展示图片并处理加载、错误和预览状态。当前实现读取 previewList 数据、通过 load 等事件反馈交互。

实际 Demo 路由：#/pages/components/xtf-image/index
Demo 源码

基础用法

1. 最小可用

提供能够直接看到或操作组件的最少业务内容。

vue

<template>
  <view class="doc-minimum">
    <XtfImage placeholder="请输入内容" src="/static/logo.png" :preview-list="fixture" />
  </view>
</template>

<script setup lang="uts">
import XtfImage from "@/uni_modules/xtf-linkuiunix/components/xtf-image/xtf-image.uvue"

const fixture = ['/static/logo.png', '/static/logo.png'] as Array<string>
</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件

使用组件真实数据入口，并记录当前源码声明的主要事件。

vue

<template>
  <view class="doc-core">
    <XtfImage placeholder="请输入内容" src="/static/logo.png" :preview-list="fixture" @load="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfImage from "@/uni_modules/xtf-linkuiunix/components/xtf-image/xtf-image.uvue"

const fixture = ['/static/logo.png', '/static/logo.png'] as Array<string>
function onPrimaryEvent(payload: any): void { console.log("xtf-image:load", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 circle 状态

运行时切换 circle，观察组件对应状态变化。

vue

<template>
  <view class="doc-dynamic">
    <XtfImage placeholder="请输入内容" src="/static/logo.png" :preview-list="fixture" :circle="state" />
    <button class="doc-action-button" @click="toggleState">切换 circle</button>
    <text class="doc-state-text">circle: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfImage from "@/uni_modules/xtf-linkuiunix/components/xtf-image/xtf-image.uvue"

import { ref } from "vue"
const fixture = ['/static/logo.png', '/static/logo.png'] as Array<string>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("circle", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

4. 定制 default 插槽

使用源码真实声明的 default slot 替换对应内容。

vue

<template>
  <view class="doc-slot">
    <XtfImage placeholder="请输入内容" src="/static/logo.png" :preview-list="fixture">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfImage>
  </view>
</template>

<script setup lang="uts">
import XtfImage from "@/uni_modules/xtf-linkuiunix/components/xtf-image/xtf-image.uvue"

const fixture = ['/static/logo.png', '/static/logo.png'] as Array<string>
</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
`src`	`string`	`""`	参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 69、script 行 114、script 行 118、script 行 121	需要覆盖组件默认业务值时设置。
`width`	`string \| number`	`"100%"`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 142、script 行 163	需要覆盖组件默认业务值时设置。
`height`	`string \| number`	`220`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 128、script 行 129、script 行 165	需要覆盖组件默认业务值时设置。
`ratio`	`string \| number`	`""`	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 79、script 行 80、script 行 143	需要覆盖组件默认业务值时设置。
`mode`	`XtfImageMode`	`"cover"`	参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 153	需要覆盖组件默认业务值时设置。
`radius`	`string \| number`	`16`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 92	需要覆盖组件默认业务值时设置。
`radiusTopLeft`	`string \| number`	`""`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 93	需要覆盖组件默认业务值时设置。
`radiusTopRight`	`string \| number`	`""`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 94	需要覆盖组件默认业务值时设置。
`radiusBottomRight`	`string \| number`	`""`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 95	需要覆盖组件默认业务值时设置。
`radiusBottomLeft`	`string \| number`	`""`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 96	需要覆盖组件默认业务值时设置。
`circle`	`boolean`	`false`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 89	需要覆盖组件默认业务值时设置。
`shape`	`XtfImageShape`	`"rounded"`	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 89、script 行 90、script 行 91、script 行 154	需要覆盖组件默认业务值时设置。
`variant`	`XtfImageVariant`	`"default"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 154	需要调整布局或视觉表现时设置。
`bordered`	`boolean`	`false`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 154	需要覆盖组件默认业务值时设置。
`grayscale`	`boolean`	`false`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 154	需要覆盖组件默认业务值时设置。
`lazy`	`boolean`	`false`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 149	需要覆盖组件默认业务值时设置。
`lazyLoad`	`boolean \| null`	`null`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 149	需要覆盖组件默认业务值时设置。
`fadeShow`	`boolean`	`true`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 3	需要覆盖组件默认业务值时设置。
`webp`	`boolean`	`false`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 3	需要覆盖组件默认业务值时设置。
`preview`	`boolean`	`false`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 117	需要覆盖组件默认业务值时设置。
`previewList`	`Array<string>`	`() => [] as Array<string>`	提供组件渲染或选择使用的数据集合；消费位置：script 行 118	数据驱动或选项渲染场景。
`previewCurrent`	`string \| number`	`0`	提供当前受控状态；是否回写以事件表为准；消费位置：script 行 120	需要覆盖组件默认业务值时设置。
`watermark`	`string`	`""`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 10	需要覆盖组件默认业务值时设置。
`fallback`	`string`	`""`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 111	需要覆盖组件默认业务值时设置。
`placeholder`	`string`	`""`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 155、template 行 4	需要提供业务文案或图标内容时设置。
`showLoading`	`boolean`	`true`	开关对应显示或交互行为；消费位置：template 行 5	需要控制显示、可用性或交互状态时设置。
`showError`	`boolean`	`true`	开关对应显示或交互行为；消费位置：template 行 7	需要控制显示、可用性或交互状态时设置。
`errorText`	`string`	`"加载失败，点击重试"`	设置对应区域的显示文案；消费位置：template 行 7	需要提供业务文案或图标内容时设置。
`caption`	`string`	`""`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 151、template 行 8	需要覆盖组件默认业务值时设置。
`desc`	`string`	`""`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 151、template 行 8	需要覆盖组件默认业务值时设置。
`tagText`	`string`	`""`	设置对应区域的显示文案；消费位置：script 行 152、template 行 9	需要提供业务文案或图标内容时设置。
`tagTheme`	`string`	`"primary"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 159	需要覆盖组件默认业务值时设置。
`badgeValue`	`string \| number`	`""`	提供当前受控状态；是否回写以事件表为准；消费位置：script 行 150、template 行 9	需要覆盖组件默认业务值时设置。
`badgeText`	`string`	`""`	设置对应区域的显示文案；消费位置：script 行 150、template 行 9	需要提供业务文案或图标内容时设置。
`badgeDot`	`boolean`	`false`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 150、template 行 9	需要覆盖组件默认业务值时设置。
`badgeTheme`	`"primary" \| "success" \| "warning" \| "danger" \| "info" \| "inverse"`	`"danger"`	参与组件运行逻辑；源码在 1 处读取该值；可选值：primary / success / warning / danger / info / inverse；消费位置：template 行 9	需要覆盖组件默认业务值时设置。
`overlayAlign`	`"left" \| "center" \| "right"`	`"left"`	参与组件运行逻辑；源码在 1 处读取该值；可选值：left / center / right；消费位置：script 行 156	需要控制显示、可用性或交互状态时设置。
`retryable`	`boolean`	`true`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 114	需要覆盖组件默认业务值时设置。
`showMenuByLongpress`	`boolean`	`false`	开关对应显示或交互行为；消费位置：template 行 3	需要控制显示、可用性或交互状态时设置。
`customClass`	`string`	`""`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 154	需要调整布局或视觉表现时设置。
`customStyle`	`UTSJSONObject`	`() => ({} as UTSJSONObject)`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 162	需要调整布局或视觉表现时设置。

事件

事件名称	源码触发边界	回调参数	参数说明
`load`	`handleLoad` 内触发（script 行 107）；参数表达式：`event`；前置 guard：`!isCurrentImageEvent(event)`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`error`	`handleError` 内触发（script 行 110）；参数表达式：`event`；前置 guard：`!isCurrentImageEvent(event)`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`retry`	`retryLoad` 内触发（script 行 114）；参数表达式：`event`；前置 guard：`!props.retryable`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`click`	`handleClick` 内触发（script 行 116）；参数表达式：`event`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`longpress`	`handleLongpress` 内触发（script 行 124）；参数表达式：`event`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`preview`	`handleClick` 内触发（script 行 121）；参数表达式：`{ current, urls, src: props.src }`；前置 guard：`!props.preview`、`urls.length == 0`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

插槽

插槽	Scope 参数	实际渲染位置
`default`	`无 scope 参数`	仅在模板对应 `<slot>` 渲染位置生效。
`error`	`无 scope 参数`	仅在模板对应 `<slot>` 渲染位置生效。
`overlay`	`无 scope 参数`	仅在模板对应 `<slot>` 渲染位置生效。
`top`	`无 scope 参数`	仅在模板对应 `<slot>` 渲染位置生效。

方法

实例方法

方法	签名 / 返回值	调用边界
-	-	当前组件没有公开实例方法。

公开状态

状态	类型 / 包装	读取边界
-	-	当前组件没有公开状态。

主题说明

var(--xtf-color-surface-muted)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。

平台与实现边界

基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
本文按当前源码生成，不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
详细公共边界见平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

xtf-image ​

组件说明 ​

基础用法 ​

1. 最小可用 ​

2. 核心数据与主要事件 ​

3. 动态 circle 状态 ​

4. 定制 default 插槽 ​

全部属性 ​

事件 ​

插槽 ​

方法 ​

实例方法 ​

公开状态 ​

主题说明 ​

平台与实现边界 ​

xtf-image

组件说明

基础用法

1. 最小可用

2. 核心数据与主要事件

3. 动态 circle 状态

4. 定制 default 插槽

全部属性

事件

插槽

方法

实例方法

公开状态

主题说明

平台与实现边界