xtf-home-sheet

组件说明

xtf-home-sheet 是主页底部面板，用于承载可展开的底部主页内容。当前实现通过 update:modelValue 等事件反馈交互、提供实例方法。

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

---

基础用法

1. 最小可用

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

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

<script setup lang="uts">
import XtfHomeSheet from "@/uni_modules/xtf-linkuiunix/components/xtf-home-sheet/xtf-home-sheet.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">
    <XtfHomeSheet @change="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfHomeSheet>
  </view>
</template>

<script setup lang="uts">
import XtfHomeSheet from "@/uni_modules/xtf-linkuiunix/components/xtf-home-sheet/xtf-home-sheet.uvue"

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

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

3. 动态 draggable 状态

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

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

<script setup lang="uts">
import XtfHomeSheet from "@/uni_modules/xtf-linkuiunix/components/xtf-home-sheet/xtf-home-sheet.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("draggable", 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. 定制 handle 插槽

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

<template>
  <view class="doc-slot">
    <XtfHomeSheet >
      <template #handle><text class="doc-content-text">自定义 handle 内容</text></template>
    </XtfHomeSheet>
  </view>
</template>

<script setup lang="uts">
import XtfHomeSheet from "@/uni_modules/xtf-linkuiunix/components/xtf-home-sheet/xtf-home-sheet.uvue"

</script>

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

5. 调用 collapse()

调用该公开实例能力；签名为 collapse(): void。

<template>
  <view class="doc-method">
    <XtfHomeSheet ref="componentRef">
      <text class="doc-content-text">示例内容</text>
    </XtfHomeSheet>
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

<script setup lang="uts">
import XtfHomeSheet from "@/uni_modules/xtf-linkuiunix/components/xtf-home-sheet/xtf-home-sheet.uvue"

import { ref } from "vue"

const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.collapse(); console.log("调用 collapse") }
</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 默认值	实际行为 / 范围	适用范围
modelValue	number	1	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 22、script 行 52、script 行 53	需要覆盖组件默认业务值时设置。
stops	number[]	() => [0.22, 0.48, 0.88] as number[]	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 16	需要覆盖组件默认业务值时设置。
topInset	number	24	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 10	需要覆盖组件默认业务值时设置。
duration	number	240	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 76	需要覆盖组件默认业务值时设置。
draggable	boolean	true	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 24、script 行 83	需要覆盖组件默认业务值时设置。
maskClosable	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 86	需要覆盖组件默认业务值时设置。
lockScrollUntilExpanded	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 21	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。
customStyle	UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
update:modelValue	setup 内触发（script 行 22）；参数表达式：next refreshLayout 内触发（script 行 48）；参数表达式：next；前置 guard：disposed setup 内触发（script 行 53）；参数表达式：activeIndex.value snapTo 内触发（script 行 79）；参数表达式：next；前置 guard：disposed	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
change	refreshLayout 内触发（script 行 48）；参数表达式：next；前置 guard：disposed snapTo 内触发（script 行 79）；参数表达式：next；前置 guard：disposed	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

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

---

方法

实例方法

方法	签名 / 返回值	调用边界
collapse	collapse(): void	调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。
expand	expand(): void	调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。
open	open(index: number = 0): void	打开组件；通过组件 ref 调用，参数和返回值按签名处理。
refresh	refresh(): void	重新计算或刷新；通过组件 ref 调用，参数和返回值按签名处理。

公开状态

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

---

主题说明

• var(--xtf-color-surface)：组件样式实际读取的主题变量，可在 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。