Appearance
xtf-calendar
组件说明
xtf-calendar 是日历，用于选择单日、多日或日期范围。当前实现读取 value 数据、通过 update:modelValue 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-calendar/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfCalendar value="2026-10-28" />
</view>
</template>
<script setup lang="uts">
import XtfCalendar from "@/uni_modules/xtf-linkuiunix/components/xtf-calendar/xtf-calendar.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfCalendar value="2026-10-28" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfCalendar from "@/uni_modules/xtf-linkuiunix/components/xtf-calendar/xtf-calendar.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-calendar:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 multiple 状态
运行时切换 multiple，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfCalendar value="2026-10-28" :multiple="state" />
<button class="doc-action-button" @click="toggleState">切换 multiple</button>
<text class="doc-state-text">multiple: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfCalendar from "@/uni_modules/xtf-linkuiunix/components/xtf-calendar/xtf-calendar.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("multiple", 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. 定制 dateCell 插槽
使用源码真实声明的 dateCell slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfCalendar value="2026-10-28">
<template #dateCell="scope"><text class="doc-content-text">自定义 dateCell 内容：{{ scope.day }}</text></template>
</XtfCalendar>
</view>
</template>
<script setup lang="uts">
import XtfCalendar from "@/uni_modules/xtf-linkuiunix/components/xtf-calendar/xtf-calendar.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 goToday()
调用该公开实例能力；签名为 goToday(): void。
vue
<template>
<view class="doc-method">
<XtfCalendar value="2026-10-28" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfCalendar from "@/uni_modules/xtf-linkuiunix/components/xtf-calendar/xtf-calendar.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.goToday(); console.log("调用 goToday") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | string | Array<string> | undefined | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 137、script 行 148、script 行 149 | 需要覆盖组件默认业务值时设置。 |
value | string | Array<string> | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 137、script 行 149 | 需要覆盖组件默认业务值时设置。 |
defaultValue | string | Array<string> | "" | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 137 | 需要覆盖组件默认业务值时设置。 |
default | string | Array<string> | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 137 | 需要覆盖组件默认业务值时设置。 |
range | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 135 | 需要覆盖组件默认业务值时设置。 |
multiple | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 135 | 需要控制显示、可用性或交互状态时设置。 |
mode | CalendarMode | "single" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 135 | 需要覆盖组件默认业务值时设置。 |
current | string | "" | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 140、script 行 235 | 需要覆盖组件默认业务值时设置。 |
minDate | string | "" | 参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 172、script 行 178、script 行 205、script 行 227 | 需要覆盖组件默认业务值时设置。 |
maxDate | string | "" | 参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 173、script 行 178、script 行 205、script 行 227 | 需要覆盖组件默认业务值时设置。 |
disabledDates | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 180 | 需要控制显示、可用性或交互状态时设置。 |
disabledDate | (day: CalendarDay) => boolean | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 197 | 需要控制显示、可用性或交互状态时设置。 |
disableBlocked | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 194 | 需要覆盖组件默认业务值时设置。 |
marks | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 175 | 需要覆盖组件默认业务值时设置。 |
statuses | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 176 | 需要覆盖组件默认业务值时设置。 |
shortcuts | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 165 | 需要覆盖组件默认业务值时设置。 |
weekendHighlight | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 196 | 需要覆盖组件默认业务值时设置。 |
firstDayOfWeek | number | 1 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 136 | 需要覆盖组件默认业务值时设置。 |
weekStart | number | -1 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 136 | 需要覆盖组件默认业务值时设置。 |
showHeader | boolean | true | 开关对应显示或交互行为；消费位置：template 行 3 | 需要控制显示、可用性或交互状态时设置。 |
showWeekdays | boolean | true | 开关对应显示或交互行为；消费位置：template 行 21 | 需要控制显示、可用性或交互状态时设置。 |
showAdjacentMonths | boolean | true | 开关对应显示或交互行为；消费位置：script 行 194 | 需要控制显示、可用性或交互状态时设置。 |
readonly | boolean | false | 参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 210、script 行 221、script 行 222、script 行 223 | 需要控制显示、可用性或交互状态时设置。 |
allowSameDay | boolean | true | 开关对应显示或交互行为；消费位置：script 行 215、script 行 222、script 行 223、script 行 225 | 需要覆盖组件默认业务值时设置。 |
maxRange | number | 0 | 参与组件运行逻辑；源码在 8 处读取该值；消费位置：script 行 194、script 行 222、script 行 223、script 行 225 | 需要覆盖组件默认业务值时设置。 |
showMonthPicker | boolean | true | 开关对应显示或交互行为；消费位置：script 行 228、template 行 5 | 需要控制显示、可用性或交互状态时设置。 |
showMonthSwitch | boolean | true | 开关对应显示或交互行为；消费位置：template 行 4、template 行 6 | 需要控制显示、可用性或交互状态时设置。 |
showHeaderClear | boolean | false | 开关对应显示或交互行为；消费位置：template 行 6 | 需要控制显示、可用性或交互状态时设置。 |
headerClearText | string | "" | 设置对应区域的显示文案；消费位置：template 行 6 | 需要提供业务文案或图标内容时设置。 |
showTodayButton | boolean | false | 开关对应显示或交互行为；消费位置：template 行 6 | 需要控制显示、可用性或交互状态时设置。 |
todayButtonText | string | "" | 设置对应区域的显示文案；消费位置：template 行 6 | 需要提供业务文案或图标内容时设置。 |
showFooter | boolean | false | 开关对应显示或交互行为；消费位置：script 行 164 | 需要控制显示、可用性或交互状态时设置。 |
showClear | boolean | false | 开关对应显示或交互行为；消费位置：script 行 164、template 行 42 | 需要控制显示、可用性或交互状态时设置。 |
showCancel | boolean | false | 开关对应显示或交互行为；消费位置：script 行 164、template 行 43 | 需要控制显示、可用性或交互状态时设置。 |
showConfirm | boolean | false | 开关对应显示或交互行为；消费位置：script 行 164、template 行 44 | 需要控制显示、可用性或交互状态时设置。 |
showSelection | boolean | false | 开关对应显示或交互行为；消费位置：script 行 164、template 行 40 | 需要控制显示、可用性或交互状态时设置。 |
clearText | string | "清空" | 设置对应区域的显示文案；消费位置：template 行 6、template 行 42 | 需要提供业务文案或图标内容时设置。 |
cancelText | string | "取消" | 设置对应区域的显示文案；消费位置：template 行 43 | 需要提供业务文案或图标内容时设置。 |
confirmText | string | "确认" | 设置对应区域的显示文案；消费位置：template 行 44 | 需要提供业务文案或图标内容时设置。 |
activeColor | string | "" | 设置对应区域的颜色；消费位置：script 行 163 | 需要调整布局或视觉表现时设置。 |
activeTextColor | string | "" | 设置对应区域的颜色；消费位置：script 行 163 | 需要调整布局或视觉表现时设置。 |
rangeColor | string | "" | 设置对应区域的颜色；消费位置：script 行 163 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 162 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 163 | 需要调整布局或视觉表现时设置。 |
lunar | boolean | false | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
showLunar | boolean | false | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
holidays | any | null | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
CalendarDay 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
value | string | 业务值 |
date | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
year | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
month | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isCurrentMonth | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isToday | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isWeekend | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isDisabled | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isSelected | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isInRange | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isRangeStart | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
isRangeEnd | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
markLabel | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
markColor | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
statusLabel | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
statusType | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
subLabel | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
className | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
textClass | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
cellStyle | UTSJSONObject | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | updateValue 内触发（script 行 207）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | updateValue 内触发（script 行 207）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
input | updateValue 内触发（script 行 207）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | updateValue 内触发（script 行 207）；参数表达式：{ value, type, mode: mode.value, day } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
select | selectDay 内触发（script 行 219）；参数表达式：{ value: next, day, mode: mode.value }；前置 guard：suppressClick.value、props.readonly、day.isDisabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | confirmSelection 内触发（script 行 234）；参数表达式：{ value: currentValue.value, selectedValues: selectedValues.value, mode: mode.value, completed: mode.value == "range" ? selectedValues.value.length == 2 : selectedValues.value.length > 0 } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | cancelSelection 内触发（script 行 233）；参数表达式：{ value: currentValue.value, mode: mode.value } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
clear | clearSelection 内触发（script 行 232）；参数表达式：{ value, mode: mode.value }；前置 guard：props.readonly | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
invalid | selectDay 内触发（script 行 211）；参数表达式：{ day, mode: mode.value }；前置 guard：suppressClick.value、props.readonly、day.isDisabledhandleDragging 内触发（script 行 222）；参数表达式：{ day, mode: mode.value }；前置 guard：!dragActive.value || props.readonly || mode.value != "range" || day.isDisabled、(props.maxRange > 0 && distance(value[0], value[1]) > props.maxRange) || (!props.allowSameDay && value[0] == value[1])handleDragEnd 内触发（script 行 223）；参数表达式：{ day, mode: mode.value }；前置 guard：!dragActive.value、props.readonly || mode.value != "range" || day.isDisabled、(props.maxRange > 0 && distance(value[0], value[1]) > props.maxRange) || (!props.allowSameDay && value[0] == value[1])applyShortcut 内触发（script 行 225）；参数表达式：{ value, mode: mode.value }；前置 guard：props.readonly、first == null || first.length == 0、values.some((value) => { const date = parseDate(value); return date == null || createDay(date, false).isDisabled }) || (mode.value == "range" && values.length == 2 && ((props.maxRange > 0 && distance(values[0], values[1]) > props.maxRange) || (!props.allowSameDay && values[0] == values[1]))) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
month-change | changeMonth 内触发（script 行 226）；参数表达式：formatDate(panelDate.value)；前置 guard：(offset < 0 && prevDisabled.value) || (offset > 0 && nextDisabled.value)goToday 内触发（script 行 227）；参数表达式：formatDate(panelDate.value)；前置 guard：(min.length > 0 && today < min) || (max.length > 0 && today > max)、date == nullselectMonth 内触发（script 行 231）；参数表达式：formatDate(panelDate.value)；前置 guard：month.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
month-picker-change | toggleMonthPicker 内触发（script 行 228）；参数表达式：{ visible: monthPickerVisible.value, year: pickerYear.value }；前置 guard：!props.showMonthPickerselectMonth 内触发（script 行 231）；参数表达式：{ visible: false, year: pickerYear.value, month: (month.value as number) + 1 }；前置 guard：month.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
shortcut-click | applyShortcut 内触发（script 行 225）；参数表达式：{ item, value }；前置 guard：props.readonly、first == null || first.length == 0、values.some((value) => { const date = parseDate(value); return date == null || createDay(date, false).isDisabled }) || (mode.value == "range" && values.length == 2 && ((props.maxRange > 0 && distance(values[0], values[1]) > props.maxRange) || (!props.allowSameDay && values[0] == values[1]))) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
range-start | selectDay 内触发（script 行 216）；参数表达式：{ value: day.value, day }；前置 guard：suppressClick.value、props.readonly、day.isDisabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
range-end | selectDay 内触发（script 行 217）；参数表达式：{ value: next, day }；前置 guard：suppressClick.value、props.readonly、day.isDisabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
drag-start | handleDragStart 内触发（script 行 221）；参数表达式：{ day, value: day.value }；前置 guard：mode.value != "range" || props.readonly || day.isDisabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
dragging | handleDragging 内触发（script 行 222）；参数表达式：{ day, value }；前置 guard：!dragActive.value || props.readonly || mode.value != "range" || day.isDisabled、(props.maxRange > 0 && distance(value[0], value[1]) > props.maxRange) || (!props.allowSameDay && value[0] == value[1]) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
drag-end | handleDragEnd 内触发（script 行 223）；参数表达式：{ day, value }；前置 guard：!dragActive.value、props.readonly || mode.value != "range" || day.isDisabled、(props.maxRange > 0 && distance(value[0], value[1]) > props.maxRange) || (!props.allowSameDay && value[0] == value[1]) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
dateCell | { day } | 仅在模板对应 <slot> 渲染位置生效。 |
footer | { value, selectedValues, selectionText, clear, confirm, cancel } | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
changeMonth | changeMonth(offset: number): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
goToday | goToday(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
applyShortcut | applyShortcut(item: any): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
clearSelection | clearSelection(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
confirmSelection | confirmSelection(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
cancelSelection | cancelSelection(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-calendar-active)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-calendar-active-text)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-calendar-range)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-border)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger)：组件样式实际读取的主题变量，可在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-surface-muted)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-warning)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-warning-soft)：组件样式实际读取的主题变量，可在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：
lunar、showLunar、holidays。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。