Skip to content

xtf-segmented ​

组件说明 ​

xtf-segmented 是分段选择,用于在少量互斥选项间快速切换。当前实现读取 options 数据、通过 update:current 等事件反馈交互。

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

基础用法 ​

1. 最小可用 ​

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

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

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

const fixture = [{ label: '全部', value: 'all' }, { label: '收入', value: 'income' }, { label: '支出', value: 'expense' }] as Array<any>
</script>

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

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

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

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

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

const fixture = [{ label: '全部', value: 'all' }, { label: '收入', value: 'income' }, { label: '支出', value: 'expense' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-segmented:change", payload) }
</script>

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

3. 动态 block 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfSegmented :options="fixture" :block="state" />
    <button class="doc-action-button" @click="toggleState">切换 block</button>
    <text class="doc-state-text">block: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"
const fixture = [{ label: '全部', value: 'all' }, { label: '收入', value: 'income' }, { label: '支出', value: 'expense' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("block", 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 默认值实际行为 / 范围适用范围
currentnumber | string0提供当前受控状态;是否回写以事件表为准;消费位置:script 行 24需要覆盖组件默认业务值时设置。
valuesany[]() => [] as any[]提供当前受控状态;是否回写以事件表为准;消费位置:script 行 9需要覆盖组件默认业务值时设置。
optionsany[]() => [] as any[]参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 9数据驱动或选项渲染场景。
styleTypestring"button"参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 25、script 行 27、script 行 28、script 行 29需要覆盖组件默认业务值时设置。
activeColorstring"var(--xtf-color-primary, #2563eb)"设置对应区域的颜色;消费位置:script 行 26、script 行 29需要调整布局或视觉表现时设置。
sizestring"md"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 25、script 行 27需要覆盖组件默认业务值时设置。
blockbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 25、script 行 27需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 25需要调整布局或视觉表现时设置。
customStylestring | UTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 26需要调整布局或视觉表现时设置。

事件 ​

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

插槽 ​

插槽Scope 参数实际渲染位置
--当前模板没有公开 slot。

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • var(--xtf-color-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface-muted):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-segmented-active-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。

MIT Licensed