展示

日历 AsamCalendar

以月份视图选择本地日期或展示日期说明。

使用场景 ​

以月份视图选择本地日期或展示日期说明。

基础用法与状态 ​

下列示例只使用本入口的实际公开能力。

基础用法与状态

展开源码

使用约定 ​

v-model 使用 Date;range 约束实际支持的显示范围,controllerType/formatter 设置控制和格式。date-cell 插槽接收 data,header 插槽及实例 selectDate 等能力以公开契约为准。日历不是字符串输入控件,不自动查询日程。

固定 2.14.7 完整用法 ​

下面将官方完整用途以 ASAM 公开组件和图标入口重写,TS/JS 均可直接运行。DatePicker 示例未指定 valueFormat 时显式设为空字符串,保留官方 Date 模型;ASAM 默认仍为日期文本。

基础用法 ​

基础用法

展开源码

控制器类型 ​

控制器类型

展开源码

自定义日期内容 ​

自定义日期内容

展开源码

指定范围 ​

指定范围

展开源码

自定义头部 ​

自定义头部

展开源码

年月格式与完整实例 ​

年月格式与完整实例

展开源码

本地化与高级配置 ​

通过 ConfigProvider 在中文和英文之间切换;该例使用明确公开类型配置本入口的高级属性。尺寸、模型、原生范围与两个独立端点的职责仍按前文分支生效。

日期语言和控件文字是两份配置:本例的 locale.ts / locale.js 同时注册 Day.js 的 zh-cn 日期 locale,中文每周从周一开始,英文从周日开始。 完整说明。

本地化与高级配置的完整 SFC

展开源码

API

属性 AsamCalendarProps

属性名说明类型默认值
modelValue选中项绑定值Date | undefined—
range时间范围,包括开始时间与结束时间。开始时间必须是周起始日,结束时间必须是周结束日,且时间跨度不能超过两个月。[Date, Date] | undefined—
controllerType日历头部控制器类型。enum"select" | "button"完整类型:"select" | "button" | undefined"button"
formatter当 controller-type 为“select”时的格式标签((value: number, type: "year" | "month") => string | number) | undefined—
onUpdate:modelValue—((value: Date) => any) | undefined—
onInput—((value: Date) => any) | undefined—
key—PropertyKey | undefined—
ref—VNodeRef | undefined—
ref_for—boolean | undefined—
ref_key—string | undefined—
onVnodeBeforeMount—(AsamCalendarProps)["onVnodeBeforeMount"]—
onVnodeMounted—(AsamCalendarProps)["onVnodeMounted"]—
onVnodeBeforeUpdate—(AsamCalendarProps)["onVnodeBeforeUpdate"]—
onVnodeUpdated—(AsamCalendarProps)["onVnodeUpdated"]—
onVnodeBeforeUnmount—(AsamCalendarProps)["onVnodeBeforeUnmount"]—
onVnodeUnmounted—(AsamCalendarProps)["onVnodeUnmounted"]—
class—unknown—
style—unknown—

实例方法与状态 AsamCalendarExpose

属性名说明类型默认值
$—AsamCalendarExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamCalendarProps—
$attrs—AsamCalendarExpose["$attrs"]—
$refs—AsamCalendarExpose["$refs"]—
$slots—AsamCalendarSlots—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—((event: "update:modelValue", value: Date) => void) & ((event: "input", value: Date) => void)—
$el—any—
$options—(AsamCalendarExpose)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamCalendarExpose)["$nextTick"]—
$watch—(AsamCalendarExpose)["$watch"]—
controllerType—enum"select" | "button"完整类型:"select" | "button"—
modelValue选中项绑定值Date | undefined—
range时间范围,包括开始时间与结束时间。开始时间必须是周起始日,结束时间必须是周结束日,且时间跨度不能超过两个月。[Date, Date] | undefined—
formatter当 controller-type 为“select”时的格式标签((value: number, type: "year" | "month") => string | number) | undefined—
onUpdate:modelValue—((value: Date) => any) | undefined—
onInput—((value: Date) => any) | undefined—
selectedDay当前已选日期(AsamCalendarExpose)["selectedDay"]—
pickDay—(AsamCalendarExpose)["pickDay"]—
selectDate—(type: AsamCalendarDateType) => void—
calculateValidatedDateRange—(AsamCalendarExpose)["calculateValidatedDateRange"]—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamCalendarExpose["$route"]—
$router应用使用的 Router 实例。AsamCalendarExpose["$router"]—

