Skip to content

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 默认值实际行为 / 范围适用范围
showbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 27、script 行 128需要控制显示、可用性或交互状态时设置。
valueany""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 108、script 行 129需要覆盖组件默认业务值时设置。
modelValueanynull参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 108、script 行 113、script 行 129需要覆盖组件默认业务值时设置。
modestring"date"参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 56、script 行 131需要覆盖组件默认业务值时设置。
showSecondsbooleanfalse开关对应显示或交互行为;消费位置:script 行 95、script 行 107、script 行 131需要控制显示、可用性或交互状态时设置。
rangebooleanfalse参与组件运行逻辑;源码在 20 处读取该值;消费位置:script 行 62、script 行 100、script 行 109、script 行 110需要覆盖组件默认业务值时设置。
layoutstring"default"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 60需要调整布局或视觉表现时设置。
minDateany""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 53、script 行 131需要覆盖组件默认业务值时设置。
maxDateany""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 54、script 行 131需要覆盖组件默认业务值时设置。
minHournumber0参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 88、script 行 89、script 行 131需要覆盖组件默认业务值时设置。
maxHournumber23参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 88、script 行 89、script 行 131需要覆盖组件默认业务值时设置。
minMinutenumber0参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 89、script 行 131需要覆盖组件默认业务值时设置。
maxMinutenumber59参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 89、script 行 131需要覆盖组件默认业务值时设置。
shortcutsany[]() => [] as any[]参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 112需要覆盖组件默认业务值时设置。
builtinShortcutsbooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 112需要覆盖组件默认业务值时设置。
filter((type: string, value: number) => boolean) | nullnull参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 78、script 行 131需要覆盖组件默认业务值时设置。
formatter((type: string, value: number) => string) | nullnull参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 77、script 行 131需要覆盖组件默认业务值时设置。
titlestring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 58需要提供业务文案或图标内容时设置。
showToolbarbooleantrue开关对应显示或交互行为;消费位置:template 行 10需要控制显示、可用性或交互状态时设置。
loadingbooleanfalse参与组件运行逻辑;源码在 11 处读取该值;消费位置:script 行 116、script 行 117、script 行 119、script 行 122需要控制显示、可用性或交互状态时设置。
confirmTextstring"确认"设置对应区域的显示文案;消费位置:template 行 15、template 行 43需要提供业务文案或图标内容时设置。
cancelTextstring"取消"设置对应区域的显示文案;消费位置:template 行 13、template 行 43需要提供业务文案或图标内容时设置。
loadingTextstring"加载中"设置对应区域的显示文案;消费位置:template 行 15、template 行 43需要控制显示、可用性或交互状态时设置。
closeOnClickOverlaybooleantrue开关对应显示或交互行为;消费位置:template 行 8需要覆盖组件默认业务值时设置。
safeAreaInsetBottombooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
durationnumber240参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
zIndexnumber2000参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
variantstring"glass"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 59需要调整布局或视觉表现时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
popupCustomClassstring""追加到对应内部区域的 class;消费位置:template 行 8需要调整布局或视觉表现时设置。
showHerobooleantrue开关对应显示或交互行为;消费位置:script 行 62需要控制显示、可用性或交互状态时设置。
showHeroMetabooleantrue开关对应显示或交互行为;消费位置:script 行 62、template 行 20需要控制显示、可用性或交互状态时设置。
showCurrentValuebooleantrue开关对应显示或交互行为;消费位置:script 行 62、template 行 24需要控制显示、可用性或交互状态时设置。
showRangeValuebooleantrue开关对应显示或交互行为;消费位置:script 行 62、template 行 21需要控制显示、可用性或交互状态时设置。
showShortcutsbooleantrue开关对应显示或交互行为;消费位置:script 行 63需要控制显示、可用性或交互状态时设置。
showWheelbooleantrue开关对应显示或交互行为;消费位置:template 行 30需要控制显示、可用性或交互状态时设置。
showColumnHeaderbooleantrue开关对应显示或交互行为;消费位置:template 行 32需要控制显示、可用性或交互状态时设置。
rangeSeparatorstring"至"参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 110、template 行 21、template 行 22需要覆盖组件默认业务值时设置。
showTriggerbooleanfalse开关对应显示或交互行为;消费位置:template 行 3需要控制显示、可用性或交互状态时设置。
triggerLabelstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 4需要提供业务文案或图标内容时设置。
triggerPlaceholderstring"请选择"参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 5需要提供业务文案或图标内容时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 13 处读取该值;消费位置:script 行 116、script 行 117、script 行 118、script 行 119需要控制显示、可用性或交互状态时设置。
toolbarClassstring""追加到对应内部区域的 class;消费位置:template 行 10需要调整布局或视觉表现时设置。
toolbarStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 65需要调整布局或视觉表现时设置。
heroClassstring""追加到对应内部区域的 class;消费位置:template 行 19需要调整布局或视觉表现时设置。
heroStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 67需要调整布局或视觉表现时设置。
heroMetaClassstring""追加到对应内部区域的 class;消费位置:template 行 20需要调整布局或视觉表现时设置。
heroMetaStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 20需要调整布局或视觉表现时设置。
summaryClassstring""追加到对应内部区域的 class;消费位置:template 行 22、template 行 24需要调整布局或视觉表现时设置。
summaryStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 68需要调整布局或视觉表现时设置。
shortcutsClassstring""追加到对应内部区域的 class;消费位置:template 行 28需要调整布局或视觉表现时设置。
shortcutsStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 28需要调整布局或视觉表现时设置。
bodyClassstring""追加到对应内部区域的 class;消费位置:template 行 30需要调整布局或视觉表现时设置。
bodyStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 30需要调整布局或视觉表现时设置。
toolbarTitleColorstring""设置对应区域的颜色;消费位置:script 行 66需要调整布局或视觉表现时设置。
toolbarBgColorstring""设置对应区域的颜色;消费位置:script 行 65需要调整布局或视觉表现时设置。
toolbarBorderColorstring""设置对应区域的颜色;消费位置:script 行 65需要调整布局或视觉表现时设置。
summaryTextColorstring""设置对应区域的颜色;消费位置:script 行 68需要调整布局或视觉表现时设置。
summaryBgColorstring""设置对应区域的颜色;消费位置:script 行 68需要调整布局或视觉表现时设置。
summaryBorderColorstring""设置对应区域的颜色;消费位置:script 行 68需要调整布局或视觉表现时设置。
shortcutsTextColorstring""设置对应区域的颜色;消费位置:script 行 70需要调整布局或视觉表现时设置。
shortcutsBgColorstring""设置对应区域的颜色;消费位置:script 行 69需要调整布局或视觉表现时设置。
shortcutsBorderColorstring""设置对应区域的颜色;消费位置:script 行 69需要调整布局或视觉表现时设置。
indicatorTextColorstring""设置对应区域的颜色;消费位置:script 行 72需要调整布局或视觉表现时设置。
indicatorBgColorstring""设置对应区域的颜色;消费位置:script 行 71需要调整布局或视觉表现时设置。
indicatorBorderColorstring""设置对应区域的颜色;消费位置:script 行 71需要调整布局或视觉表现时设置。
wheelTextColorstring""设置对应区域的颜色;消费位置:script 行 73需要调整布局或视觉表现时设置。
columnTitleTextColorstring""设置对应区域的颜色;消费位置:script 行 74需要调整布局或视觉表现时设置。
cancelButtonTextColorstring""设置对应区域的颜色;消费位置:script 行 75、template 行 13需要调整布局或视觉表现时设置。
cancelButtonBgColorstring""设置对应区域的颜色;消费位置:script 行 75需要调整布局或视觉表现时设置。
cancelButtonBorderColorstring""设置对应区域的颜色;消费位置:script 行 75需要调整布局或视觉表现时设置。
cancelButtonStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 75需要调整布局或视觉表现时设置。
confirmButtonTextColorstring""设置对应区域的颜色;消费位置:script 行 76、template 行 15需要调整布局或视觉表现时设置。
confirmButtonBgColorstring""设置对应区域的颜色;消费位置:script 行 76需要调整布局或视觉表现时设置。
confirmButtonBorderColorstring""设置对应区域的颜色;消费位置:script 行 76需要调整布局或视觉表现时设置。
confirmButtonStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 76需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
inputconfirm 内触发(script 行 119);参数表达式:value;前置 guard:props.loading || props.disabled、!canConfirm.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changeconfirm 内触发(script 行 119);参数表达式:payload;前置 guard:props.loading || props.disabled、!canConfirm.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
confirmconfirm 内触发(script 行 119);参数表达式:payload;前置 guard:props.loading || props.disabled、!canConfirm.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
cancelcancel 内触发(script 行 120);参数表达式:无回调参数(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:showopen 内触发(script 行 118);参数表达式:true;前置 guard:props.disabled
confirm 内触发(script 行 119);参数表达式:false;前置 guard:props.loading || props.disabled、!canConfirm.value
cancel 内触发(script 行 120);参数表达式:false
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:valueconfirm 内触发(script 行 119);参数表达式:value;前置 guard:props.loading || props.disabled、!canConfirm.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValueconfirm 内触发(script 行 119);参数表达式:value;前置 guard:props.loading || props.disabled、!canConfirm.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
shortcut-clickhandleShortcut 内触发(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> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
openopen(): void打开组件;通过组件 ref 调用,参数和返回值按签名处理。
cancelcancel(): void撤销当前草稿;通过组件 ref 调用,参数和返回值按签名处理。
confirmconfirm(): 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。

MIT Licensed