ASAM UI
v1.0.0

展示

描述列表项 AsamDescriptionsItem

按名称和值展示一组概要信息。

使用场景 ​

按名称和值展示一组概要信息。

基础用法与状态 ​

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

基础用法与状态

展开源码

使用约定 ​

label 或 label 插槽提供名称，default 插槽提供值；span/rowspan、width/minWidth/labelWidth、align/labelAlign 与 className/labelClassName 设置布局。必须在 Descriptions 中使用，密度由父级列表管理。

本入口保留原生描述项的公开参数与组件名称，名称识别与布局由描述列表处理。不会补写未传的 span/rowspan 或改写调用方节点；遇到原生同输入限制时按依赖的实际行为处理。

根入口与深入口导出同一个 ASAM 公开定义，沿用原生 props 与组件名称，仅提供 ASAM 名称的 install。 完整说明。

组合用法 ​

在 AsamDescriptions 的完整场景中使用本入口；包含 basic-usage、sizes、vertical-list、rowspan、customized-style。

API

属性 AsamDescriptionsItemProps

属性名说明类型默认值
label标签位置显示的内容string | undefined""
className列的内容自定义类名string | undefined""
width列的宽度，不同行相同列的宽度按最大值设定（如无 border ，宽度包含标签与内容）(AsamDescriptionsItemProps)["width"]""
span列的数量number | undefined1
minWidth列的最小宽度，与 width 的区别是 width 是固定的，min-width 会把剩余宽度按比例分配给设置了 min-width 的列（如无 border，宽度包含标签与内容）(AsamDescriptionsItemProps)["minWidth"]""
rowspan单元格应该跨越的行数number | undefined1
align列的内容对齐方式（如无 border，对标签和内容均生效）enum"right" | "left" | "center"完整类型：(AsamDescriptionsItemProps)["align"]"left"
labelClassNamecolumn label custom class namestring | undefined""
style—unknown—
key—PropertyKey | undefined—
ref—VNodeRef | undefined—
ref_for—boolean | undefined—
ref_key—string | undefined—
onVnodeBeforeMount—(AsamDescriptionsItemProps)["onVnodeBeforeMount"]—
onVnodeMounted—(AsamDescriptionsItemProps)["onVnodeMounted"]—
onVnodeBeforeUpdate—(AsamDescriptionsItemProps)["onVnodeBeforeUpdate"]—
onVnodeUpdated—(AsamDescriptionsItemProps)["onVnodeUpdated"]—
onVnodeBeforeUnmount—(AsamDescriptionsItemProps)["onVnodeBeforeUnmount"]—
onVnodeUnmounted—(AsamDescriptionsItemProps)["onVnodeUnmounted"]—
class—unknown—
labelWidth列标签宽，如果未设置，它将与列宽度相同。比 Descriptions 的 label-width 优先级高(AsamDescriptionsItemProps)["labelWidth"]—
labelAlign列的标签对齐方式，若不设置该项，则使用内容的对齐方式（如无 border，请使用 align 参数）enum"right" | "left" | "center"完整类型：(AsamDescriptionsItemProps)["labelAlign"]—

实例方法与状态 AsamDescriptionsItemExpose

属性名说明类型默认值
$—AsamDescriptionsItemExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamDescriptionsItemProps—
$attrs—AsamDescriptionsItemExpose["$attrs"]—
$refs—AsamDescriptionsItemExpose["$refs"]—
$slots—AsamAvatarGroupSlots—
$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: string, ...args: any[]) => void—
$el—any—
$options—(AsamDescriptionsItemExpose)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamDescriptionsItemExpose)["$nextTick"]—
$watch—(AsamDescriptionsItemExpose)["$watch"]—
label—string—
className—string—
width—(AsamDescriptionsItemExpose)["width"]—
span—number—
minWidth—(AsamDescriptionsItemExpose)["minWidth"]—
rowspan—number—
align—enum"right" | "left" | "center"完整类型：(AsamDescriptionsItemExpose)["align"]—
labelClassName—string—
labelWidth—(AsamDescriptionsItemExpose)["labelWidth"]—
labelAlign—enum"right" | "left" | "center"完整类型：(AsamDescriptionsItemExpose)["labelAlign"]—
$route当前规范化路由位置，详见 RouteLocationNormalizedLoaded。AsamDescriptionsItemExpose["$route"]—
$router应用使用的 Router 实例。AsamDescriptionsItemExpose["$router"]—

类型 AsamDescriptionsItemInstance