类型 AsamCalendarInstance

属性名说明类型默认值
$—AsamCalendarExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamCalendarProps—
$attrs—AsamCalendarExpose["$attrs"]—
$refs—AsamCalendarExpose["$refs"]—
$slots—AsamCalendarSlots—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—((event: "update:modelValue", value: Date) => void) & ((event: "input", value: Date) => void)—
$el—any—
$options—(AsamCalendarInstance)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamCalendarInstance)["$nextTick"]—
$watch—(AsamCalendarInstance)["$watch"]—
controllerType—enum"select" | "button"完整类型:"select" | "button"—
modelValue选中项绑定值Date | undefined—
range时间范围,包括开始时间与结束时间。开始时间必须是周起始日,结束时间必须是周结束日,且时间跨度不能超过两个月。[Date, Date] | undefined—
formatter当 controller-type 为“select”时的格式标签((value: number, type: "year" | "month") => string | number) | undefined—
onUpdate:modelValue—((value: Date) => any) | undefined—
onInput—((value: Date) => any) | undefined—
selectedDay当前已选日期(AsamCalendarInstance)["selectedDay"]—
pickDay—(AsamCalendarInstance)["pickDay"]—
selectDate—(type: AsamCalendarDateType) => void—
calculateValidatedDateRange—(AsamCalendarInstance)["calculateValidatedDateRange"]—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamCalendarExpose["$route"]—
$router应用使用的 Router 实例。AsamCalendarExpose["$router"]—

插槽 AsamCalendarSlots

属性名说明类型默认值
header—(AsamCalendarSlots)["header"]—
date-cell—(AsamCalendarSlots)["date-cell"]—

类型 AsamCalendarDateTableInstance

属性名说明类型默认值
$—AsamCalendarExpose["$"]—
$data—AsamTableColumnExpose—
$props—
查看完整类型{ readonly selectedDay?: AsamCalendarDateTableInstance["date"] | undefined; readonly range?: [AsamCalendarDateTableInstance["date"], AsamCalendarDateTableInstance["date"]] | undefined; readonly date: AsamCalendarDateTableInstance["date"]; readonly hideHeader?: boolean | undefined; readonly onPick?: ((value: AsamCalendarDateTableInstance["date"]) => any) | undefined | undefined; } & VNodeProps & AllowedComponentProps & ComponentCustomProps
—
$attrs—AsamCalendarExpose["$attrs"]—
$refs—AsamCalendarExpose["$refs"]—
$slots—(AsamCalendarDateTableInstance)["$slots"]—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—(event: "pick", value: AsamCalendarDateTableInstance["date"]) => void—
$el—any—
$options—(AsamCalendarDateTableInstance)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamCalendarDateTableInstance)["$nextTick"]—
$watch—(AsamCalendarDateTableInstance)["$watch"]—
range—[AsamCalendarDateTableInstance["date"], AsamCalendarDateTableInstance["date"]] | undefined—
selectedDay—AsamCalendarDateTableInstance["date"] | undefined—
date—AsamCalendarDateTableInstance["date"]—
hideHeader—boolean | undefined—
onPick—(AsamCalendarDateTableInstance)["onPick"]—
getFormattedDate切换日期面板。(AsamCalendarDateTableInstance)["getFormattedDate"]—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamCalendarExpose["$route"]—
$router应用使用的 Router 实例。AsamCalendarExpose["$router"]—

类型 AsamCalendarDateType

事件 AsamCalendarEmits

属性名说明类型默认值
update:modelValue—(value: Date) => boolean—
input—(value: Date) => boolean—

类型 AsamCalendarPropsPublic

属性名说明类型默认值
modelValue—Date | undefined—
range—[Date, Date] | undefined—
controllerType—enum"select" | "button"完整类型:(AsamCalendarPropsPublic)["controllerType"]—
formatter—((value: number, type: "year" | "month") => string | number) | undefined—

