Appearance
xtf-color-picker
组件说明
xtf-color-picker 是颜色选择器，用于编辑颜色值并确认或撤销草稿。当前实现由 show 控制显示、通过 update:modelValue 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-color-picker/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfColorPicker title="账单详情" :show="true" />
</view>
</template>
<script setup lang="uts">
import XtfColorPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-color-picker/xtf-color-picker.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfColorPicker title="账单详情" :show="true" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfColorPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-color-picker/xtf-color-picker.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-color-picker:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 show 状态
运行时切换 show，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfColorPicker title="账单详情" :show="state" />
<button class="doc-action-button" @click="toggleState">切换 show</button>
<text class="doc-state-text">show: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfColorPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-color-picker/xtf-color-picker.uvue"
import { ref } from "vue"
const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", 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. 定制 trigger 插槽
使用源码真实声明的 trigger slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfColorPicker title="账单详情" :show="true">
<template #trigger="scope"><text class="doc-content-text">自定义 trigger 内容：{{ scope.value }}</text></template>
</XtfColorPicker>
</view>
</template>
<script setup lang="uts">
import XtfColorPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-color-picker/xtf-color-picker.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 open()
打开组件；签名为 open(): void。
vue
<template>
<view class="doc-method">
<XtfColorPicker title="账单详情" :show="true" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfColorPicker from "@/uni_modules/xtf-linkuiunix/components/xtf-color-picker/xtf-color-picker.uvue"
import { ref } from "vue"
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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | string | undefined | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 33、script 行 111 | 需要覆盖组件默认业务值时设置。 |
value | string | undefined | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 33、script 行 111 | 需要覆盖组件默认业务值时设置。 |
show | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 22、script 行 110 | 需要控制显示、可用性或交互状态时设置。 |
display | string | "popup" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 53 | 需要覆盖组件默认业务值时设置。 |
inline | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 53 | 需要覆盖组件默认业务值时设置。 |
title | string | "选择颜色" | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 57、template 行 18、template 行 30、template 行 33 | 需要提供业务文案或图标内容时设置。 |
format | string | "hex" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 49 | 需要覆盖组件默认业务值时设置。 |
showAlpha | boolean | false | 开关对应显示或交互行为；消费位置：script 行 97、template 行 22、template 行 23、template 行 37 | 需要控制显示、可用性或交互状态时设置。 |
presets | string[] | () => [] as string[] | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 69 | 需要覆盖组件默认业务值时设置。 |
showPresets | boolean | true | 开关对应显示或交互行为；消费位置：template 行 24、template 行 39 | 需要控制显示、可用性或交互状态时设置。 |
showPreview | boolean | true | 开关对应显示或交互行为；消费位置：template 行 19、template 行 34 | 需要控制显示、可用性或交互状态时设置。 |
showInputs | boolean | true | 开关对应显示或交互行为；消费位置：template 行 23、template 行 38 | 需要控制显示、可用性或交互状态时设置。 |
showHexInput | boolean | true | 开关对应显示或交互行为；消费位置：template 行 23、template 行 38 | 需要控制显示、可用性或交互状态时设置。 |
showAlphaInput | boolean | true | 开关对应显示或交互行为；消费位置：template 行 23、template 行 38 | 需要控制显示、可用性或交互状态时设置。 |
showActions | boolean | undefined | 开关对应显示或交互行为；消费位置：script 行 55 | 数据驱动或选项渲染场景。 |
showHeader | boolean | undefined | 开关对应显示或交互行为；消费位置：script 行 57 | 需要控制显示、可用性或交互状态时设置。 |
showTrigger | boolean | false | 开关对应显示或交互行为；消费位置：script 行 54 | 需要控制显示、可用性或交互状态时设置。 |
triggerLabel | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 8 | 需要提供业务文案或图标内容时设置。 |
triggerPlaceholder | string | "点击选择颜色" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 9 | 需要提供业务文案或图标内容时设置。 |
triggerDisabled | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 72 | 需要覆盖组件默认业务值时设置。 |
confirmText | string | "确认" | 设置对应区域的显示文案；消费位置：template 行 18、template 行 30、template 行 33 | 需要提供业务文案或图标内容时设置。 |
cancelText | string | "取消" | 设置对应区域的显示文案；消费位置：template 行 18、template 行 30、template 行 33 | 需要提供业务文案或图标内容时设置。 |
disabled | boolean | false | 参与组件运行逻辑；源码在 11 处读取该值；消费位置：script 行 72、script 行 75、script 行 79、script 行 80 | 需要控制显示、可用性或交互状态时设置。 |
overlay | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 28 | 需要控制显示、可用性或交互状态时设置。 |
closeOnClickOverlay | boolean | true | 开关对应显示或交互行为；消费位置：template 行 28 | 需要覆盖组件默认业务值时设置。 |
safeAreaInsetBottom | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 28 | 需要覆盖组件默认业务值时设置。 |
enableEyeDropper | boolean | false | 开关对应显示或交互行为；消费位置：template 行 25、template 行 40 | 需要覆盖组件默认业务值时设置。 |
triggerStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象；消费位置：template 行 5 | 需要调整布局或视觉表现时设置。 |
popupMaxHeight | number | string | "" | 设置对应区域高度；消费位置：script 行 70 | 需要调整布局或视觉表现时设置。 |
stickyActions | boolean | undefined | 提供组件渲染或选择使用的数据集合；消费位置：script 行 56 | 数据驱动或选项渲染场景。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | emitColor 内触发（script 行 74）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | emitColor 内触发（script 行 74）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:show | openPicker 内触发（script 行 72）；参数表达式：true；前置 guard：isInline.value || props.disabled || props.triggerDisabledclosePicker 内触发（script 行 73）；参数表达式：false | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
input | emitColor 内触发（script 行 74）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | emitColor 内触发（script 行 74）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | confirmSelection 内触发（script 行 75）；参数表达式：value；前置 guard：props.disabled || disposed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | cancelSelection 内触发（script 行 76）；参数表达式：无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
open | openPicker 内触发（script 行 72）；参数表达式：无回调参数；前置 guard：isInline.value || props.disabled || props.triggerDisabledsetup 内触发（script 行 110）；参数表达式：无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
close | closePicker 内触发（script 行 73）；参数表达式：无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
trigger-click | openPicker 内触发（script 行 72）；参数表达式：无回调参数；前置 guard：isInline.value || props.disabled || props.triggerDisabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
eyedropper-unavailable | openEyeDropper 内触发（script 行 107）；参数表达式：无回调参数；前置 guard：props.disabled || disposed、Constructor != null | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
trigger | (props: { value: string; color: string; openPicker: () => void }) | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件；通过组件 ref 调用，参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件；通过组件 ref 调用，参数和返回值按签名处理。 |
confirm | confirm(): void | 提交当前草稿；通过组件 ref 调用，参数和返回值按签名处理。 |
cancel | cancel(): void | 撤销当前草稿；通过组件 ref 调用，参数和返回值按签名处理。 |
getValue | getValue(): string | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
reset | reset(): void | 恢复初始状态；通过组件 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。