xtf-overlay

组件说明

xtf-overlay 是遮罩层，用于覆盖页面并拦截或反馈背景点击。当前实现由 show 控制显示、通过 click 等事件反馈交互。

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

---

基础用法

1. 最小可用

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

<template>
  <view class="doc-minimum">
    <XtfOverlay :show="true">
      <text class="doc-content-text">示例内容</text>
    </XtfOverlay>
  </view>
</template>

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

</script>

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

2. 核心数据与主要事件

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

<template>
  <view class="doc-core">
    <XtfOverlay :show="true" @click="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfOverlay>
  </view>
</template>

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

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

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

3. 动态 show 状态

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

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

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

import { ref } from "vue"

const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", 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 替换对应内容。

<template>
  <view class="doc-slot">
    <XtfOverlay :show="true">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfOverlay>
  </view>
</template>

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

</script>

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

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
show	boolean	false	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 12、script 行 88	需要控制显示、可用性或交互状态时设置。
zIndex	string | number	2000	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 12	需要覆盖组件默认业务值时设置。
opacity	string | number	0.5	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 11	需要覆盖组件默认业务值时设置。
duration	string | number	240	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 74	需要覆盖组件默认业务值时设置。
lockScroll	boolean	true	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 14、script 行 19、script 行 38、script 行 62	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。
customStyle	any	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 12	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
click	handleTap 内触发（script 行 13）；参数表达式：event	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
update:show	仅声明，当前未找到触发路径。	(...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 或方法。
• 仅声明但当前未找到触发路径的事件：update:show。
• 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。