Skip to content

xtf-button ​

组件说明 ​

xtf-button 是按钮,用于承载提交、确认和普通命令操作。当前实现通过 click 等事件反馈交互。

  • 实际 Demo 路由:#/pages/components/xtf-button/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfButton label="保存" />
  </view>
</template>

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

</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件 ​

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

vue
<template>
  <view class="doc-core">
    <XtfButton label="保存" @click="onPrimaryEvent" />
  </view>
</template>

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

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

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 disabled 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfButton label="保存" :disabled="state" />
    <button class="doc-action-button" @click="toggleState">切换 disabled</button>
    <text class="doc-state-text">disabled: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

4. 定制 prefix 插槽 ​

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

vue
<template>
  <view class="doc-slot">
    <XtfButton label="保存">
      <template #prefix><text class="doc-content-text">自定义 prefix 内容</text></template>
    </XtfButton>
  </view>
</template>

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

</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
labelstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 5需要提供业务文案或图标内容时设置。
typeXtfButtonType"solid"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 100需要覆盖组件默认业务值时设置。
themeXtfButtonTheme"primary"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 100需要调整布局或视觉表现时设置。
colorstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 105需要覆盖组件默认业务值时设置。
softColorstring""设置对应区域的颜色;消费位置:script 行 106需要调整布局或视觉表现时设置。
sizeXtfComponentSize""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 84需要覆盖组件默认业务值时设置。
shape"round" | "square"""参与组件运行逻辑;源码在 1 处读取该值;可选值:round / square;消费位置:script 行 96需要覆盖组件默认业务值时设置。
roundbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 96需要覆盖组件默认业务值时设置。
blockbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 97需要覆盖组件默认业务值时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 92需要控制显示、可用性或交互状态时设置。
loadingbooleanfalse参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 74、script 行 92、template 行 3、template 行 6需要控制显示、可用性或交互状态时设置。
throttlenumber0参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 114需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 100需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 104需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
clickhandleClick 内触发(script 行 118);参数表达式:event;前置 guard:isDisabled.value、throttle > 0 && last != null && now >= last && now - last < throttle(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
taphandleClick 内触发(script 行 119);参数表达式:event;前置 guard:isDisabled.value、throttle > 0 && last != null && now >= last && now - last < throttle(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
longpresshandleLongPress 内触发(script 行 123);参数表达式:event(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

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

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
--当前组件没有公开实例方法。

公开状态 ​

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

主题说明 ​

  • var(--xtf-button-color):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-button-soft-color):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-button-text-color):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-opacity-disabled):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-radius-full):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-radius-md):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-radius-xs):组件样式实际读取的主题变量,可在 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。

MIT Licensed