xtf-checkbox

组件说明

xtf-checkbox 是复选框，用于切换独立布尔或业务值选择。当前实现通过 input 等事件反馈交互。

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

---

基础用法

1. 最小可用

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

<template>
  <view class="doc-minimum">
    <XtfCheckbox label="保存">
      <text class="doc-content-text">示例内容</text>
    </XtfCheckbox>
  </view>
</template>

<script setup lang="uts">
import XtfCheckbox from "@/uni_modules/xtf-linkuiunix/components/xtf-checkbox/xtf-checkbox.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">
    <XtfCheckbox label="保存" @input="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfCheckbox>
  </view>
</template>

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

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

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

3. 动态 disabled 状态

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

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

<script setup lang="uts">
import XtfCheckbox from "@/uni_modules/xtf-linkuiunix/components/xtf-checkbox/xtf-checkbox.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-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 替换对应内容。

<template>
  <view class="doc-slot">
    <XtfCheckbox label="保存">
      <template #default="scope"><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfCheckbox>
  </view>
</template>

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

</script>

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

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
name	any	null	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 18、script 行 32、script 行 43、script 行 51	需要覆盖组件默认业务值时设置。
modelValue	any	undefined	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 11、script 行 12、script 行 14、script 行 43	需要覆盖组件默认业务值时设置。
value	any	undefined	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 11、script 行 12、script 行 15、script 行 43	需要覆盖组件默认业务值时设置。
trueValue	any	true	提供当前受控状态；是否回写以事件表为准；消费位置：script 行 12、script 行 43、script 行 55	需要覆盖组件默认业务值时设置。
falseValue	any	false	提供当前受控状态；是否回写以事件表为准；消费位置：script 行 43、script 行 55	需要覆盖组件默认业务值时设置。
checked	boolean	false	开关对应显示或交互行为；消费位置：script 行 11、script 行 12、script 行 16、script 行 43	需要覆盖组件默认业务值时设置。
indeterminate	boolean	false	参与组件运行逻辑；源码在 14 处读取该值；消费位置：script 行 35、script 行 37、template 行 4、template 行 11	需要覆盖组件默认业务值时设置。
disabled	boolean	false	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 18、script 行 33、script 行 43	需要控制显示、可用性或交互状态时设置。
block	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 35	需要覆盖组件默认业务值时设置。
bordered	boolean	false	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 35	需要覆盖组件默认业务值时设置。
shape	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 27	需要覆盖组件默认业务值时设置。
variant	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 25	需要调整布局或视觉表现时设置。
size	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 26	需要覆盖组件默认业务值时设置。
label	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7	需要提供业务文案或图标内容时设置。
description	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 8	需要提供业务文案或图标内容时设置。
iconPosition	string	"left"	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 35、template 行 3、template 行 6、template 行 10	需要覆盖组件默认业务值时设置。
align	string	"center"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 35	需要调整布局或视觉表现时设置。
beforeChange	((payload: UTSJSONObject) => any) | null	null	提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 43、script 行 51	需要接入业务守卫、转换或过滤逻辑时设置。
labelClickable	boolean	true	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 39、script 行 40	需要提供业务文案或图标内容时设置。
theme	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 23	需要调整布局或视觉表现时设置。
color	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 24	需要覆盖组件默认业务值时设置。
activeColor	string	""	设置对应区域的颜色；消费位置：script 行 24	需要调整布局或视觉表现时设置。
iconSize	string | number	""	设置对应元素尺寸；消费位置：script 行 21	需要调整布局或视觉表现时设置。
checkedIcon	string	""	设置对应区域的图标名称；消费位置：script 行 28	需要提供业务文案或图标内容时设置。
uncheckedIcon	string	""	设置对应区域的图标名称；消费位置：script 行 29	需要提供业务文案或图标内容时设置。
indeterminateIcon	string	""	设置对应区域的图标名称；消费位置：script 行 30	需要提供业务文案或图标内容时设置。
checkAnimation	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 31	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 35	需要调整布局或视觉表现时设置。
customStyle	UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 36	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
input	toggleCheck 内触发（script 行 56）；参数表达式：nextValue；前置 guard：props.beforeChange != null && await props.beforeChange({ checked: isChecked.value, nextChecked, name: props.name }) === false、isDisabled.value || version != revision、group != null	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValue	toggleCheck 内触发（script 行 56）；参数表达式：nextValue；前置 guard：props.beforeChange != null && await props.beforeChange({ checked: isChecked.value, nextChecked, name: props.name }) === false、isDisabled.value || version != revision、group != null	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
update:value	toggleCheck 内触发（script 行 56）；参数表达式：nextValue；前置 guard：props.beforeChange != null && await props.beforeChange({ checked: isChecked.value, nextChecked, name: props.name }) === false、isDisabled.value || version != revision、group != null	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
change	toggleCheck 内触发（script 行 56）；参数表达式：nextValue；前置 guard：props.beforeChange != null && await props.beforeChange({ checked: isChecked.value, nextChecked, name: props.name }) === false、isDisabled.value || version != revision、group != null	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

插槽	Scope 参数	实际渲染位置
default	(props: {})	仅在模板对应 <slot> 渲染位置生效。
description	(props: {})	仅在模板对应 <slot> 渲染位置生效。
icon	(props: { checked: boolean; indeterminate: boolean; disabled: boolean })	仅在模板对应 <slot> 渲染位置生效。

---

方法

实例方法

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

公开状态

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

---

主题说明

• var(--xtf-checkbox-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-)：组件样式实际读取的主题变量，可在 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。