属性名说明类型默认值
$—AsamDescriptionsItemExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamDescriptionsItemProps—
$attrs—AsamDescriptionsItemExpose["$attrs"]—
$refs—AsamDescriptionsItemExpose["$refs"]—
$slots—AsamAvatarGroupSlots—
$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: string, ...args: any[]) => void—
$el—any—
$options—(AsamDescriptionsItemInstance)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamDescriptionsItemInstance)["$nextTick"]—
$watch—(AsamDescriptionsItemInstance)["$watch"]—
label—string—
className—string—
width—(AsamDescriptionsItemInstance)["width"]—
span—number—
minWidth—(AsamDescriptionsItemInstance)["minWidth"]—
rowspan—number—
align—enum"right" | "left" | "center"完整类型：(AsamDescriptionsItemInstance)["align"]—
labelClassName—string—
labelWidth—(AsamDescriptionsItemInstance)["labelWidth"]—
labelAlign—enum"right" | "left" | "center"完整类型：(AsamDescriptionsItemInstance)["labelAlign"]—
$route当前规范化路由位置，详见 RouteLocationNormalizedLoaded。AsamDescriptionsItemExpose["$route"]—
$router应用使用的 Router 实例。AsamDescriptionsItemExpose["$router"]—

插槽 AsamDescriptionsItemSlots

属性名说明类型默认值
default描述项内容。Slot | undefined—
label描述项标签。Slot | undefined—

用法与契约补充说明 ​

使用约定 ​

根入口与深入口导出同一个 ASAM 公开定义，沿用原生 props 与组件名称，仅提供 ASAM 名称的 install。SFC 中可直接导入 AsamDescriptionsItem；单组件 app.use(AsamDescriptionsItem) 与全量 AsamUIFull 都保留 AsamDescriptionsItem 注册名。组件不修改原生对象的 name/install，也不补写节点参数或接管原生布局。

描述列表 AsamDescriptions
参数与事件补充说明

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

参数与事件说明

label

必填：否；声明来源：上游声明。

默认值与来源
""（已安装运行时；已安装组件）
className

必填：否；声明来源：上游声明。

默认值与来源
""（已安装运行时；已安装组件）
width

必填：否；声明来源：上游声明。

默认值与来源
""（已安装运行时；已安装组件）
span

必填：否；声明来源：上游声明。

默认值与来源
1（已安装运行时；已安装组件）
minWidth

必填：否；声明来源：上游声明。

默认值与来源
""（已安装运行时；已安装组件）
rowspan

必填：否；声明来源：上游声明。

默认值与来源
1（已安装运行时；已安装组件）
align

必填：否；声明来源：上游声明。

align 参数与事件数据

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

枚举："right" / "left" / "center"

默认值与来源
"left"（已安装运行时；已安装组件）
labelClassName

必填：否；声明来源：上游声明。

默认值与来源
""（已安装运行时；已安装组件）
style

必填：否；声明来源：依赖声明。

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

必填：否；声明来源：依赖声明。

labelWidth

必填：否；声明来源：上游声明。

labelAlign

必填：否；声明来源：上游声明。

labelAlign 参数与事件数据

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

枚举："right" / "left" / "center"

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

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

// AsamDescriptionsItemProps
type PublicContract = {
	"label"?: string | undefined;
	"className"?: string | undefined;
	"width"?: (AsamDescriptionsItemProps)["width"];
	"span"?: number | undefined;
	"minWidth"?: (AsamDescriptionsItemProps)["minWidth"];
	"rowspan"?: number | undefined;
	"align"?: (AsamDescriptionsItemProps)["align"];
	"labelClassName"?: string | undefined;
	"style"?: unknown;
	"key"?: PropertyKey | undefined;
	"ref"?: VNodeRef | undefined;
	"ref_for"?: boolean | undefined;
	"ref_key"?: string | undefined;
	"onVnodeBeforeMount"?: (AsamDescriptionsItemProps)["onVnodeBeforeMount"];
	"onVnodeMounted"?: (AsamDescriptionsItemProps)["onVnodeMounted"];
	"onVnodeBeforeUpdate"?: (AsamDescriptionsItemProps)["onVnodeBeforeUpdate"];
	"onVnodeUpdated"?: (AsamDescriptionsItemProps)["onVnodeUpdated"];
	"onVnodeBeforeUnmount"?: (AsamDescriptionsItemProps)["onVnodeBeforeUnmount"];
	"onVnodeUnmounted"?: (AsamDescriptionsItemProps)["onVnodeUnmounted"];
	"class"?: unknown;
	readonly "labelWidth"?: (AsamDescriptionsItemProps)["labelWidth"];
	readonly "labelAlign"?: (AsamDescriptionsItemProps)["labelAlign"];
};

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

