导航

菜单项 AsamMenuItem

组织可选择的导航项和分组。

使用场景 ​

组织可选择的导航项和分组。

基础用法与状态 ​

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

基础用法与状态

展开源码

使用约定 ​

index 在菜单内唯一,disabled 阻止选择,route 参与父级路由模式;default/title 插槽提供标签,click 反馈实际点击。必须在 Menu 的层级中使用。 示例维护本地选择值,选择后的跳转由宿主处理;菜单项宽高由布局决定。

组合用法 ​

在 AsamMenu 的完整场景中使用本入口;包含 basic、left-and-right、vertical、collapse、popper-offset。

API

属性 AsamMenuItemProps

属性名说明类型默认值
index唯一标志string—
routeVue Router 对象。(AsamMenuItemProps)["route"]—
disabled是否禁用boolean | undefinedfalse
onClick—((item: AsamMenuItemRegistered) => any) | undefined—
key—PropertyKey | undefined—
ref—VNodeRef | undefined—
ref_for—boolean | undefined—
ref_key—string | undefined—
onVnodeBeforeMount—(AsamMenuItemProps)["onVnodeBeforeMount"]—
onVnodeMounted—(AsamMenuItemProps)["onVnodeMounted"]—
onVnodeBeforeUpdate—(AsamMenuItemProps)["onVnodeBeforeUpdate"]—
onVnodeUpdated—(AsamMenuItemProps)["onVnodeUpdated"]—
onVnodeBeforeUnmount—(AsamMenuItemProps)["onVnodeBeforeUnmount"]—
onVnodeUnmounted—(AsamMenuItemProps)["onVnodeUnmounted"]—
class—unknown—
style—unknown—

实例方法与状态 AsamMenuItemExpose

属性名说明类型默认值
$—AsamMenuItemExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamMenuItemProps—
$attrs—AsamMenuItemExpose["$attrs"]—
$refs—AsamMenuItemExpose["$refs"]—
$slots—AsamMenuItemSlots—
$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: "click", item: AsamMenuItemRegistered) => void—
$el—any—
$options—(AsamMenuItemExpose)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamMenuItemExpose)["$nextTick"]—
$watch—(AsamMenuItemExpose)["$watch"]—
disabled是否禁用boolean | undefined—
onClick—((item: AsamMenuItemRegistered) => any) | undefined—
index唯一标志string—
routeVue Router 对象。(AsamMenuItemExpose)["route"]—
parentMenu—(AsamMenuItemExpose)["parentMenu"]—
rootMenu—AsamMenuProvider—
active—boolean—
nsMenu—(AsamMenuItemExpose)["nsMenu"]—
nsMenuItem—(AsamMenuItemExpose)["nsMenuItem"]—
handleClick—() => void—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamMenuItemExpose["$route"]—
$router应用使用的 Router 实例。AsamMenuItemExpose["$router"]—

类型 AsamMenuItemInstance

属性名说明类型默认值
$—AsamMenuItemExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamMenuItemProps—
$attrs—AsamMenuItemExpose["$attrs"]—
$refs—AsamMenuItemExpose["$refs"]—
$slots—AsamMenuItemSlots—
$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: "click", item: AsamMenuItemRegistered) => void—
$el—any—
$options—(AsamMenuItemInstance)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamMenuItemInstance)["$nextTick"]—
$watch—(AsamMenuItemInstance)["$watch"]—
disabled是否禁用boolean | undefined—
onClick—((item: AsamMenuItemRegistered) => any) | undefined—
index唯一标志string—
routeVue Router 对象。(AsamMenuItemInstance)["route"]—
parentMenu—(AsamMenuItemInstance)["parentMenu"]—
rootMenu—AsamMenuProvider—
active—boolean—
nsMenu—(AsamMenuItemInstance)["nsMenu"]—
nsMenuItem—(AsamMenuItemInstance)["nsMenuItem"]—
handleClick—() => void—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamMenuItemExpose["$route"]—
$router应用使用的 Router 实例。AsamMenuItemExpose["$router"]—

插槽 AsamMenuItemSlots

属性名说明类型默认值
title—(AsamMenuItemSlots)["title"]—
default—(AsamMenuItemSlots)["default"]—

事件 AsamMenuItemEmits

属性名说明类型默认值
click—(item: AsamMenuItemRegistered) => boolean—
参数与事件补充说明

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

参数与事件说明

index

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

route

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

