Skip to content

xtf-watermark ​

组件说明 ​

xtf-watermark 是水印,用于在内容区域重复绘制文字或图片标记。当前实现通过 image-load 等事件反馈交互。

  • 实际 Demo 路由:#/pages/components/xtf-watermark/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfWatermark text="示例内容">
      <text class="doc-content-text">示例内容</text>
    </XtfWatermark>
  </view>
</template>

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

</script>

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

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

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

vue
<template>
  <view class="doc-core">
    <XtfWatermark text="示例内容" @image-load="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfWatermark>
  </view>
</template>

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

function onPrimaryEvent(payload: any): void { console.log("xtf-watermark:image-load", payload) }
</script>

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

3. 动态 showTimestamp 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfWatermark text="示例内容" :show-timestamp="state">
      <text class="doc-content-text">示例内容</text>
    </XtfWatermark>
    <button class="doc-action-button" @click="toggleState">切换 showTimestamp</button>
    <text class="doc-state-text">showTimestamp: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("showTimestamp", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.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">
    <XtfWatermark text="示例内容">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfWatermark>
  </view>
</template>

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

</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
textstring"ULink UI"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 91需要提供业务文案或图标内容时设置。
secondaryTextstring""设置对应区域的显示文案;消费位置:script 行 92需要提供业务文案或图标内容时设置。
imageSrcstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 35需要覆盖组件默认业务值时设置。
opacitystring | number0.28参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 85需要覆盖组件默认业务值时设置。
densitystring"md"参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 82、script 行 83需要覆盖组件默认业务值时设置。
showTimestampbooleanfalse开关对应显示或交互行为;消费位置:script 行 93需要控制显示、可用性或交互状态时设置。
timestampTextstring""设置对应区域的显示文案;消费位置:script 行 33需要提供业务文案或图标内容时设置。
colorstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 86需要覆盖组件默认业务值时设置。
fontSizestring | number24设置对应元素尺寸;消费位置:script 行 84需要调整布局或视觉表现时设置。
fontWeightstring | number600参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 87需要覆盖组件默认业务值时设置。
gapXstring | number""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 100需要覆盖组件默认业务值时设置。
gapYstring | number""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 101需要覆盖组件默认业务值时设置。
directionstring""参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 88需要覆盖组件默认业务值时设置。
rotatenumber-18参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 88需要覆盖组件默认业务值时设置。
zIndexstring | number2参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 106需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
customStylestring | UTSJSONObject""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
image-loadaccept 内触发(script 行 54);参数表达式:{ source };前置 guard:disposed || version != imageVersion、!validImage(data)、disposed || version != imageVersion(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
image-erroraccept 内触发(script 行 46);参数表达式:{ source, reason: "unsupported-or-oversized-image" };前置 guard:disposed || version != imageVersion、!validImage(data)
accept 内触发(script 行 51);参数表达式:{ source, reason: "image-decode-failed" };前置 guard:disposed || version != imageVersion、!validImage(data)
setup 内触发(script 行 74);参数表达式:{ source, reason: String(error) };前置 guard:disposed || version != imageVersion、source.startsWith("data:")、disposed || version != imageVersion
setup 内触发(script 行 78);参数表达式:{ source, reason: "native-requires-raster-data-uri" };前置 guard:disposed || version != imageVersion、source.startsWith("data:")、disposed || version != imageVersion
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

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

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • 当前组件 CSS 未读取 var(--xtf-*) 主题变量;颜色或尺寸可能来自 props、固定样式或父级上下文。

平台与实现边界 ​

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

MIT Licensed