Appearance
xtf-picker
组件说明
xtf-picker 是滚轮选择器,用于从单列、多列或级联数据中选择值。当前实现读取 columns 数据、通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-picker/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfPicker label="账单分类" :columns="fixture" mode="inline" />
</view>
</template>
<script setup lang="uts">
import XtfPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-picker/xtf-picker.uvue"
const fixture = [{ label: '收入', value: 'income', children: [{ label: '工资', value: 'salary' }] }, { label: '支出', value: 'expense', children: [{ label: '餐饮', value: 'food' }] }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfPicker label="账单分类" :columns="fixture" mode="inline" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-picker/xtf-picker.uvue"
const fixture = [{ label: '收入', value: 'income', children: [{ label: '工资', value: 'salary' }] }, { label: '支出', value: 'expense', children: [{ label: '餐饮', value: 'food' }] }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-picker:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfPicker label="账单分类" :columns="fixture" mode="inline" :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 XtfPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-picker/xtf-picker.uvue"
import { ref } from "vue"
const fixture = [{ label: '收入', value: 'income', children: [{ label: '工资', value: 'salary' }] }, { label: '支出', value: 'expense', children: [{ label: '餐饮', value: 'food' }] }] 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. 调用 open()
打开组件;签名为 open(): void。
vue
<template>
<view class="doc-method">
<XtfPicker label="账单分类" :columns="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-picker/xtf-picker.uvue"
import { ref } from "vue"
const fixture = [{ label: '收入', value: 'income', children: [{ label: '工资', value: 'salary' }] }, { label: '支出', value: 'expense', children: [{ label: '餐饮', value: 'food' }] }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.open(); console.log("调用 open") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
value | any | "" | 参与组件运行逻辑;源码在 12 处读取该值;消费位置:script 行 12、script 行 17、script 行 29、script 行 30 | 需要覆盖组件默认业务值时设置。 |
mode | string | "popup" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 14 | 需要覆盖组件默认业务值时设置。 |
label | string | "" | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 21、template 行 3、template 行 5 | 需要提供业务文案或图标内容时设置。 |
placeholder | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 20 | 需要提供业务文案或图标内容时设置。 |
title | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 21 | 需要提供业务文案或图标内容时设置。 |
columns | any[] | () => [] as any[] | 参与组件运行逻辑;源码在 10 处读取该值;消费位置:script 行 30、script 行 37、script 行 38、script 行 40 | 数据驱动或选项渲染场景。 |
valueKey | string | "value" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 33 | 需要覆盖组件默认业务值时设置。 |
labelKey | string | "label" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 34 | 需要提供业务文案或图标内容时设置。 |
childrenKey | string | "children" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 35 | 需要覆盖组件默认业务值时设置。 |
columnTitles | string[] | () => [] as string[] | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 60 | 需要提供业务文案或图标内容时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 76、script 行 77、script 行 80、template 行 7 | 需要控制显示、可用性或交互状态时设置。 |
required | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 82、template 行 4 | 需要控制显示、可用性或交互状态时设置。 |
message | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 16 | 需要提供业务文案或图标内容时设置。 |
confirmText | string | "确认" | 设置对应区域的显示文案;消费位置:script 行 22 | 需要提供业务文案或图标内容时设置。 |
cancelText | string | "取消" | 设置对应区域的显示文案;消费位置:script 行 23 | 需要提供业务文案或图标内容时设置。 |
showPreviewPath | boolean | true | 开关对应显示或交互行为;消费位置:template 行 13、template 行 21 | 需要控制显示、可用性或交互状态时设置。 |
previewLabel | string | "当前选择" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 13、template 行 21 | 需要提供业务文案或图标内容时设置。 |
separator | string | " / " | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 18、script 行 45 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 24 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
displayFormatter | (payload: UTSJSONObject) => string | null | 提供源码调用的业务回调,参数和返回值以类型列为准;消费位置:script 行 45 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
service | boolean | false | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
loop | boolean | false | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
displayMode | string | "flat" | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
themePreset | string | "default" | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
columnWidths | any | null | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 72 | 需要覆盖组件默认业务值时设置。 |
columnGap | any | 16 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 25 | 需要调整布局或视觉表现时设置。 |
columnHeight | any | 360 | 设置对应区域高度;消费位置:script 行 26 | 需要调整布局或视觉表现时设置。 |
wheelItemHeight | any | 88 | 设置对应区域高度;消费位置:script 行 74 | 需要调整布局或视觉表现时设置。 |
overscanCount | any | 6 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
wheelPerspective | any | 1000 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
wheelCurve | any | 1 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionActiveScale | any | 1 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionScaleMin | any | 0.985 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionOpacityMin | any | 0.38 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionOpacityStep | any | 0.22 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionOffsetStep | any | 0 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionBlurStep | any | 0 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
motionTransitionDuration | any | 90 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
snapDuration | any | 180 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
momentumThreshold | any | 1.1 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
cascadeDelay | any | 34 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
validateOnInit | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 88 | 需要覆盖组件默认业务值时设置。 |
size | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 24 | 需要覆盖组件默认业务值时设置。 |
confirmHint | string | "" | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
emptyText | string | "暂无选项" | 设置对应区域的显示文案;消费位置:template 行 12、template 行 19 | 需要提供业务文案或图标内容时设置。 |
popupLayout | string | "default" | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
popupCustomClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 18 | 需要调整布局或视觉表现时设置。 |
popupCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 18 | 需要调整布局或视觉表现时设置。 |
wheelCustomClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 14、template 行 22 | 需要调整布局或视觉表现时设置。 |
wheelCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 14、template 行 22 | 需要调整布局或视觉表现时设置。 |
columnCustomClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 14、template 行 22 | 需要调整布局或视觉表现时设置。 |
columnCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 14、template 行 22 | 需要调整布局或视觉表现时设置。 |
columnHeadStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 14、template 行 22 | 需要调整布局或视觉表现时设置。 |
frameCustomClass | string | "" | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
frameCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
optionCustomClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 73 | 需要调整布局或视觉表现时设置。 |
optionCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 74 | 需要调整布局或视觉表现时设置。 |
activeOptionCustomClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 73 | 需要调整布局或视觉表现时设置。 |
activeOptionCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 74 | 需要调整布局或视觉表现时设置。 |
optionTextStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 75 | 需要调整布局或视觉表现时设置。 |
activeOptionTextStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 75 | 需要调整布局或视觉表现时设置。 |
maskTopStyle | string | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 27 | 需要调整布局或视觉表现时设置。 |
maskBottomStyle | string | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 28 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | validate 内触发(script 行 57);参数表达式:value;前置 guard:props.columns.length == 0、!changedhandlePickerChange 内触发(script 行 76);参数表达式:data["value"];前置 guard:props.disabledconfirm 内触发(script 行 83);参数表达式:data["value"];前置 guard:props.disabled、props.required && (workingPath.value.length == 0 || hasEmptyColumn.value || workingPath.value.some((value: any): boolean => value == null || value === "")) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | validate 内触发(script 行 58);参数表达式:value;前置 guard:props.columns.length == 0、!changedhandlePickerChange 内触发(script 行 76);参数表达式:data["value"];前置 guard:props.disabledconfirm 内触发(script 行 83);参数表达式:data["value"];前置 guard:props.disabled、props.required && (workingPath.value.length == 0 || hasEmptyColumn.value || workingPath.value.some((value: any): boolean => value == null || value === "")) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | confirm 内触发(script 行 83);参数表达式:data;前置 guard:props.disabled、props.required && (workingPath.value.length == 0 || hasEmptyColumn.value || workingPath.value.some((value: any): boolean => value == null || value === "")) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | cancel 内触发(script 行 85);参数表达式:data | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:selected | handlePickerChange 内触发(script 行 76);参数表达式:data;前置 guard:props.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:validated | validate 内触发(script 行 56);参数表达式:{ source, value };前置 guard:props.columns.length == 0、!changed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件;通过组件 ref 调用,参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件;通过组件 ref 调用,参数和返回值按签名处理。 |
confirm | confirm(): void | 提交当前草稿;通过组件 ref 调用,参数和返回值按签名处理。 |
cancel | cancel(): void | 撤销当前草稿;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在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:
service、loop、displayMode、themePreset、overscanCount、wheelPerspective、wheelCurve、motionActiveScale、motionScaleMin、motionOpacityMin、motionOpacityStep、motionOffsetStep、motionBlurStep、motionTransitionDuration、snapDuration、momentumThreshold、cascadeDelay、confirmHint、popupLayout、frameCustomClass、frameCustomStyle。 - 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。