用法与契约补充说明 ​

本地化与高级配置 ​

日期语言和控件文字是两份配置:本例的 locale.ts / locale.js 同时注册 Day.js 的 zh-cn 日期 locale,中文每周从周一开始,英文从周日开始。应用需显式安装 dayjs,并保证组件与应用消费同一实例;只切换 Provider 字典不会改变周首日。注册本身不切换应用默认日期语言。固定 Calendar 的周首日在创建时读取 Day.js 全局 locale,而非 Provider 的响应式 locale;因此这个 Calendar 示例显式切换全局日期语言,并通过 key 重建表格,通过完整支持文件 date-locale-session.ts / .js 共享本示例的日期语言会话。多个示例共存时,以最近选择的日期语言作为全局语言;任意卸载顺序都会在最后一个示例退出后恢复第一次进入前的语言,避免后挂载示例保存中间状态。TS/JS 副本共享同一会话,重复释放无副作用。可观察到的其他全局语言写入会作为新的恢复基线;应用的所有日期语言写入仍应统一协调。此全局设置会影响共享同一 Day.js 的其他日期消费者;应用应统一选择全局日期语言。

参数与事件补充说明

公开绑定参数,包含具备类型的事件监听器;默认值由运行时定义提供。

参数与事件说明

modelValue

必填:否;声明来源:上游声明。

modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

range

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

controllerType

必填:否;声明来源:上游声明。

controllerType 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"select" / "button"

默认值与来源
"button"(已安装运行时;已安装组件)

固定上游文档默认:button(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'button'(2.14.7;源码事实,未作为 ASAM 运行实测)

formatter

必填:否;声明来源:上游声明。

formatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: number, type: "year" | "month"): string | number

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onUpdate:modelValue

必填:否;声明来源:上游声明。

onUpdate:modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): any

onInput

必填:否;声明来源:上游声明。

onInput 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): any

key

必填:否;声明来源:依赖声明。

ref

必填:否;声明来源:依赖声明。

ref 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(ref: Element | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null, refs: Record<string, any>): void

  • ref.value: any — 依赖声明
  • ref.__@RefSymbol@8854: true — 依赖声明

    仅用于区分类型:保留在公开声明中,通过私有 Symbol 避免出现在编辑器自动补全中。

    枚举:true

ref_for

必填:否;声明来源:依赖声明。

ref_for 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

ref_key

必填:否;声明来源:依赖声明。

onVnodeBeforeMount

必填:否;声明来源:依赖声明。

onVnodeBeforeMount 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeMounted

必填:否;声明来源:依赖声明。

onVnodeMounted 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeBeforeUpdate

必填:否;声明来源:依赖声明。

onVnodeBeforeUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>, oldVNode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeUpdated

必填:否;声明来源:依赖声明。

onVnodeUpdated 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>, oldVNode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeBeforeUnmount

必填:否;声明来源:依赖声明。

onVnodeBeforeUnmount 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeUnmounted

必填:否;声明来源:依赖声明。

onVnodeUnmounted 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

class

必填:否;声明来源:依赖声明。

style

必填:否;声明来源:依赖声明。

AsamCalendarProps 公开类型视图
ts
import type { VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNode, RendererNode, RendererElement } from 'vue';
import type { AsamCalendarProps, AsamCalendarDateType, AsamCalendarExpose } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamCalendarProps
type PublicContract = {
	readonly "modelValue"?: Date | undefined;
	readonly "range"?: [Date, Date] | undefined;
	readonly "controllerType"?: "select" | "button" | undefined;
	readonly "formatter"?: ((value: number, type: "year" | "month") => string | number) | undefined;
	readonly "onUpdate:modelValue"?: ((value: Date) => any) | undefined;
	readonly "onInput"?: ((value: Date) => any) | undefined;
	"key"?: PropertyKey | undefined;
	"ref"?: VNodeRef | undefined;
	"ref_for"?: boolean | undefined;
	"ref_key"?: string | undefined;
	"onVnodeBeforeMount"?: (AsamCalendarProps)["onVnodeBeforeMount"];
	"onVnodeMounted"?: (AsamCalendarProps)["onVnodeMounted"];
	"onVnodeBeforeUpdate"?: (AsamCalendarProps)["onVnodeBeforeUpdate"];
	"onVnodeUpdated"?: (AsamCalendarProps)["onVnodeUpdated"];
	"onVnodeBeforeUnmount"?: (AsamCalendarProps)["onVnodeBeforeUnmount"];
	"onVnodeUnmounted"?: (AsamCalendarProps)["onVnodeUnmounted"];
	"class"?: unknown;
	"style"?: unknown;
};

