Appearance
xtf-switch
组件说明
xtf-switch 是开关，用于切换两个业务状态并支持变更守卫。当前实现通过 input 等事件反馈交互。
- 实际 Demo 路由：
#/pages/components/xtf-switch/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfSwitch :value="true" />
</view>
</template>
<script setup lang="uts">
import XtfSwitch from "@/uni_modules/xtf-linkuiunix/components/xtf-switch/xtf-switch.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfSwitch :value="true" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfSwitch from "@/uni_modules/xtf-linkuiunix/components/xtf-switch/xtf-switch.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-switch:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfSwitch :value="true" :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 XtfSwitch from "@/uni_modules/xtf-linkuiunix/components/xtf-switch/xtf-switch.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>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
value | XtfSwitchValue | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 45、script 行 66 | 需要覆盖组件默认业务值时设置。 |
modelValue | XtfSwitchValue | null | 参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 45、script 行 65、script 行 66、script 行 76 | 需要覆盖组件默认业务值时设置。 |
activeValue | XtfSwitchValue | true | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 77、script 行 135 | 需要覆盖组件默认业务值时设置。 |
inactiveValue | XtfSwitchValue | false | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 135 | 需要覆盖组件默认业务值时设置。 |
theme | string | "primary" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 94 | 需要调整布局或视觉表现时设置。 |
preset | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 80 | 需要覆盖组件默认业务值时设置。 |
variant | string | "native" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 79 | 需要调整布局或视觉表现时设置。 |
motion | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 128 | 需要覆盖组件默认业务值时设置。 |
activeColor | string | "" | 设置对应区域的颜色；消费位置：script 行 94 | 需要调整布局或视觉表现时设置。 |
color | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 94 | 需要覆盖组件默认业务值时设置。 |
inactiveColor | string | "" | 设置对应区域的颜色；消费位置：script 行 95 | 需要调整布局或视觉表现时设置。 |
type | string | "switch" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
name | string | "" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
size | string | "md" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 81 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 67、script 行 98、script 行 133 | 需要控制显示、可用性或交互状态时设置。 |
loading | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 68、script 行 78 | 需要控制显示、可用性或交互状态时设置。 |
async | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 137 | 需要覆盖组件默认业务值时设置。 |
beforeChange | ((nextChecked: boolean) => any) | null | null | 提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 138 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
activeText | string | "" | 设置对应区域的显示文案；消费位置：script 行 82、script 行 84、script 行 88 | 需要提供业务文案或图标内容时设置。 |
inactiveText | string | "" | 设置对应区域的显示文案；消费位置：script 行 82、script 行 84、script 行 88 | 需要提供业务文案或图标内容时设置。 |
activeIcon | string | "" | 设置对应区域的图标名称；消费位置：script 行 83、script 行 84 | 需要提供业务文案或图标内容时设置。 |
inactiveIcon | string | "" | 设置对应区域的图标名称；消费位置：script 行 83、script 行 84 | 需要提供业务文案或图标内容时设置。 |
labelPlacement | string | "auto" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 86 | 需要提供业务文案或图标内容时设置。 |
overflowStrategy | string | "auto-outside" | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 87、script 行 88、script 行 98、script 行 103 | 需要覆盖组件默认业务值时设置。 |
width | string | number | "" | 参与组件运行逻辑；源码在 8 处读取该值；消费位置：script 行 88、script 行 108、script 行 109、script 行 110 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 98 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 114 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | emitValue 内触发（script 行 121）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | emitValue 内触发（script 行 122）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | emitValue 内触发（script 行 123）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | emitValue 内触发（script 行 124）；参数表达式：valuetoggle 内触发（script 行 159）；参数表达式：nextValue；前置 guard：guard == null、!mounted || currentRequest != requestId、allowed !== true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface-muted)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-opacity-disabled)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-active)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-height)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-inactive)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-pad)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-shift)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-thumb)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-switch-width)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 当前仅兼容接收、未发现运行消费的 props：
type、name。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。