route 参数与事件数据

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

  • route.name: PublicMember<NonNullable<(AsamMenuItemProps)["route"]>, "name"> — 依赖声明
  • route.params: PublicMember<NonNullable<(AsamMenuItemProps)["route"]>, "params"> — 依赖声明
  • route.path: undefined — 依赖声明

    相对于当前位置的路径;此属性应移除。

  • route.query: PublicMember<NonNullable<(AsamMenuItemProps)["route"]>, "query"> — 依赖声明
  • route.hash: string | undefined — 依赖声明
  • route.replace: boolean | undefined — 依赖声明

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

    枚举:false / true

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

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

    枚举:false / true

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

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

  • route.path: string — 依赖声明

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

disabled

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

disabled 参数与事件数据

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

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
onClick

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

onClick 参数与事件数据

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

事件参数:(item: AsamMenuItemRegistered): 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

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

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

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

// AsamMenuItemProps
type PublicContract = {
	readonly "index": string;
	readonly "route"?: (AsamMenuItemProps)["route"];
	readonly "disabled"?: boolean | undefined;
	readonly "onClick"?: ((item: AsamMenuItemRegistered) => any) | undefined;
	"key"?: PropertyKey | undefined;
	"ref"?: VNodeRef | undefined;
	"ref_for"?: boolean | undefined;
	"ref_key"?: string | undefined;
	"onVnodeBeforeMount"?: (AsamMenuItemProps)["onVnodeBeforeMount"];
	"onVnodeMounted"?: (AsamMenuItemProps)["onVnodeMounted"];
	"onVnodeBeforeUpdate"?: (AsamMenuItemProps)["onVnodeBeforeUpdate"];
	"onVnodeUpdated"?: (AsamMenuItemProps)["onVnodeUpdated"];
	"onVnodeBeforeUnmount"?: (AsamMenuItemProps)["onVnodeBeforeUnmount"];
	"onVnodeUnmounted"?: (AsamMenuItemProps)["onVnodeUnmounted"];
	"class"?: unknown;
	"style"?: unknown;
};

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

参数与事件说明

$

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

$ 参数与事件数据

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

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

$data

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

$props

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

$attrs

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

$attrs 参数与事件数据

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

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

$refs

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

$refs 参数与事件数据

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

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

$slots

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

$root

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

$parent

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

$host

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

$host 参数与事件数据

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

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

$emit

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

$emit 参数与事件数据

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

