xtf-popup

组件说明

xtf-popup 是弹出层，用于为底部、居中或侧边浮层提供基础容器。当前实现由 show 控制显示、通过 update:show 等事件反馈交互、提供实例方法。

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

---

基础用法

1. 最小可用

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

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

<script setup lang="uts">
import XtfPopup from "@/uni_modules/xtf-linkuiunix/components/xtf-popup/xtf-popup.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">
    <XtfPopup :show="true" @open="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfPopup>
  </view>
</template>

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

function onPrimaryEvent(payload: any): void { console.log("xtf-popup:open", 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">
    <XtfPopup :show="state">
      <text class="doc-content-text">示例内容</text>
    </XtfPopup>
    <button class="doc-action-button" @click="toggleState">切换 show</button>
    <text class="doc-state-text">show: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfPopup from "@/uni_modules/xtf-linkuiunix/components/xtf-popup/xtf-popup.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. 定制 close-icon 插槽

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

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

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

</script>

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

5. 调用 open()

打开组件；签名为 open(): void。

<template>
  <view class="doc-method">
    <XtfPopup :show="true" ref="componentRef">
      <text class="doc-content-text">示例内容</text>
    </XtfPopup>
    <button class="doc-action-button" @click="callMethod">打开组件</button>
  </view>
</template>

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

import { ref } from "vue"

const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.open(); console.log("调用 open") }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
show	boolean	false	参与组件运行逻辑；源码在 9 处读取该值；消费位置：script 行 26、script 行 27、script 行 81、script 行 115	需要控制显示、可用性或交互状态时设置。
position	string	"center"	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 52	需要覆盖组件默认业务值时设置。
overlay	boolean	true	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 163、template 行 2、template 行 3	需要控制显示、可用性或交互状态时设置。
overlayStyle	string | UTSJSONObject	""	覆盖或追加对应内部区域的样式对象；消费位置：script 行 65	需要调整布局或视觉表现时设置。
closeOnClickOverlay	boolean	true	开关对应显示或交互行为；消费位置：script 行 56	需要覆盖组件默认业务值时设置。
closeOnClickBlank	boolean	false	开关对应显示或交互行为；消费位置：script 行 168	需要覆盖组件默认业务值时设置。
overlayCloseOnlyVisibleRegion	boolean	true	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 166、template 行 2	需要控制显示、可用性或交互状态时设置。
overlayInsetTop	number	0	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 57、script 行 63、script 行 165	需要控制显示、可用性或交互状态时设置。
overlayInsetRight	number	0	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 57、script 行 63、script 行 165	需要控制显示、可用性或交互状态时设置。
overlayInsetBottom	number	0	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 57、script 行 63、script 行 165	需要控制显示、可用性或交互状态时设置。
overlayInsetLeft	number	0	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 57、script 行 63、script 行 165	需要控制显示、可用性或交互状态时设置。
safeAreaInsetBottom	boolean | null	null	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 78	需要覆盖组件默认业务值时设置。
zIndex	number | string	""	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 34	需要覆盖组件默认业务值时设置。
duration	number | string	""	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 35	需要覆盖组件默认业务值时设置。
enterAnimation	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 83	需要覆盖组件默认业务值时设置。
leaveAnimation	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 83	需要覆盖组件默认业务值时设置。
beforeClose	PopupPayloadGuard | PopupSourceGuard	null	提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 141、script 行 143、script 行 144	需要接入业务守卫、转换或过滤逻辑时设置。
beforeCloseMode	"payload" | "source-context"	"payload"	提供源码调用的业务回调，参数和返回值以类型列为准；可选值：payload / source-context；消费位置：script 行 142	需要接入业务守卫、转换或过滤逻辑时设置。
offsetX	number	0	参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 94、script 行 95、script 行 96、script 行 97	需要覆盖组件默认业务值时设置。
offsetY	number	0	参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 94、script 行 95、script 行 96、script 行 97	需要覆盖组件默认业务值时设置。
customGapX	number	0	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 76	需要覆盖组件默认业务值时设置。
customGapY	number	0	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 75	需要覆盖组件默认业务值时设置。
customTop	number	0	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 75	需要覆盖组件默认业务值时设置。
customLeft	number	0	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 76	需要覆盖组件默认业务值时设置。
width	number | string	0	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 71	需要覆盖组件默认业务值时设置。
height	number | string	0	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 72	需要覆盖组件默认业务值时设置。
round	boolean	true	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 54	需要覆盖组件默认业务值时设置。
showClose	boolean	false	开关对应显示或交互行为；消费位置：template 行 9	需要控制显示、可用性或交互状态时设置。
closeIconPosition	string	"top-right"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 9	需要覆盖组件默认业务值时设置。
showHandle	boolean	false	开关对应显示或交互行为；消费位置：template 行 8	需要控制显示、可用性或交互状态时设置。
destroyOnClose	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 128	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 54	需要调整布局或视觉表现时设置。
customStyle	string | UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 79	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
update:show	requestClose 内触发（script 行 152）；参数表达式：false；前置 guard：disposed || !props.show || guardPending || closeSource.length > 0、disposed || version != guardVersion || !props.show、!allowed open 内触发（script 行 171）；参数表达式：true	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
open	openPanel 内触发（script 行 113）；参数表达式：无回调参数	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
opened	setup 内触发（script 行 118）；参数表达式：无回调参数 setup 内触发（script 行 119）；参数表达式：无回调参数；前置 guard：disposed || motionId.value != id || !props.show	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
close	closePanel 内触发（script 行 127）；参数表达式：{ source }；前置 guard：!rendered.value || !containerShown.value	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
closed	finish 内触发（script 行 128）；参数表达式：{ source }；前置 guard：motionId.value != id	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
click-overlay	handleOverlay 内触发（script 行 158）；参数表达式：无回调参数	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
click-close	handleCloseIcon 内触发（script 行 170）；参数表达式：无回调参数	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
blocked-close	requestClose 内触发（script 行 150）；参数表达式：payload；前置 guard：disposed || !props.show || guardPending || closeSource.length > 0、disposed || version != guardVersion || !props.show、!allowed	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

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

---

方法

实例方法

方法	签名 / 返回值	调用边界
open	open(): void	打开组件；通过组件 ref 调用，参数和返回值按签名处理。
close	close(source: string = "api"): Promise<boolean>	请求关闭组件；通过组件 ref 调用，参数和返回值按签名处理。

公开状态

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

---

主题说明

• var(--xtf-color-surface)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-shadow-card)：组件样式实际读取的主题变量，可在 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。