Skip to content

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 默认值实际行为 / 范围适用范围
showbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 21需要控制显示、可用性或交互状态时设置。
modelValuebooleanundefined参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 21需要覆盖组件默认业务值时设置。
titlestring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:template 行 10、template 行 11需要提供业务文案或图标内容时设置。
positionstring"right"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 22需要覆盖组件默认业务值时设置。
sizestring""参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 45、script 行 46、script 行 47需要覆盖组件默认业务值时设置。
widthstring | number"78vw"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 43需要覆盖组件默认业务值时设置。
heightstring | number"100%"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 44需要覆盖组件默认业务值时设置。
overlaybooleantrue参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 2、template 行 6需要控制显示、可用性或交互状态时设置。
closeablebooleantrue参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 10、template 行 12需要覆盖组件默认业务值时设置。
closeIconstring""设置对应区域的图标名称;消费位置:template 行 13需要提供业务文案或图标内容时设置。
closeOnClickOverlayboolean | stringtrue开关对应显示或交互行为;消费位置:script 行 24需要覆盖组件默认业务值时设置。
zIndexstring | number""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 26需要覆盖组件默认业务值时设置。
durationstring | number320参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 27需要覆盖组件默认业务值时设置。
roundbooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3需要覆盖组件默认业务值时设置。
showHandleboolean | string | nullnull开关对应显示或交互行为;消费位置:script 行 25需要控制显示、可用性或交互状态时设置。
beforeClose(payload: UTSJSONObject) => booleannull提供源码调用的业务回调,参数和返回值以类型列为准;消费位置:script 行 72、template 行 4需要接入业务守卫、转换或过滤逻辑时设置。
radiusstring | number""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 58需要覆盖组件默认业务值时设置。
shadowstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 59需要覆盖组件默认业务值时设置。
headerPaddingstring | number""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 62需要覆盖组件默认业务值时设置。
bodyPaddingstring | number""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 63需要覆盖组件默认业务值时设置。
headerBorderboolean | stringtrue参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 62需要覆盖组件默认业务值时设置。
overlayStylestring""覆盖或追加对应内部区域的样式对象;消费位置:template 行 5需要调整布局或视觉表现时设置。
popupClassstring""追加到对应内部区域的 class;消费位置:script 行 28需要调整布局或视觉表现时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 9需要调整布局或视觉表现时设置。
customStyleany""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 60需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
update:showhandleVisible 内触发(script 行 66);参数表达式:value;前置 guard:value == visible.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValuehandleVisible 内触发(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> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
openopen(): void打开组件;通过组件 ref 调用,参数和返回值按签名处理。
closeclose(): void请求关闭组件;通过组件 ref 调用,参数和返回值按签名处理。
toggletoggle(): 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。

MIT Licensed