事件参数:(event: "click", ...args: [item: AsamMenuItemRegistered]): 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<(AsamMenuItemExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

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

disabled

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

disabled 参数与事件数据

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

枚举:false / true

onClick

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

onClick 参数与事件数据

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

事件参数:(item: AsamMenuItemRegistered): any

index

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

route

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

route 参数与事件数据

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

  • route.name: PublicMember<NonNullable<(AsamMenuItemExpose)["route"]>, "name"> — 依赖声明
  • route.params: PublicMember<NonNullable<(AsamMenuItemExpose)["route"]>, "params"> — 依赖声明
  • route.path: undefined — 依赖声明

    相对于当前位置的路径;此属性应移除。

  • route.query: PublicMember<NonNullable<(AsamMenuItemExpose)["route"]>, "query"> — 依赖声明
  • route.hash: string | undefined — 依赖声明
  • route.replace: boolean | undefined — 依赖声明

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

    枚举:false / true

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

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

    枚举:false / true

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

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

  • route.path: string — 依赖声明

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

parentMenu

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

parentMenu 参数与事件数据

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

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

rootMenu

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

rootMenu 参数与事件数据

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

  • rootMenu.openedMenus: string[] — 上游声明

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

  • rootMenu.items: Record<string, AsamMenuItemRegistered> — 上游声明

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

  • rootMenu.subMenus: Record<string, AsamMenuItemRegistered> — 上游声明

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

  • rootMenu.activeIndex: string | undefined — 上游声明
  • rootMenu.isMenuPopup: boolean — 上游声明

    枚举:false / true

  • rootMenu.props: (NonNullable<AsamMenuProvider>)["props"] — 上游声明
  • rootMenu.addMenuItem: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.removeMenuItem: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.addSubMenu: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.removeSubMenu: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.openMenu: (index: string, indexPath: string[]) => void — 上游声明

    事件参数:(index: string, indexPath: string[]): void

  • rootMenu.closeMenu: (index: string, indexPath: string[]) => void — 上游声明

    事件参数:(index: string, indexPath: string[]): void

  • rootMenu.handleMenuItemClick: (item: AsamMenuItemClicked) => void — 上游声明

    事件参数:(item: AsamMenuItemClicked): void

  • rootMenu.handleSubMenuClick: (subMenu: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(subMenu: AsamMenuItemRegistered): void

active

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

active 参数与事件数据

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

枚举:false / true

nsMenu

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

nsMenu 参数与事件数据

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

  • nsMenu.namespace: (NonNullable<(AsamMenuItemExpose)["nsMenu"]>)["namespace"] — 上游声明

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

  • nsMenu.b: (blockSuffix?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined): string

  • nsMenu.e: (element?: string) => string — 上游声明

    事件参数:(element?: string | undefined): string

  • nsMenu.m: (modifier?: string) => string — 上游声明

    事件参数:(modifier?: string | undefined): string

  • nsMenu.be: (blockSuffix?: string, element?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined): string

  • nsMenu.em: (element?: string, modifier?: string) => string — 上游声明

    事件参数:(element?: string | undefined, modifier?: string | undefined): string

  • nsMenu.bm: (blockSuffix?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, modifier?: string | undefined): string

  • nsMenu.bem: (blockSuffix?: string, element?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined): string

  • nsMenu.is: { (name: string, state: boolean | undefined): string; (name: string): string; } — 上游声明

    事件参数:(name: string, state: boolean | undefined): string

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

  • nsMenu.cssVar: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenu.cssVarName: (name: string) => string — 上游声明

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

  • nsMenu.cssVarBlock: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenu.cssVarBlockName: (name: string) => string — 上游声明

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

nsMenuItem

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

nsMenuItem 参数与事件数据

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

  • nsMenuItem.namespace: (NonNullable<(AsamMenuItemExpose)["nsMenuItem"]>)["namespace"] — 上游声明

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

  • nsMenuItem.b: (blockSuffix?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined): string

  • nsMenuItem.e: (element?: string) => string — 上游声明

    事件参数:(element?: string | undefined): string

  • nsMenuItem.m: (modifier?: string) => string — 上游声明

    事件参数:(modifier?: string | undefined): string

  • nsMenuItem.be: (blockSuffix?: string, element?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined): string

  • nsMenuItem.em: (element?: string, modifier?: string) => string — 上游声明

    事件参数:(element?: string | undefined, modifier?: string | undefined): string

  • nsMenuItem.bm: (blockSuffix?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, modifier?: string | undefined): string

  • nsMenuItem.bem: (blockSuffix?: string, element?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined): string

  • nsMenuItem.is: { (name: string, state: boolean | undefined): string; (name: string): string; } — 上游声明

    事件参数:(name: string, state: boolean | undefined): string

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

  • nsMenuItem.cssVar: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenuItem.cssVarName: (name: string) => string — 上游声明

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

  • nsMenuItem.cssVarBlock: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenuItem.cssVarBlockName: (name: string) => string — 上游声明

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

handleClick

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

handleClick 参数与事件数据

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

事件参数:(): void

$route

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

$route 参数与事件数据

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

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

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

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

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

    匹配路由记录的名称。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      匹配路由记录的名称。

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

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

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

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

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

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

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

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

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

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

$router

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

$router 参数与事件数据

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

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

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

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

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

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

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

        当前历史记录状态。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        事件参数:(): void

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    按名称移除已有路由。

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

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

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

    事件参数:(): void

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

    当前 RouteLocationNormalized。

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

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

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

    枚举:false / true

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AsamMenuItemExpose 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamMenuItemExpose, AsamTableColumnExpose, AsamMenuItemProps, AsamMenuItemSlots, AsamMenuItemRegistered, AsamMenuProvider, AsamMenuItemClicked } from '@asam-ui/ui';

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

// AsamMenuItemExpose
type PublicContract = {
	"$": AsamMenuItemExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamMenuItemProps;
	"$attrs": AsamMenuItemExpose["$attrs"];
	"$refs": AsamMenuItemExpose["$refs"];
	"$slots": AsamMenuItemSlots;
	"$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: "click", item: AsamMenuItemRegistered) => void;
	"$el": any;
	"$options": (AsamMenuItemExpose)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamMenuItemExpose)["$nextTick"];
	"$watch": (AsamMenuItemExpose)["$watch"];
	readonly "disabled"?: boolean | undefined;
	readonly "onClick"?: ((item: AsamMenuItemRegistered) => any) | undefined;
	readonly "index": string;
	readonly "route"?: (AsamMenuItemExpose)["route"];
	"parentMenu": (AsamMenuItemExpose)["parentMenu"];
	"rootMenu": AsamMenuProvider;
	"active": boolean;
	"nsMenu": (AsamMenuItemExpose)["nsMenu"];
	"nsMenuItem": (AsamMenuItemExpose)["nsMenuItem"];
	"handleClick": () => void;
	"$route": AsamMenuItemExpose["$route"];
	"$router": AsamMenuItemExpose["$router"];
};

