xtf-checkbox-group

组件说明

xtf-checkbox-group 是复选框组，用于管理多项选择及数量限制。当前实现读取 options 数据、通过 input 等事件反馈交互、提供实例方法。

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

基础用法

1. 最小可用

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

vue

<template>
  <view class="doc-minimum">
    <XtfCheckboxGroup :options="fixture" />
  </view>
</template>

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

const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel', disabled: true }] as Array<any>
</script>

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

2. 核心数据与主要事件

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

vue

<template>
  <view class="doc-core">
    <XtfCheckboxGroup :options="fixture" @input="onPrimaryEvent" />
  </view>
</template>

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

const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel', disabled: true }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-checkbox-group:input", payload) }
</script>

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

3. 动态 disabled 状态

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

vue

<template>
  <view class="doc-dynamic">
    <XtfCheckboxGroup :options="fixture" :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 XtfCheckboxGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-checkbox-group/xtf-checkbox-group.uvue"

import { ref } from "vue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel', disabled: true }] as Array<any>
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. 定制 default 插槽

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

vue

<template>
  <view class="doc-slot">
    <XtfCheckboxGroup :options="fixture">
      <template #default="scope"><text class="doc-content-text">自定义 default 内容：{{ scope.values }}</text></template>
    </XtfCheckboxGroup>
  </view>
</template>

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

const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel', disabled: true }] as Array<any>
</script>

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

5. 调用 updateValue()

调用该公开实例能力；签名为 updateValue(value: any, checked: boolean): Promise<boolean>。

vue

<template>
  <view class="doc-method">
    <XtfCheckboxGroup :options="fixture" ref="componentRef" />
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

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

import { ref } from "vue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel', disabled: true }] as Array<any>
const componentRef = ref<any>(null)
async function callMethod(): Promise<void> { const accepted = await componentRef.value?.updateValue('food', true); console.log("updateValue", accepted) }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
`modelValue`	`any[]`	`null`	参与组件运行逻辑；源码在 8 处读取该值；消费位置：script 行 9、script 行 20、script 行 23、script 行 56	需要覆盖组件默认业务值时设置。
`value`	`any[]`	`null`	参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 9、script 行 20、script 行 23、script 行 57	需要覆盖组件默认业务值时设置。
`options`	`any[]`	`() => [] as any[]`	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 16、script 行 17、script 行 20、script 行 25	数据驱动或选项渲染场景。
`optionLabelKey`	`string`	`"label"`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 26	需要提供业务文案或图标内容时设置。
`optionValueKey`	`string`	`"value"`	提供当前受控状态；是否回写以事件表为准；消费位置：script 行 25	需要覆盖组件默认业务值时设置。
`optionDisabledKey`	`string`	`"disabled"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 28	需要覆盖组件默认业务值时设置。
`disabled`	`boolean`	`false`	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 20、script 行 32、script 行 47、由 XtfCheckbox 注入消费	需要控制显示、可用性或交互状态时设置。
`theme`	`string`	`"primary"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：由 XtfCheckbox 注入消费	需要调整布局或视觉表现时设置。
`color`	`string`	`""`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：由 XtfCheckbox 注入消费	需要覆盖组件默认业务值时设置。
`activeColor`	`string`	`""`	设置对应区域的颜色；消费位置：由 XtfCheckbox 注入消费	需要调整布局或视觉表现时设置。
`variant`	`string`	`"default"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：由 XtfCheckbox 注入消费	需要调整布局或视觉表现时设置。
`size`	`string`	`"md"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：由 XtfCheckbox 注入消费	需要覆盖组件默认业务值时设置。
`shape`	`string`	`"square"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：由 XtfCheckbox 注入消费	需要覆盖组件默认业务值时设置。
`checkAnimation`	`string`	`"scale"`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：由 XtfCheckbox 注入消费	需要覆盖组件默认业务值时设置。
`iconSize`	`string \| number`	`""`	设置对应元素尺寸；消费位置：由 XtfCheckbox 注入消费	需要调整布局或视觉表现时设置。
`checkedIcon`	`string`	`""`	设置对应区域的图标名称；消费位置：由 XtfCheckbox 注入消费	需要提供业务文案或图标内容时设置。
`uncheckedIcon`	`string`	`""`	设置对应区域的图标名称；消费位置：由 XtfCheckbox 注入消费	需要提供业务文案或图标内容时设置。
`indeterminateIcon`	`string`	`""`	设置对应区域的图标名称；消费位置：由 XtfCheckbox 注入消费	需要提供业务文案或图标内容时设置。
`direction`	`string`	`"column"`	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 11、template 行 3	需要覆盖组件默认业务值时设置。
`gap`	`string \| number`	`20`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 12	需要覆盖组件默认业务值时设置。
`max`	`number`	`0`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 20、script 行 37	需要覆盖组件默认业务值时设置。
`min`	`number`	`0`	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 20、script 行 38	需要覆盖组件默认业务值时设置。
`beforeChange`	`((payload: UTSJSONObject) => any) \| null`	`null`	提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 20、script 行 46	需要接入业务守卫、转换或过滤逻辑时设置。
`customClass`	`string`	`""`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 11	需要调整布局或视觉表现时设置。
`customStyle`	`UTSJSONObject`	`() => ({} as UTSJSONObject)`	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 12	需要调整布局或视觉表现时设置。

事件

事件名称	源码触发边界	回调参数	参数说明
`input`	`commit` 内触发（script 行 30）；参数表达式：`next`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`update:modelValue`	`commit` 内触发（script 行 30）；参数表达式：`next`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`update:value`	`commit` 内触发（script 行 30）；参数表达式：`next`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`change`	`commit` 内触发（script 行 30）；参数表达式：`next`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`reach-max`	`requestChange` 内触发（script 行 37）；参数表达式：`current`；前置 guard：`props.disabled \|\| pending`、`props.max > 0 && next.length > props.max && next.length > current.length`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
`reach-min`	`requestChange` 内触发（script 行 38）；参数表达式：`current`；前置 guard：`props.disabled \|\| pending`、`props.max > 0 && next.length > props.max && next.length > current.length`、`props.min > 0 && next.length < props.min && next.length < current.length`	`(...args: any[])`	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

插槽

插槽	Scope 参数	实际渲染位置
`default`	`{ values, check-all, update-value }`	仅在模板对应 `<slot>` 渲染位置生效。

方法

实例方法

方法	签名 / 返回值	调用边界
`updateValue`	`updateValue(value: any, checked: boolean): Promise<boolean>`	调用该公开实例能力；通过组件 `ref` 调用，参数和返回值按签名处理。
`checkAll`	`checkAll(checked: boolean, source: any[] \| null = null): Promise<boolean>`	调用该公开实例能力；通过组件 `ref` 调用，参数和返回值按签名处理。

公开状态

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

主题说明

当前组件 CSS 未读取 var(--xtf-*) 主题变量；颜色或尺寸可能来自 props、固定样式或父级上下文。

平台与实现边界

基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
本文按当前源码生成，不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
详细公共边界见平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

xtf-checkbox-group ​

组件说明 ​

基础用法 ​

1. 最小可用 ​

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

3. 动态 disabled 状态 ​

4. 定制 default 插槽 ​

5. 调用 updateValue() ​

全部属性 ​

事件 ​

插槽 ​

方法 ​

实例方法 ​

公开状态 ​

主题说明 ​

平台与实现边界 ​