完整的上游实例,包含全部公开方法与响应式状态。

参数与事件说明

$

必填:是;声明来源:依赖声明。

$ 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$data

必填:是;声明来源:依赖声明。

$props

必填:是;声明来源:依赖声明。

$attrs

必填:是;声明来源:依赖声明。

$attrs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$refs

必填:是;声明来源:依赖声明。

$refs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$slots

必填:是;声明来源:依赖声明。

$root

必填:是;声明来源:依赖声明。

$parent

必填:是;声明来源:依赖声明。

$host

必填:是;声明来源:依赖声明。

$host 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

$emit

必填:是;声明来源:依赖声明。

$emit 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(event: "update:modelValue", ...args: [value: Date]): void

事件参数:(event: "input", ...args: [value: Date]): void

$el

必填:是;声明来源:依赖声明。

$options

必填:是;声明来源:依赖声明。

$forceUpdate

必填:是;声明来源:依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$nextTick

必填:是;声明来源:依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): Promise<void>

事件参数:<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$watch

必填:是;声明来源:依赖声明。

$watch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamCalendarExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

controllerType

必填:是;声明来源:上游声明。

controllerType 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"select" / "button"

modelValue

必填:否;声明来源:上游声明。

modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

range

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

formatter

必填:否;声明来源:上游声明。

formatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: number, type: "year" | "month"): string | number

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onUpdate:modelValue

必填:否;声明来源:上游声明。

onUpdate:modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): any

onInput

必填:否;声明来源:上游声明。

onInput 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): any

selectedDay

必填:是;声明来源:上游声明。

pickDay

必填:是;声明来源:上游声明。

pickDay 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(day: AsamCalendarDateTableInstance["date"]): void

selectDate

必填:是;声明来源:上游声明。

selectDate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(type: AsamCalendarDateType): void

calculateValidatedDateRange

必填:是;声明来源:上游声明。

calculateValidatedDateRange 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(startDayjs: AsamCalendarDateTableInstance["date"], endDayjs: AsamCalendarDateTableInstance["date"]): ReturnType<Extract<NonNullable<(AsamCalendarExpose)["calculateValidatedDateRange"]>, (...args: never[]) => unknown>>

$route

必填:是;声明来源:依赖声明。