参数与事件说明

$

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

$ 参数与事件数据

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

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

$data

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

$props

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

$attrs

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

$attrs 参数与事件数据

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

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

$refs

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

$refs 参数与事件数据

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

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

$slots

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

$root

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

$parent

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

$host

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

$host 参数与事件数据

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

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

$emit

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

$emit 参数与事件数据

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

事件参数:(event: "click", ...args: [item: AsamMenuItemRegistered]): 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<(AsamMenuItemInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

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

disabled

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

disabled 参数与事件数据

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

枚举:false / true

onClick

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

onClick 参数与事件数据

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

事件参数:(item: AsamMenuItemRegistered): any

index

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

route

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

route 参数与事件数据

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

  • route.name: PublicMember<NonNullable<(AsamMenuItemInstance)["route"]>, "name"> — 依赖声明
  • route.params: PublicMember<NonNullable<(AsamMenuItemInstance)["route"]>, "params"> — 依赖声明
  • route.path: undefined — 依赖声明

    相对于当前位置的路径;此属性应移除。

  • route.query: PublicMember<NonNullable<(AsamMenuItemInstance)["route"]>, "query"> — 依赖声明
  • route.hash: string | undefined — 依赖声明
  • route.replace: boolean | undefined — 依赖声明

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

    枚举:false / true

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

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

    枚举:false / true

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

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

  • route.path: string — 依赖声明

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

parentMenu

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

parentMenu 参数与事件数据

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

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

rootMenu

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

rootMenu 参数与事件数据

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

  • rootMenu.openedMenus: string[] — 上游声明

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

  • rootMenu.items: Record<string, AsamMenuItemRegistered> — 上游声明

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

  • rootMenu.subMenus: Record<string, AsamMenuItemRegistered> — 上游声明

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

  • rootMenu.activeIndex: string | undefined — 上游声明
  • rootMenu.isMenuPopup: boolean — 上游声明

    枚举:false / true

  • rootMenu.props: (NonNullable<AsamMenuProvider>)["props"] — 上游声明
  • rootMenu.addMenuItem: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.removeMenuItem: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.addSubMenu: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.removeSubMenu: (item: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(item: AsamMenuItemRegistered): void

  • rootMenu.openMenu: (index: string, indexPath: string[]) => void — 上游声明

    事件参数:(index: string, indexPath: string[]): void

  • rootMenu.closeMenu: (index: string, indexPath: string[]) => void — 上游声明

    事件参数:(index: string, indexPath: string[]): void

  • rootMenu.handleMenuItemClick: (item: AsamMenuItemClicked) => void — 上游声明

    事件参数:(item: AsamMenuItemClicked): void

  • rootMenu.handleSubMenuClick: (subMenu: AsamMenuItemRegistered) => void — 上游声明

    事件参数:(subMenu: AsamMenuItemRegistered): void

active

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

active 参数与事件数据

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

枚举:false / true

nsMenu

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

nsMenu 参数与事件数据

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

  • nsMenu.namespace: (NonNullable<(AsamMenuItemInstance)["nsMenu"]>)["namespace"] — 上游声明

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

  • nsMenu.b: (blockSuffix?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined): string

  • nsMenu.e: (element?: string) => string — 上游声明

    事件参数:(element?: string | undefined): string

  • nsMenu.m: (modifier?: string) => string — 上游声明

    事件参数:(modifier?: string | undefined): string

  • nsMenu.be: (blockSuffix?: string, element?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined): string

  • nsMenu.em: (element?: string, modifier?: string) => string — 上游声明

    事件参数:(element?: string | undefined, modifier?: string | undefined): string

  • nsMenu.bm: (blockSuffix?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, modifier?: string | undefined): string

  • nsMenu.bem: (blockSuffix?: string, element?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined): string

  • nsMenu.is: { (name: string, state: boolean | undefined): string; (name: string): string; } — 上游声明

    事件参数:(name: string, state: boolean | undefined): string

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

  • nsMenu.cssVar: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenu.cssVarName: (name: string) => string — 上游声明

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

  • nsMenu.cssVarBlock: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenu.cssVarBlockName: (name: string) => string — 上游声明

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

nsMenuItem

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

nsMenuItem 参数与事件数据

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

  • nsMenuItem.namespace: (NonNullable<(AsamMenuItemInstance)["nsMenuItem"]>)["namespace"] — 上游声明

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

  • nsMenuItem.b: (blockSuffix?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined): string

  • nsMenuItem.e: (element?: string) => string — 上游声明

    事件参数:(element?: string | undefined): string

  • nsMenuItem.m: (modifier?: string) => string — 上游声明

    事件参数:(modifier?: string | undefined): string

  • nsMenuItem.be: (blockSuffix?: string, element?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined): string

  • nsMenuItem.em: (element?: string, modifier?: string) => string — 上游声明

    事件参数:(element?: string | undefined, modifier?: string | undefined): string

  • nsMenuItem.bm: (blockSuffix?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, modifier?: string | undefined): string

  • nsMenuItem.bem: (blockSuffix?: string, element?: string, modifier?: string) => string — 上游声明

    事件参数:(blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined): string

  • nsMenuItem.is: { (name: string, state: boolean | undefined): string; (name: string): string; } — 上游声明

    事件参数:(name: string, state: boolean | undefined): string

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

  • nsMenuItem.cssVar: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenuItem.cssVarName: (name: string) => string — 上游声明

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

  • nsMenuItem.cssVarBlock: (object: Record<string, string>) => Record<string, string> — 上游声明

    事件参数:(object: Record<string, string>): Record<string, string>

  • nsMenuItem.cssVarBlockName: (name: string) => string — 上游声明

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

handleClick

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

handleClick 参数与事件数据

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

事件参数:(): void

$route

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

$route 参数与事件数据

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

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

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

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

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

    匹配路由记录的名称。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      匹配路由记录的名称。

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

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

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

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

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

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

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

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

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

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

$router

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

$router 参数与事件数据

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

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

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

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

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

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

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

        当前历史记录状态。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        事件参数:(): void

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    按名称移除已有路由。

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

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

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

    事件参数:(): void

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

    当前 RouteLocationNormalized。

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

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

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

    枚举:false / true

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AsamMenuItemInstance 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamMenuItemInstance, AsamMenuItemExpose, AsamTableColumnExpose, AsamMenuItemProps, AsamMenuItemSlots, AsamMenuItemRegistered, AsamMenuProvider, AsamMenuItemClicked } from '@asam-ui/ui';

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

// AsamMenuItemInstance
type PublicContract = {
	"$": AsamMenuItemExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamMenuItemProps;
	"$attrs": AsamMenuItemExpose["$attrs"];
	"$refs": AsamMenuItemExpose["$refs"];
	"$slots": AsamMenuItemSlots;
	"$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: "click", item: AsamMenuItemRegistered) => void;
	"$el": any;
	"$options": (AsamMenuItemInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamMenuItemInstance)["$nextTick"];
	"$watch": (AsamMenuItemInstance)["$watch"];
	readonly "disabled"?: boolean | undefined;
	readonly "onClick"?: ((item: AsamMenuItemRegistered) => any) | undefined;
	readonly "index": string;
	readonly "route"?: (AsamMenuItemInstance)["route"];
	"parentMenu": (AsamMenuItemInstance)["parentMenu"];
	"rootMenu": AsamMenuProvider;
	"active": boolean;
	"nsMenu": (AsamMenuItemInstance)["nsMenu"];
	"nsMenuItem": (AsamMenuItemInstance)["nsMenuItem"];
	"handleClick": () => void;
	"$route": AsamMenuItemExpose["$route"];
	"$router": AsamMenuItemExpose["$router"];
};

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

参数与事件说明

title

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

title 参数与事件数据

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

事件参数:(props: AsamTableColumnExpose): any

default

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

default 参数与事件数据

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

事件参数:(props: AsamTableColumnExpose): any

AsamMenuItemSlots 公开类型视图
ts
import type { AsamMenuItemSlots, AsamMenuItemExpose, AsamTableColumnExpose } from '@asam-ui/ui';

// AsamMenuItemSlots
type PublicContract = {
	"title"?: (AsamMenuItemSlots)["title"];
	"default"?: (AsamMenuItemSlots)["default"];
	readonly [key: string]: import("vue").Slot<any> | undefined;
};

参数与事件说明

click

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

click 参数与事件数据

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

事件参数:(item: AsamMenuItemRegistered): boolean

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

// AsamMenuItemEmits
type PublicContract = {
	"click": (item: AsamMenuItemRegistered) => boolean;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