Appearance
xtf-datetime-picker
组件说明
xtf-datetime-picker 是日期时间选择,用于选择日期、时间或范围值。当前实现由 show 控制显示、通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-datetime-picker/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfDatetimePicker title="账单详情" :show="true" />
</view>
</template>
<script setup lang="uts">
import XtfDatetimePicker from "@/uni_modules/xtf-linkuiunix/components/xtf-datetime-picker/xtf-datetime-picker.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfDatetimePicker title="账单详情" :show="true" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfDatetimePicker from "@/uni_modules/xtf-linkuiunix/components/xtf-datetime-picker/xtf-datetime-picker.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-datetime-picker:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 show 状态
运行时切换 show,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfDatetimePicker 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 XtfDatetimePicker from "@/uni_modules/xtf-linkuiunix/components/xtf-datetime-picker/xtf-datetime-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. 定制 hero 插槽
使用源码真实声明的 hero slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfDatetimePicker title="账单详情" :show="true">
<template #hero="scope"><text class="doc-content-text">自定义 hero 内容:{{ scope.range }}</text></template>
</XtfDatetimePicker>
</view>
</template>
<script setup lang="uts">
import XtfDatetimePicker from "@/uni_modules/xtf-linkuiunix/components/xtf-datetime-picker/xtf-datetime-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">
<XtfDatetimePicker title="账单详情" :show="true" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfDatetimePicker from "@/uni_modules/xtf-linkuiunix/components/xtf-datetime-picker/xtf-datetime-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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
show | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 27、script 行 128 | 需要控制显示、可用性或交互状态时设置。 |
value | any | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 108、script 行 129 | 需要覆盖组件默认业务值时设置。 |
modelValue | any | null | 参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 108、script 行 113、script 行 129 | 需要覆盖组件默认业务值时设置。 |
mode | string | "date" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 56、script 行 131 | 需要覆盖组件默认业务值时设置。 |
showSeconds | boolean | false | 开关对应显示或交互行为;消费位置:script 行 95、script 行 107、script 行 131 | 需要控制显示、可用性或交互状态时设置。 |
range | boolean | false | 参与组件运行逻辑;源码在 20 处读取该值;消费位置:script 行 62、script 行 100、script 行 109、script 行 110 | 需要覆盖组件默认业务值时设置。 |
layout | string | "default" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 60 | 需要调整布局或视觉表现时设置。 |
minDate | any | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 53、script 行 131 | 需要覆盖组件默认业务值时设置。 |
maxDate | any | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 54、script 行 131 | 需要覆盖组件默认业务值时设置。 |
minHour | number | 0 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 88、script 行 89、script 行 131 | 需要覆盖组件默认业务值时设置。 |
maxHour | number | 23 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 88、script 行 89、script 行 131 | 需要覆盖组件默认业务值时设置。 |
minMinute | number | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 89、script 行 131 | 需要覆盖组件默认业务值时设置。 |
maxMinute | number | 59 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 89、script 行 131 | 需要覆盖组件默认业务值时设置。 |
shortcuts | any[] | () => [] as any[] | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 112 | 需要覆盖组件默认业务值时设置。 |
builtinShortcuts | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 112 | 需要覆盖组件默认业务值时设置。 |
filter | ((type: string, value: number) => boolean) | null | null | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 78、script 行 131 | 需要覆盖组件默认业务值时设置。 |
formatter | ((type: string, value: number) => string) | null | null | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 77、script 行 131 | 需要覆盖组件默认业务值时设置。 |
title | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 58 | 需要提供业务文案或图标内容时设置。 |
showToolbar | boolean | true | 开关对应显示或交互行为;消费位置:template 行 10 | 需要控制显示、可用性或交互状态时设置。 |
loading | boolean | false | 参与组件运行逻辑;源码在 11 处读取该值;消费位置:script 行 116、script 行 117、script 行 119、script 行 122 | 需要控制显示、可用性或交互状态时设置。 |
confirmText | string | "确认" | 设置对应区域的显示文案;消费位置:template 行 15、template 行 43 | 需要提供业务文案或图标内容时设置。 |
cancelText | string | "取消" | 设置对应区域的显示文案;消费位置:template 行 13、template 行 43 | 需要提供业务文案或图标内容时设置。 |
loadingText | string | "加载中" | 设置对应区域的显示文案;消费位置:template 行 15、template 行 43 | 需要控制显示、可用性或交互状态时设置。 |
closeOnClickOverlay | boolean | true | 开关对应显示或交互行为;消费位置:template 行 8 | 需要覆盖组件默认业务值时设置。 |
safeAreaInsetBottom | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8 | 需要覆盖组件默认业务值时设置。 |
duration | number | 240 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8 | 需要覆盖组件默认业务值时设置。 |
zIndex | number | 2000 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8 | 需要覆盖组件默认业务值时设置。 |
variant | string | "glass" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 59 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
popupCustomClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 8 | 需要调整布局或视觉表现时设置。 |
showHero | boolean | true | 开关对应显示或交互行为;消费位置:script 行 62 | 需要控制显示、可用性或交互状态时设置。 |
showHeroMeta | boolean | true | 开关对应显示或交互行为;消费位置:script 行 62、template 行 20 | 需要控制显示、可用性或交互状态时设置。 |
showCurrentValue | boolean | true | 开关对应显示或交互行为;消费位置:script 行 62、template 行 24 | 需要控制显示、可用性或交互状态时设置。 |
showRangeValue | boolean | true | 开关对应显示或交互行为;消费位置:script 行 62、template 行 21 | 需要控制显示、可用性或交互状态时设置。 |
showShortcuts | boolean | true | 开关对应显示或交互行为;消费位置:script 行 63 | 需要控制显示、可用性或交互状态时设置。 |
showWheel | boolean | true | 开关对应显示或交互行为;消费位置:template 行 30 | 需要控制显示、可用性或交互状态时设置。 |
showColumnHeader | boolean | true | 开关对应显示或交互行为;消费位置:template 行 32 | 需要控制显示、可用性或交互状态时设置。 |
rangeSeparator | string | "至" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 110、template 行 21、template 行 22 | 需要覆盖组件默认业务值时设置。 |
showTrigger | boolean | false | 开关对应显示或交互行为;消费位置:template 行 3 | 需要控制显示、可用性或交互状态时设置。 |
triggerLabel | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 4 | 需要提供业务文案或图标内容时设置。 |
triggerPlaceholder | string | "请选择" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 5 | 需要提供业务文案或图标内容时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 13 处读取该值;消费位置:script 行 116、script 行 117、script 行 118、script 行 119 | 需要控制显示、可用性或交互状态时设置。 |
toolbarClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 10 | 需要调整布局或视觉表现时设置。 |
toolbarStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 65 | 需要调整布局或视觉表现时设置。 |
heroClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 19 | 需要调整布局或视觉表现时设置。 |
heroStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 67 | 需要调整布局或视觉表现时设置。 |
heroMetaClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 20 | 需要调整布局或视觉表现时设置。 |
heroMetaStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 20 | 需要调整布局或视觉表现时设置。 |
summaryClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 22、template 行 24 | 需要调整布局或视觉表现时设置。 |
summaryStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 68 | 需要调整布局或视觉表现时设置。 |
shortcutsClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 28 | 需要调整布局或视觉表现时设置。 |
shortcutsStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 28 | 需要调整布局或视觉表现时设置。 |
bodyClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 30 | 需要调整布局或视觉表现时设置。 |
bodyStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 30 | 需要调整布局或视觉表现时设置。 |
toolbarTitleColor | string | "" | 设置对应区域的颜色;消费位置:script 行 66 | 需要调整布局或视觉表现时设置。 |
toolbarBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 65 | 需要调整布局或视觉表现时设置。 |
toolbarBorderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 65 | 需要调整布局或视觉表现时设置。 |
summaryTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 68 | 需要调整布局或视觉表现时设置。 |
summaryBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 68 | 需要调整布局或视觉表现时设置。 |
summaryBorderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 68 | 需要调整布局或视觉表现时设置。 |
shortcutsTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 70 | 需要调整布局或视觉表现时设置。 |
shortcutsBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 69 | 需要调整布局或视觉表现时设置。 |
shortcutsBorderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 69 | 需要调整布局或视觉表现时设置。 |
indicatorTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 72 | 需要调整布局或视觉表现时设置。 |
indicatorBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 71 | 需要调整布局或视觉表现时设置。 |
indicatorBorderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 71 | 需要调整布局或视觉表现时设置。 |
wheelTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 73 | 需要调整布局或视觉表现时设置。 |
columnTitleTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 74 | 需要调整布局或视觉表现时设置。 |
cancelButtonTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 75、template 行 13 | 需要调整布局或视觉表现时设置。 |
cancelButtonBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 75 | 需要调整布局或视觉表现时设置。 |
cancelButtonBorderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 75 | 需要调整布局或视觉表现时设置。 |
cancelButtonStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 75 | 需要调整布局或视觉表现时设置。 |
confirmButtonTextColor | string | "" | 设置对应区域的颜色;消费位置:script 行 76、template 行 15 | 需要调整布局或视觉表现时设置。 |
confirmButtonBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 76 | 需要调整布局或视觉表现时设置。 |
confirmButtonBorderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 76 | 需要调整布局或视觉表现时设置。 |
confirmButtonStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 76 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | confirm 内触发(script 行 119);参数表达式:value;前置 guard:props.loading || props.disabled、!canConfirm.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | confirm 内触发(script 行 119);参数表达式:payload;前置 guard:props.loading || props.disabled、!canConfirm.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | confirm 内触发(script 行 119);参数表达式:payload;前置 guard:props.loading || props.disabled、!canConfirm.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | cancel 内触发(script 行 120);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:show | open 内触发(script 行 118);参数表达式:true;前置 guard:props.disabledconfirm 内触发(script 行 119);参数表达式:false;前置 guard:props.loading || props.disabled、!canConfirm.valuecancel 内触发(script 行 120);参数表达式:false | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | confirm 内触发(script 行 119);参数表达式:value;前置 guard:props.loading || props.disabled、!canConfirm.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | confirm 内触发(script 行 119);参数表达式:value;前置 guard:props.loading || props.disabled、!canConfirm.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
shortcut-click | handleShortcut 内触发(script 行 127);参数表达式:{ "item": item, "value": resolved, "mode": modeValue(), "range": props.range };前置 guard:props.disabled || props.loading | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
hero | (props: { range: boolean; mode: string; heroTitle: string; currentLabel: string; startLabel: string; endLabel: string; activeRangeKey: string; switchRangeKey: (value: string) => void }) | 仅在模板对应 <slot> 渲染位置生效。 |
hero-meta | (props: { range: boolean; mode: string; heroTitle: string }) | 仅在模板对应 <slot> 渲染位置生效。 |
range-summary | (props: { startLabel: string; endLabel: string; activeRangeKey: string; switchRangeKey: (value: string) => void; rangeSeparator: string }) | 仅在模板对应 <slot> 渲染位置生效。 |
current-summary | (props: { currentLabel: string; mode: string }) | 仅在模板对应 <slot> 渲染位置生效。 |
shortcuts | (props: { shortcuts: Shortcut[]; handleShortcut: (item: Shortcut) => void }) | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件;通过组件 ref 调用,参数和返回值按签名处理。 |
cancel | cancel(): void | 撤销当前草稿;通过组件 ref 调用,参数和返回值按签名处理。 |
confirm | confirm(): void | 提交当前草稿;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在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 或方法。 - 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。