$route 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamCalendarExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamCalendarExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串,使用百分号编码。

  • $route.query: (NonNullable<AsamCalendarExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段;存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前,最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串,使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段;存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前,最初尝试访问的位置。

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录,而不是添加新记录。

      枚举:false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同,也触发导航;除非传入 replace: true,否则会添加一条历史记录。

      枚举:false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamCalendarExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamCalendarExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填:是;声明来源:依赖声明。

$router 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamCalendarExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory,并配置服务器回退;createWebHashHistory 无需服务器配置,但搜索引擎无法处理其哈希路由,影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径;例如 base 为 /sub-folder 时,可将单页应用部署在域名的对应子目录。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数:(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数:(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.createHref: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["createHref"] — 依赖声明

        生成用于链接元素的对应 href。

        事件参数:(location: string): string

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。

      事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamCalendarExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数:(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。

      事件参数:(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名;未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名;未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $,使其匹配到路径结尾。

      声明默认:`true`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

  • $router.addRoute: (NonNullable<AsamCalendarExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamCalendarExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数:(): void

  • $router.currentRoute: ShallowRef<AsamCalendarExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听,这是用于微前端的底层 API。

    枚举:false / true

  • $router.hasRoute: (NonNullable<AsamCalendarExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamCalendarExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamCalendarExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamCalendarExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamCalendarExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退,等价于 router.go(-1)。

    事件参数:(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进,等价于 router.go(1)。

    事件参数:(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数:(delta: number): void

  • $router.beforeEach: (NonNullable<AsamCalendarExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫,并返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamCalendarExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamCalendarExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子,并返回移除此钩子的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamCalendarExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。

    事件参数:(handler: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise,此时关联的异步进入钩子与异步组件均已解析;导航已完成时立即兑现。可用于保持服务端与客户端渲染一致;服务端需手动推入初始位置,客户端从 URL 自动读取。

    事件参数:(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用,用户不应手动调用;客户端调用时会触发初次导航。

    事件参数:(app: App<any>): void

AsamCalendarExpose 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamCalendarExpose, AsamTableColumnExpose, AsamCalendarProps, AsamCalendarSlots, AsamCalendarDateTableInstance, AsamCalendarDateType } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamCalendarExpose
type PublicContract = {
	"$": AsamCalendarExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamCalendarProps;
	"$attrs": AsamCalendarExpose["$attrs"];
	"$refs": AsamCalendarExpose["$refs"];
	"$slots": AsamCalendarSlots;
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": ((event: "update:modelValue", value: Date) => void) & ((event: "input", value: Date) => void);
	"$el": any;
	"$options": (AsamCalendarExpose)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamCalendarExpose)["$nextTick"];
	"$watch": (AsamCalendarExpose)["$watch"];
	readonly "controllerType": "select" | "button";
	readonly "modelValue"?: Date | undefined;
	readonly "range"?: [Date, Date] | undefined;
	readonly "formatter"?: ((value: number, type: "year" | "month") => string | number) | undefined;
	readonly "onUpdate:modelValue"?: ((value: Date) => any) | undefined;
	readonly "onInput"?: ((value: Date) => any) | undefined;
	"selectedDay": (AsamCalendarExpose)["selectedDay"];
	"pickDay": (AsamCalendarExpose)["pickDay"];
	"selectDate": (type: AsamCalendarDateType) => void;
	"calculateValidatedDateRange": (AsamCalendarExpose)["calculateValidatedDateRange"];
	"$route": AsamCalendarExpose["$route"];
	"$router": AsamCalendarExpose["$router"];
};

参数与事件说明

$

必填:是;声明来源:依赖声明。

$ 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$data

必填:是;声明来源:依赖声明。

$props

必填:是;声明来源:依赖声明。

$attrs

必填:是;声明来源:依赖声明。

$attrs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$refs

必填:是;声明来源:依赖声明。

$refs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$slots

必填:是;声明来源:依赖声明。

$root

必填:是;声明来源:依赖声明。

$parent

必填:是;声明来源:依赖声明。

$host

必填:是;声明来源:依赖声明。

$host 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

$emit

必填:是;声明来源:依赖声明。

$emit 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(event: "update:modelValue", ...args: [value: Date]): void

事件参数:(event: "input", ...args: [value: Date]): void

$el

必填:是;声明来源:依赖声明。

$options

必填:是;声明来源:依赖声明。

$forceUpdate

必填:是;声明来源:依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$nextTick

必填:是;声明来源:依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): Promise<void>

事件参数:<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$watch

必填:是;声明来源:依赖声明。

$watch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamCalendarInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

controllerType

必填:是;声明来源:上游声明。

controllerType 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"select" / "button"

modelValue

必填:否;声明来源:上游声明。

modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

range

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

formatter

必填:否;声明来源:上游声明。

formatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: number, type: "year" | "month"): string | number

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onUpdate:modelValue

必填:否;声明来源:上游声明。

onUpdate:modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): any

onInput

必填:否;声明来源:上游声明。

onInput 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): any

selectedDay

必填:是;声明来源:上游声明。

pickDay

必填:是;声明来源:上游声明。

pickDay 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(day: AsamCalendarDateTableInstance["date"]): void

selectDate

必填:是;声明来源:上游声明。

selectDate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(type: AsamCalendarDateType): void

calculateValidatedDateRange

必填:是;声明来源:上游声明。

calculateValidatedDateRange 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(startDayjs: AsamCalendarDateTableInstance["date"], endDayjs: AsamCalendarDateTableInstance["date"]): ReturnType<Extract<NonNullable<(AsamCalendarInstance)["calculateValidatedDateRange"]>, (...args: never[]) => unknown>>

$route

必填:是;声明来源:依赖声明。

$route 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamCalendarExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamCalendarExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串,使用百分号编码。

  • $route.query: (NonNullable<AsamCalendarExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段;存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前,最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串,使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段;存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前,最初尝试访问的位置。

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录,而不是添加新记录。

      枚举:false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同,也触发导航;除非传入 replace: true,否则会添加一条历史记录。

      枚举:false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamCalendarExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamCalendarExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填:是;声明来源:依赖声明。

$router 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamCalendarExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory,并配置服务器回退;createWebHashHistory 无需服务器配置,但搜索引擎无法处理其哈希路由,影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径;例如 base 为 /sub-folder 时,可将单页应用部署在域名的对应子目录。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数:(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数:(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.createHref: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["createHref"] — 依赖声明

        生成用于链接元素的对应 href。

        事件参数:(location: string): string

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。

      事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamCalendarExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数:(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。

      事件参数:(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名;未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名;未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $,使其匹配到路径结尾。

      声明默认:`true`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

  • $router.addRoute: (NonNullable<AsamCalendarExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamCalendarExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数:(): void

  • $router.currentRoute: ShallowRef<AsamCalendarExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听,这是用于微前端的底层 API。

    枚举:false / true

  • $router.hasRoute: (NonNullable<AsamCalendarExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamCalendarExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamCalendarExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamCalendarExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamCalendarExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退,等价于 router.go(-1)。

    事件参数:(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进,等价于 router.go(1)。

    事件参数:(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数:(delta: number): void

  • $router.beforeEach: (NonNullable<AsamCalendarExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫,并返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamCalendarExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamCalendarExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子,并返回移除此钩子的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamCalendarExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。

    事件参数:(handler: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise,此时关联的异步进入钩子与异步组件均已解析;导航已完成时立即兑现。可用于保持服务端与客户端渲染一致;服务端需手动推入初始位置,客户端从 URL 自动读取。

    事件参数:(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用,用户不应手动调用;客户端调用时会触发初次导航。

    事件参数:(app: App<any>): void

AsamCalendarInstance 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamCalendarInstance, AsamCalendarExpose, AsamTableColumnExpose, AsamCalendarProps, AsamCalendarSlots, AsamCalendarDateTableInstance, AsamCalendarDateType } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamCalendarInstance
type PublicContract = {
	"$": AsamCalendarExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamCalendarProps;
	"$attrs": AsamCalendarExpose["$attrs"];
	"$refs": AsamCalendarExpose["$refs"];
	"$slots": AsamCalendarSlots;
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": ((event: "update:modelValue", value: Date) => void) & ((event: "input", value: Date) => void);
	"$el": any;
	"$options": (AsamCalendarInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamCalendarInstance)["$nextTick"];
	"$watch": (AsamCalendarInstance)["$watch"];
	readonly "controllerType": "select" | "button";
	readonly "modelValue"?: Date | undefined;
	readonly "range"?: [Date, Date] | undefined;
	readonly "formatter"?: ((value: number, type: "year" | "month") => string | number) | undefined;
	readonly "onUpdate:modelValue"?: ((value: Date) => any) | undefined;
	readonly "onInput"?: ((value: Date) => any) | undefined;
	"selectedDay": (AsamCalendarInstance)["selectedDay"];
	"pickDay": (AsamCalendarInstance)["pickDay"];
	"selectDate": (type: AsamCalendarDateType) => void;
	"calculateValidatedDateRange": (AsamCalendarInstance)["calculateValidatedDateRange"];
	"$route": AsamCalendarExpose["$route"];
	"$router": AsamCalendarExpose["$router"];
};

作用域插槽保留上游实例契约。

参数与事件说明

header

必填:否;声明来源:上游声明。

header 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: { date: string; }): any

date-cell

必填:否;声明来源:上游声明。

date-cell 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: { data: { isSelected: boolean; type: string; day: string; date: Date; }; }): any

AsamCalendarSlots 公开类型视图
ts
import type { AsamCalendarSlots } from '@asam-ui/ui';

// AsamCalendarSlots
type PublicContract = {
	"header"?: (AsamCalendarSlots)["header"];
	"date-cell"?: (AsamCalendarSlots)["date-cell"];
	readonly [key: string]: import("vue").Slot<any> | undefined;
};

参数与事件说明

$

必填:是;声明来源:依赖声明。

$ 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$data

必填:是;声明来源:依赖声明。

$props

必填:是;声明来源:依赖声明。

$attrs

必填:是;声明来源:依赖声明。

$attrs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$refs

必填:是;声明来源:依赖声明。

$refs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$slots

必填:是;声明来源:依赖声明。

$root

必填:是;声明来源:依赖声明。

$parent

必填:是;声明来源:依赖声明。

$host

必填:是;声明来源:依赖声明。

$host 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

$emit

必填:是;声明来源:依赖声明。

$emit 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(event: "pick", ...args: [value: AsamCalendarDateTableInstance["date"]]): void

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$el

必填:是;声明来源:依赖声明。

$options

必填:是;声明来源:依赖声明。

$forceUpdate

必填:是;声明来源:依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$nextTick

必填:是;声明来源:依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): Promise<void>

事件参数:<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$watch

必填:是;声明来源:依赖声明。

$watch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamCalendarDateTableInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

range

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

selectedDay

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

date

必填:是;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

hideHeader

必填:否;声明来源:上游声明。

hideHeader 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onPick

必填:否;声明来源:上游声明。

onPick 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: AsamCalendarDateTableInstance["date"]): any

getFormattedDate

必填:是;声明来源:上游声明。

getFormattedDate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(day: number, type: Parameters<Extract<NonNullable<(AsamCalendarDateTableInstance)["getFormattedDate"]>, (...args: never[]) => unknown>>[1]): ReturnType<Extract<NonNullable<(AsamCalendarDateTableInstance)["getFormattedDate"]>, (...args: never[]) => unknown>>

$route

必填:是;声明来源:依赖声明。

$route 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamCalendarExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamCalendarExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串,使用百分号编码。

  • $route.query: (NonNullable<AsamCalendarExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段;存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前,最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串,使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段;存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前,最初尝试访问的位置。

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录,而不是添加新记录。

      枚举:false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同,也触发导航;除非传入 replace: true,否则会添加一条历史记录。

      枚举:false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamCalendarExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamCalendarExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamCalendarExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填:是;声明来源:依赖声明。

$router 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamCalendarExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory,并配置服务器回退;createWebHashHistory 无需服务器配置,但搜索引擎无法处理其哈希路由,影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径;例如 base 为 /sub-folder 时,可将单页应用部署在域名的对应子目录。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数:(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数:(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.createHref: (NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["history"]>)["createHref"] — 依赖声明

        生成用于链接元素的对应 href。

        事件参数:(location: string): string

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。

      事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamCalendarExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数:(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。

      事件参数:(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名;未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名;未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $,使其匹配到路径结尾。

      声明默认:`true`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

  • $router.addRoute: (NonNullable<AsamCalendarExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamCalendarExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数:(): void

  • $router.currentRoute: ShallowRef<AsamCalendarExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听,这是用于微前端的底层 API。

    枚举:false / true

  • $router.hasRoute: (NonNullable<AsamCalendarExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamCalendarExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamCalendarExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamCalendarExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamCalendarExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退,等价于 router.go(-1)。

    事件参数:(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进,等价于 router.go(1)。

    事件参数:(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数:(delta: number): void

  • $router.beforeEach: (NonNullable<AsamCalendarExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫,并返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamCalendarExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamCalendarExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子,并返回移除此钩子的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamCalendarExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。

    事件参数:(handler: Parameters<Extract<NonNullable<(NonNullable<AsamCalendarExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise,此时关联的异步进入钩子与异步组件均已解析;导航已完成时立即兑现。可用于保持服务端与客户端渲染一致;服务端需手动推入初始位置,客户端从 URL 自动读取。

    事件参数:(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用,用户不应手动调用;客户端调用时会触发初次导航。

    事件参数:(app: App<any>): void

AsamCalendarDateTableInstance 公开类型视图
ts
import type { VNodeProps, AllowedComponentProps, ComponentCustomProps, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamCalendarDateTableInstance, AsamCalendarExpose, AsamTableColumnExpose, AsamCalendarProps, AsamCalendarDateType } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamCalendarDateTableInstance
type PublicContract = {
	"$": AsamCalendarExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": { readonly selectedDay?: AsamCalendarDateTableInstance["date"] | undefined; readonly range?: [AsamCalendarDateTableInstance["date"], AsamCalendarDateTableInstance["date"]] | undefined; readonly date: AsamCalendarDateTableInstance["date"]; readonly hideHeader?: boolean | undefined; readonly onPick?: ((value: AsamCalendarDateTableInstance["date"]) => any) | undefined | undefined; } & VNodeProps & AllowedComponentProps & ComponentCustomProps;
	"$attrs": AsamCalendarExpose["$attrs"];
	"$refs": AsamCalendarExpose["$refs"];
	"$slots": (AsamCalendarDateTableInstance)["$slots"];
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": (event: "pick", value: AsamCalendarDateTableInstance["date"]) => void;
	"$el": any;
	"$options": (AsamCalendarDateTableInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamCalendarDateTableInstance)["$nextTick"];
	"$watch": (AsamCalendarDateTableInstance)["$watch"];
	readonly "range"?: [AsamCalendarDateTableInstance["date"], AsamCalendarDateTableInstance["date"]] | undefined;
	readonly "selectedDay"?: AsamCalendarDateTableInstance["date"] | undefined;
	readonly "date": AsamCalendarDateTableInstance["date"];
	readonly "hideHeader"?: boolean | undefined;
	readonly "onPick"?: (AsamCalendarDateTableInstance)["onPick"];
	"getFormattedDate": (AsamCalendarDateTableInstance)["getFormattedDate"];
	"$route": AsamCalendarExpose["$route"];
	"$router": AsamCalendarExpose["$router"];
};

组合契约按分支生效;请同时查看公开类型。

AsamCalendarDateType 公开类型视图
ts
import type { AsamCalendarDateType } from '@asam-ui/ui';

// AsamCalendarDateType
type PublicContract = AsamCalendarDateType;

参数与事件说明

update:modelValue

必填:是;声明来源:上游声明。

update:modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): boolean

input

必填:是;声明来源:上游声明。

input 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: Date): boolean

AsamCalendarEmits 公开类型视图
ts
import type { AsamCalendarEmits } from '@asam-ui/ui';

// AsamCalendarEmits
type PublicContract = {
	"update:modelValue": (value: Date) => boolean;
	"input": (value: Date) => boolean;
};

参数与事件说明

modelValue

必填:否;声明来源:上游声明。

modelValue 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

range

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

controllerType

必填:否;声明来源:上游声明。

controllerType 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"select" / "button"

默认值与来源
未知 / 未声明

固定上游源码默认表达式:'button'(2.14.7;源码事实,未作为 ASAM 运行实测)

formatter

必填:否;声明来源:上游声明。

formatter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: number, type: "year" | "month"): string | number

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

AsamCalendarPropsPublic 公开类型视图
ts
import type { AsamCalendarPropsPublic, AsamCalendarProps, AsamCalendarDateType } from '@asam-ui/ui';

// AsamCalendarPropsPublic
type PublicContract = {
	readonly "modelValue"?: Date | undefined;
	readonly "range"?: [Date, Date] | undefined;
	readonly "controllerType"?: (AsamCalendarPropsPublic)["controllerType"];
	readonly "formatter"?: ((value: number, type: "year" | "month") => string | number) | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