Skip to content

xtf-radio-group ​

组件说明 ​

xtf-radio-group 是单选组,用于管理一组选项的唯一选中值。当前实现读取 options 数据、通过 update:modelValue 等事件反馈交互。

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

基础用法 ​

1. 最小可用 ​

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

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

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

const fixture = [{ label: '按月', value: 'month' }, { label: '按年', value: 'year' }] as Array<any>
</script>

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

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

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

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

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

const fixture = [{ label: '按月', value: 'month' }, { label: '按年', value: 'year' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-radio-group:input", payload) }
</script>

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

3. 动态 disabled 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfRadioGroup :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 XtfRadioGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-radio-group/xtf-radio-group.uvue"

import { ref } from "vue"
const fixture = [{ label: '按月', value: 'month' }, { label: '按年', value: 'year' }] 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">
    <XtfRadioGroup :options="fixture">
      <template #default="scope"><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfRadioGroup>
  </view>
</template>

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

const fixture = [{ label: '按月', value: 'month' }, { label: '按年', value: 'year' }] as Array<any>
</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
modelValueanyundefined参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 9需要覆盖组件默认业务值时设置。
valueany""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 9需要覆盖组件默认业务值时设置。
optionsany[]() => [] as any[]参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 10数据驱动或选项渲染场景。
optionLabelKeystring"label"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 10需要提供业务文案或图标内容时设置。
optionValueKeystring"value"提供当前受控状态;是否回写以事件表为准;消费位置:script 行 10需要覆盖组件默认业务值时设置。
optionDisabledKeystring"disabled"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 10需要覆盖组件默认业务值时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 16、由 XtfRadio 注入消费需要控制显示、可用性或交互状态时设置。
themestring"primary"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要调整布局或视觉表现时设置。
colorstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
activeColorstring""设置对应区域的颜色;消费位置:由 XtfRadio 注入消费需要调整布局或视觉表现时设置。
variantstring"default"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要调整布局或视觉表现时设置。
iconShapestring"circle"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
iconPositionstring"left"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
alignstring"center"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要调整布局或视觉表现时设置。
iconGapstring | number14参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要调整布局或视觉表现时设置。
iconSizestring | number""设置对应元素尺寸;消费位置:由 XtfRadio 注入消费需要调整布局或视觉表现时设置。
checkAnimationstring"scaleXY"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
sizestring | number"md"参与组件运行逻辑;源码在 1 处读取该值;消费位置:由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
directionstring"column"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 11、由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
gapstring | number20参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 12、由 XtfRadio 注入消费需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 11需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 12需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
update:modelValueupdateValue 内触发(script 行 16);参数表达式:nextValue;前置 guard:props.disabled || currentValue.value === nextValue(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
inputupdateValue 内触发(script 行 16);参数表达式:nextValue;前置 guard:props.disabled || currentValue.value === nextValue(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changeupdateValue 内触发(script 行 16);参数表达式:nextValue;前置 guard:props.disabled || currentValue.value === nextValue(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

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

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • 当前组件 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。

MIT Licensed