参数与事件说明

$

必填：是；声明来源：依赖声明。

$ 参数与事件数据

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

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

$data

必填：是；声明来源：依赖声明。

$props

必填：是；声明来源：依赖声明。

$attrs

必填：是；声明来源：依赖声明。

$attrs 参数与事件数据

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

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

$refs

必填：是；声明来源：依赖声明。

$refs 参数与事件数据

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

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

$slots

必填：是；声明来源：依赖声明。

$slots 参数与事件数据

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

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

$root

必填：是；声明来源：依赖声明。

$parent

必填：是；声明来源：依赖声明。

$host

必填：是；声明来源：依赖声明。

$host 参数与事件数据

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

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

$emit

必填：是；声明来源：依赖声明。

$emit 参数与事件数据

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

事件参数：(event: string, ...args: any[]): void

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

$el

必填：是；声明来源：依赖声明。

$options

必填：是；声明来源：依赖声明。

$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<(AsamDescriptionsItemExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

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

label

必填：是；声明来源：上游声明。

className

必填：是；声明来源：上游声明。

width

必填：是；声明来源：上游声明。

width 参数与事件数据

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

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

span

必填：是；声明来源：上游声明。

minWidth

必填：是；声明来源：上游声明。

minWidth 参数与事件数据

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

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

rowspan

必填：是；声明来源：上游声明。

align

必填：是；声明来源：上游声明。

align 参数与事件数据

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

枚举："right" / "left" / "center"

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

labelClassName

必填：是；声明来源：上游声明。

labelWidth

必填：否；声明来源：上游声明。

labelAlign

必填：否；声明来源：上游声明。

labelAlign 参数与事件数据

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

枚举："right" / "left" / "center"

$route

必填：是；声明来源：依赖声明。

$route 参数与事件数据

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

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

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

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

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

    匹配路由记录的名称。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      匹配路由记录的名称。

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

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

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

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

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

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

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

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

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

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

$router

必填：是；声明来源：依赖声明。

$router 参数与事件数据

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

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

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

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

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

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

    • $router.options.history: (NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

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

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

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

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

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

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

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

        事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

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

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

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

      • $router.options.history.createHref: (location: AsamDescriptionsItemExpose["label"]) => string — 依赖声明

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

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

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

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

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

        事件参数：(): void

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

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

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

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

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

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

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

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

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

      事件参数：(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["addRoute"] — 依赖声明

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

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

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

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

    按名称移除已有路由。

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

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

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

    事件参数：(): void

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

    当前 RouteLocationNormalized。

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

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

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

    枚举：false / true

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["beforeEach"] — 依赖声明

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

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

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

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

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

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

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

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

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

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

    事件参数：(handler: Parameters<Extract<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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

AsamDescriptionsItemExpose 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ExtractPropTypes, PropType, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamDescriptionsItemExpose, AsamTableColumnExpose, AsamDescriptionsItemProps, AsamAvatarGroupSlots } from '@asam-ui/ui';

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

// AsamDescriptionsItemExpose
type PublicContract = {
	"$": AsamDescriptionsItemExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamDescriptionsItemProps;
	"$attrs": AsamDescriptionsItemExpose["$attrs"];
	"$refs": AsamDescriptionsItemExpose["$refs"];
	"$slots": AsamAvatarGroupSlots;
	"$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: string, ...args: any[]) => void;
	"$el": any;
	"$options": (AsamDescriptionsItemExpose)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamDescriptionsItemExpose)["$nextTick"];
	"$watch": (AsamDescriptionsItemExpose)["$watch"];
	readonly "label": string;
	readonly "className": string;
	readonly "width": (AsamDescriptionsItemExpose)["width"];
	readonly "span": number;
	readonly "minWidth": (AsamDescriptionsItemExpose)["minWidth"];
	readonly "rowspan": number;
	readonly "align": (AsamDescriptionsItemExpose)["align"];
	readonly "labelClassName": string;
	readonly "labelWidth"?: (AsamDescriptionsItemExpose)["labelWidth"];
	readonly "labelAlign"?: (AsamDescriptionsItemExpose)["labelAlign"];
	"$route": AsamDescriptionsItemExpose["$route"];
	"$router": AsamDescriptionsItemExpose["$router"];
};

参数与事件说明

$

必填：是；声明来源：依赖声明。

$ 参数与事件数据

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

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

$data

必填：是；声明来源：依赖声明。

$props

必填：是；声明来源：依赖声明。

$attrs

必填：是；声明来源：依赖声明。

$attrs 参数与事件数据

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

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

$refs

必填：是；声明来源：依赖声明。

$refs 参数与事件数据

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

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

$slots

必填：是；声明来源：依赖声明。

$slots 参数与事件数据

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

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

$root

必填：是；声明来源：依赖声明。

$parent

必填：是；声明来源：依赖声明。

$host

必填：是；声明来源：依赖声明。

$host 参数与事件数据

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

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

$emit

必填：是；声明来源：依赖声明。

$emit 参数与事件数据

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

事件参数：(event: string, ...args: any[]): void

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

$el

必填：是；声明来源：依赖声明。

$options

必填：是；声明来源：依赖声明。

$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<(AsamDescriptionsItemInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

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

label

必填：是；声明来源：上游声明。

className

必填：是；声明来源：上游声明。

width

必填：是；声明来源：上游声明。

width 参数与事件数据

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

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

span

必填：是；声明来源：上游声明。

minWidth

必填：是；声明来源：上游声明。

minWidth 参数与事件数据

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

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

rowspan

必填：是；声明来源：上游声明。

align

必填：是；声明来源：上游声明。

align 参数与事件数据

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

枚举："right" / "left" / "center"

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

labelClassName

必填：是；声明来源：上游声明。

labelWidth

必填：否；声明来源：上游声明。

labelAlign

必填：否；声明来源：上游声明。

labelAlign 参数与事件数据

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

枚举："right" / "left" / "center"

$route

必填：是；声明来源：依赖声明。

$route 参数与事件数据

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

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

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

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

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

    匹配路由记录的名称。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      匹配路由记录的名称。

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

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

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

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

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

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

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

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

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

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

$router

必填：是；声明来源：依赖声明。

$router 参数与事件数据

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

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

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

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

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

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

    • $router.options.history: (NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

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

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

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

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

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

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

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

        事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

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

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

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

      • $router.options.history.createHref: (location: AsamDescriptionsItemExpose["label"]) => string — 依赖声明

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

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

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

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

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

        事件参数：(): void

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

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

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

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

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

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

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

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

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

      事件参数：(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["addRoute"] — 依赖声明

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

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

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

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

    按名称移除已有路由。

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

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

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

    事件参数：(): void

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

    当前 RouteLocationNormalized。

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

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

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

    枚举：false / true

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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<AsamDescriptionsItemExpose["$router"]>)["beforeEach"] — 依赖声明

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

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

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

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

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

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

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

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

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

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

    事件参数：(handler: Parameters<Extract<NonNullable<(NonNullable<AsamDescriptionsItemExpose["$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

AsamDescriptionsItemInstance 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ExtractPropTypes, PropType, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamDescriptionsItemInstance, AsamDescriptionsItemExpose, AsamTableColumnExpose, AsamDescriptionsItemProps, AsamAvatarGroupSlots } from '@asam-ui/ui';

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

// AsamDescriptionsItemInstance
type PublicContract = {
	"$": AsamDescriptionsItemExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamDescriptionsItemProps;
	"$attrs": AsamDescriptionsItemExpose["$attrs"];
	"$refs": AsamDescriptionsItemExpose["$refs"];
	"$slots": AsamAvatarGroupSlots;
	"$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: string, ...args: any[]) => void;
	"$el": any;
	"$options": (AsamDescriptionsItemInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamDescriptionsItemInstance)["$nextTick"];
	"$watch": (AsamDescriptionsItemInstance)["$watch"];
	readonly "label": string;
	readonly "className": string;
	readonly "width": (AsamDescriptionsItemInstance)["width"];
	readonly "span": number;
	readonly "minWidth": (AsamDescriptionsItemInstance)["minWidth"];
	readonly "rowspan": number;
	readonly "align": (AsamDescriptionsItemInstance)["align"];
	readonly "labelClassName": string;
	readonly "labelWidth"?: (AsamDescriptionsItemInstance)["labelWidth"];
	readonly "labelAlign"?: (AsamDescriptionsItemInstance)["labelAlign"];
	"$route": AsamDescriptionsItemExpose["$route"];
	"$router": AsamDescriptionsItemExpose["$router"];
};

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

参数与事件说明

default

必填：否；声明来源：ASAM 声明。

default 参数与事件数据

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

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

label

必填：否；声明来源：ASAM 声明。

label 参数与事件数据

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

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

AsamDescriptionsItemSlots 公开类型视图
ts
import type { Slot, VNode, RendererNode, RendererElement } from 'vue';
import type { AsamDescriptionsItemSlots } from '@asam-ui/ui';

// AsamDescriptionsItemSlots
type PublicContract = {
	"default"?: Slot | undefined;
	"label"?: Slot | undefined;
	readonly [key: string]: Slot<any> | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