Appearance
xtf-drawer
组件说明
xtf-drawer 是抽屉,用于从屏幕边缘展开补充内容或操作。当前实现由 show 控制显示、通过 update:show 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-drawer/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfDrawer title="账单详情" :show="true">
<text class="doc-content-text">示例内容</text>
</XtfDrawer>
</view>
</template>
<script setup lang="uts">
import XtfDrawer from "@/uni_modules/xtf-linkuiunix/components/xtf-drawer/xtf-drawer.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">
<XtfDrawer title="账单详情" :show="true" @open="onPrimaryEvent">
<text class="doc-content-text">示例内容</text>
</XtfDrawer>
</view>
</template>
<script setup lang="uts">
import XtfDrawer from "@/uni_modules/xtf-linkuiunix/components/xtf-drawer/xtf-drawer.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-drawer: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,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfDrawer title="账单详情" :show="state">
<text class="doc-content-text">示例内容</text>
</XtfDrawer>
<button class="doc-action-button" @click="toggleState">切换 show</button>
<text class="doc-state-text">show: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfDrawer from "@/uni_modules/xtf-linkuiunix/components/xtf-drawer/xtf-drawer.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 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfDrawer title="账单详情" :show="true">
<template #default><text class="doc-content-text">自定义 default 内容</text></template>
</XtfDrawer>
</view>
</template>
<script setup lang="uts">
import XtfDrawer from "@/uni_modules/xtf-linkuiunix/components/xtf-drawer/xtf-drawer.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。
vue
<template>
<view class="doc-method">
<XtfDrawer title="账单详情" :show="true" ref="componentRef">
<text class="doc-content-text">示例内容</text>
</XtfDrawer>
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfDrawer from "@/uni_modules/xtf-linkuiunix/components/xtf-drawer/xtf-drawer.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 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 21 | 需要控制显示、可用性或交互状态时设置。 |
modelValue | boolean | undefined | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 21 | 需要覆盖组件默认业务值时设置。 |
title | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:template 行 10、template 行 11 | 需要提供业务文案或图标内容时设置。 |
position | string | "right" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 22 | 需要覆盖组件默认业务值时设置。 |
size | string | "" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 45、script 行 46、script 行 47 | 需要覆盖组件默认业务值时设置。 |
width | string | number | "78vw" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 43 | 需要覆盖组件默认业务值时设置。 |
height | string | number | "100%" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 44 | 需要覆盖组件默认业务值时设置。 |
overlay | boolean | true | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 2、template 行 6 | 需要控制显示、可用性或交互状态时设置。 |
closeable | boolean | true | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 10、template 行 12 | 需要覆盖组件默认业务值时设置。 |
closeIcon | string | "" | 设置对应区域的图标名称;消费位置:template 行 13 | 需要提供业务文案或图标内容时设置。 |
closeOnClickOverlay | boolean | string | true | 开关对应显示或交互行为;消费位置:script 行 24 | 需要覆盖组件默认业务值时设置。 |
zIndex | string | number | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 26 | 需要覆盖组件默认业务值时设置。 |
duration | string | number | 320 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 27 | 需要覆盖组件默认业务值时设置。 |
round | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3 | 需要覆盖组件默认业务值时设置。 |
showHandle | boolean | string | null | null | 开关对应显示或交互行为;消费位置:script 行 25 | 需要控制显示、可用性或交互状态时设置。 |
beforeClose | (payload: UTSJSONObject) => boolean | null | 提供源码调用的业务回调,参数和返回值以类型列为准;消费位置:script 行 72、template 行 4 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
radius | string | number | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 58 | 需要覆盖组件默认业务值时设置。 |
shadow | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 59 | 需要覆盖组件默认业务值时设置。 |
headerPadding | string | number | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 62 | 需要覆盖组件默认业务值时设置。 |
bodyPadding | string | number | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 63 | 需要覆盖组件默认业务值时设置。 |
headerBorder | boolean | string | true | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 62 | 需要覆盖组件默认业务值时设置。 |
overlayStyle | string | "" | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 5 | 需要调整布局或视觉表现时设置。 |
popupClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 28 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 9 | 需要调整布局或视觉表现时设置。 |
customStyle | any | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 60 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:show | handleVisible 内触发(script 行 66);参数表达式:value;前置 guard:value == visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | handleVisible 内触发(script 行 67);参数表达式:value;前置 guard:value == visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
open | 模板行 7 透传子组件事件;参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
opened | 模板行 8 透传子组件事件;参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
close | 模板行 8 透传子组件事件;参数表达式:$event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
closed | 模板行 8 透传子组件事件;参数表达式:$event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
default | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
footer | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件;通过组件 ref 调用,参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件;通过组件 ref 调用,参数和返回值按签名处理。 |
toggle | toggle(): void | 调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-popup-bg):组件样式实际读取的主题变量,可在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。