服务

消息服务 AsamMessage

显示短暂的全局操作反馈,并返回可关闭的句柄。

使用场景 ​

显示短暂的全局操作反馈,并返回可关闭的句柄。

类型、分组与手动关闭 ​

消息保持显示以便观察,结束按钮关闭本示例持有的所有句柄。

类型、分组与手动关闭

展开源码

使用约定 ​

调用 AsamMessage(params, appContext?);字符串、VNode/渲染函数或选项对象均按公开参数类型使用。 完整说明。

完整用法 ​

以下用法使用本库公开入口。每个示例提供完整 TS/JS SFC,参数、事件、插槽和实例类型见本页 API。服务实例由创建方负责关闭;HTML 内容仅用于调用方已知的可信字符串。

基本用法 ​

基本用法

展开源码

状态与快捷调用 ​

状态与快捷调用

展开源码

简洁消息 ​

简洁消息

展开源码

完整交互:closable ​

完整交互:closable

展开源码

可信 HTML 内容 ​

可信 HTML 内容

展开源码

消息合并 ​

消息合并

展开源码

定位方向 ​

定位方向

展开源码

组合职责与生命周期 ​

字符串、VNode、内容函数或 options 都返回独立 close 句柄。 完整说明。

宿主上下文与所属服务清理 ​

本例仅关闭自己持有的句柄。宿主可通过 app.provide('asam-service-label', value) 提供服务内容;显式传入当前 AppContext。

宿主上下文与所属服务清理

展开源码

API

服务 AsamMessage

属性名说明类型默认值
closeAll—(type?: AsamMessageType) => void—
closeAllByPlacement—(position: AsamMessagePlacement) => void—
primary—AsamMessageService["primary"]—
success—AsamMessageService["primary"]—
warning—AsamMessageService["primary"]—
info—AsamMessageService["primary"]—
error—AsamMessageService["primary"]—
_context—AppContext | null—
install—(app: App) => void—
ts
(options?: AsamMessageParams, appContext?: Parameters<typeof AsamMessage>[1]): AsamMessageHandler

类型 AsamMessageOptions

属性名说明类型默认值
zIndex消息元素的 zIndex 值。number | undefined0
offsetMessage 距离窗口顶部的偏移量number | undefined16
placement消息放置位置enum"top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"完整类型:"top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | undefinedundefined
type消息类型enum"primary" | "success" | "warning" | "info" | "error"完整类型:"primary" | "success" | "warning" | "info" | "error" | undefined"info"
duration显示时间,单位为毫秒。设为 0 则不会自动关闭number | undefined3000
icon自定义图标,该属性会覆盖 type 的图标。(AsamMessageOptions)["icon"]undefined
onClose关闭时的回调函数, 参数为被关闭的 message 实例(() => void) | undefinedundefined
message消息文字(AsamMessageOptions)["message"]""
plain是否纯色boolean | undefinedfalse
showClose是否显示关闭按钮boolean | undefinedfalse
customClass自定义类名AsamMessageOptions["customClass"]"asam-message"
dangerouslyUseHTMLString是否将 message 属性作为 HTML 片段处理boolean | undefinedfalse
grouping合并内容相同的消息,不支持 VNode 类型的消息boolean | undefinedfalse
repeatNum重复次数,类似于 Badge 。当和 grouping 属性一起使用时作为初始数量使用number | undefined1
appendTo设置 message 的根元素,默认为 document.bodystring | HTMLElement | undefinedisClient ? document.body : void 0

类型 AsamMessageParams

属性名说明类型默认值
type消息类型enum"primary" | "success" | "warning" | "info" | "error"完整类型:VNodeTypes | "primary" | "success" | "warning" | "info" | "error" | undefined—
props—(VNodeProps & { [key: string]: any; }) | null—
key—PropertyKey | null—
ref—PublicMember<AsamMessageParams, "ref">—
scopeId仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。string | null—
children—VNodeNormalizedChildren—
component—ComponentInternalInstance | null—
dirs—DirectiveBinding<any, string, any>[] | null—
transition—TransitionHooks<RendererElement> | null—
el—RendererNode | null—
placeholder—RendererNode | null—
anchor—RendererNode | null—
target—RendererElement | null—
targetStart—RendererNode | null—
targetAnchor—RendererNode | null—
suspense—SuspenseBoundary | null—
shapeFlag—number—
patchFlag—number—
appContext—AppContext | null—
zIndex消息元素的 zIndex 值。number | undefined—
offsetMessage 距离窗口顶部的偏移量number | undefined—
placement消息放置位置enum"top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"完整类型:"top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | undefined—
duration显示时间,单位为毫秒。设为 0 则不会自动关闭number | undefined—
icon自定义图标,该属性会覆盖 type 的图标。PublicMember<AsamMessageParams, "icon">—
onClose关闭时的回调函数, 参数为被关闭的 message 实例(() => void) | undefined—
message消息文字PublicMember<AsamMessageParams, "message">—
plain是否纯色boolean | undefined—
showClose是否显示关闭按钮boolean | undefined—
customClass自定义类名AsamMessageOptions["customClass"]—
dangerouslyUseHTMLString是否将 message 属性作为 HTML 片段处理boolean | undefined—
grouping合并内容相同的消息,不支持 VNode 类型的消息boolean | undefined—
repeatNum重复次数,类似于 Badge 。当和 grouping 属性一起使用时作为初始数量使用number | undefined—
appendTo—string | HTMLElement | undefined—

类型 AsamMessageParamsWithType

属性名说明类型默认值
type—VNodeTypes—
props—(VNodeProps & { [key: string]: any; }) | null—
key—PropertyKey | null—
ref—PublicMember<AsamMessageParamsWithType, "ref">—
scopeId仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。string | null—
children—VNodeNormalizedChildren—
component—ComponentInternalInstance | null—
dirs—DirectiveBinding<any, string, any>[] | null—
transition—TransitionHooks<RendererElement> | null—
el—RendererNode | null—
placeholder—RendererNode | null—
anchor—RendererNode | null—
target—RendererElement | null—
targetStart—RendererNode | null—
targetAnchor—RendererNode | null—
suspense—SuspenseBoundary | null—
shapeFlag—number—
patchFlag—number—
appContext—AppContext | null—
zIndex消息元素的 zIndex 值。number | undefined—
offsetMessage 距离窗口顶部的偏移量number | undefined—
placement消息放置位置enum"top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"完整类型:"top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | undefined—
appendTo—string | HTMLElement | undefined—
duration显示时间,单位为毫秒。设为 0 则不会自动关闭number | undefined—
icon自定义图标,该属性会覆盖 type 的图标。PublicMember<AsamMessageParamsWithType, "icon">—
onClose关闭时的回调函数, 参数为被关闭的 message 实例(() => void) | undefined—
message消息文字PublicMember<AsamMessageParamsWithType, "message">—
plain是否纯色boolean | undefined—
showClose是否显示关闭按钮boolean | undefined—
customClass自定义类名AsamMessageOptions["customClass"]—
dangerouslyUseHTMLString是否将 message 属性作为 HTML 片段处理boolean | undefined—
grouping合并内容相同的消息,不支持 VNode 类型的消息boolean | undefined—
repeatNum重复次数,类似于 Badge 。当和 grouping 属性一起使用时作为初始数量使用number | undefined—

类型 AsamMessageHandler

属性名说明类型默认值
close关闭当前的 Message() => void—

类型 AsamMessageType

类型 AsamMessagePlacement

类型 AsamMessageConfigContext

属性名说明类型默认值
max—number | undefined—
grouping—boolean | undefined—
duration—number | undefined—
offset—number | undefined—
showClose—boolean | undefined—
plain—boolean | undefined—
placement—string | undefined—

类型 AsamMessageService

属性名说明类型默认值
closeAll—(type?: AsamMessageType) => void—
closeAllByPlacement—(position: AsamMessagePlacement) => void—
primary—AsamMessageService["primary"]—
success—AsamMessageService["primary"]—
warning—AsamMessageService["primary"]—
info—AsamMessageService["primary"]—
error—AsamMessageService["primary"]—
_context—AppContext | null—
install—(app: App) => void—
ts
(options?: AsamMessageParams, appContext?: Parameters<AsamMessageService>[1]): AsamMessageHandler

用法与契约补充说明 ​

使用约定 ​

调用 AsamMessage(params, appContext?);字符串、VNode/渲染函数或选项对象均按公开参数类型使用。primary/success/warning/info/error 为快捷调用,返回 handler.close()。duration=0 持续显示,showClose 提供关闭按钮,grouping 与 repeatNum 管理重复消息,placement/offset/zIndex 配置位置。closeAll 和 closeAllByPlacement 属全局操作;卸载仅关闭本示例自己的句柄。ASAM 保留应用上下文注册和品牌样式,无 size 参数。

组合职责与生命周期 ​

字符串、VNode、内容函数或 options 都返回独立 close 句柄。primary/success/warning/info/error 保留快捷调用和 AppContext。grouping 合并相同内容,placement/offset/appendTo 与 zIndex 决定叠放;duration=0 持续显示,由创建方关闭。customClass 支持字符串、数组及对象并保留 ASAM 品牌类。closeAll/closeAllByPlacement 影响相应范围的全部消息,示例用各自句柄清理,避免关闭别人的消息。

参数与事件补充说明

提供 ASAM 注册与样式;返回的关闭函数保留基础组件实时行为。

参数与事件说明

closeAll

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

closeAll 参数与事件数据

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

事件参数:(type?: "primary" | "success" | "warning" | "info" | "error" | undefined): void

closeAllByPlacement

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

closeAllByPlacement 参数与事件数据

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

事件参数:(position: AsamMessagePlacement): void

primary

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

primary 参数与事件数据

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

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

success

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

success 参数与事件数据

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

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

warning

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

warning 参数与事件数据

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

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

info

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

info 参数与事件数据

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

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

error

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

error 参数与事件数据

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

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

_context

必填:是;声明来源:ASAM 声明。

_context 参数与事件数据

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

  • _context.app: App<any> — 依赖声明

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

  • _context.config: AppConfig — 依赖声明

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

  • _context.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

  • _context.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

  • _context.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

  • _context.provides: Record<string | symbol, any> — 依赖声明

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

install

必填:是;声明来源:ASAM 声明。

install 参数与事件数据

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

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

AsamMessage 公开类型视图
ts
import type { AppContext, App, AppConfig, ComponentOptions, ComponentProvideOptions, Component, ComputedOptions, MethodOptions, Directive } from 'vue';
import type { AsamMessageType, AsamMessageService, AsamMessageOptions, AsamMessagePlacement, AsamMessageParamsWithType, AsamMessageHandler, AsamMessageParams } from '@asam-ui/ui';
import { AsamMessage } from '@asam-ui/ui';

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

// AsamMessage
type PublicContract = {
	(options?: AsamMessageParams, appContext?: Parameters<typeof AsamMessage>[1]): AsamMessageHandler;
	"closeAll": (type?: AsamMessageType) => void;
	"closeAllByPlacement": (position: AsamMessagePlacement) => void;
	"primary": AsamMessageService["primary"];
	"success": AsamMessageService["primary"];
	"warning": AsamMessageService["primary"];
	"info": AsamMessageService["primary"];
	"error": AsamMessageService["primary"];
	"_context": AppContext | null;
	"install": (app: App) => void;
};

参数与事件说明

zIndex

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

默认值与来源
0(源码表达式;上游声明)

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

offset

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

默认值与来源
16(源码表达式;上游声明)

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

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

placement

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

placement 参数与事件数据

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

枚举:"top" / "bottom" / "top-left" / "top-right" / "bottom-left" / "bottom-right"

默认值与来源
undefined(源码表达式;上游声明)

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

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

type

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

type 参数与事件数据

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

枚举:"primary" / "success" / "warning" / "info" / "error"

默认值与来源
"info"(源码表达式;上游声明)

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

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

duration

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

默认值与来源
3000(源码表达式;上游声明)

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

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

icon

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

icon 参数与事件数据

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

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<(AsamMessageOptions)["icon"]>, (...args: never[]) => unknown>>[1]): any

  • icon.__isFragment: undefined — 依赖声明
  • icon.__isTeleport: undefined — 依赖声明
  • icon.__isSuspense: undefined — 依赖声明
默认值与来源
undefined(源码表达式;上游声明)

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

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

onClose

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

onClose 参数与事件数据

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

事件参数:(): void

默认值与来源
undefined(源码表达式;上游声明)

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

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

message

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

message 参数与事件数据

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

事件参数:(): ReturnType<Extract<NonNullable<(AsamMessageOptions)["message"]>, (...args: never[]) => unknown>>

  • message.type: VNodeTypes — 依赖声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "type">>, (...args: never[]) => unknown>>[1]): any

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

  • message.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
  • message.key: PropertyKey | null — 依赖声明
  • message.ref: PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "ref"> — 依赖声明
    • message.ref.i: ComponentInternalInstance — 依赖声明

      组件实例。

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

    • message.ref.r: VNodeRef — 依赖声明

      实际 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

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

    • message.ref.k: string | undefined — 依赖声明

      setup 中的 ref 键。

    • message.ref.f: boolean | undefined — 依赖声明

      refInFor 标记。

      枚举:false / true

  • message.scopeId: string | null — 依赖声明

    仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

  • message.children: VNodeNormalizedChildren — 依赖声明

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

  • message.component: ComponentInternalInstance | null — 依赖声明
    • message.component.uid: number — 依赖声明
    • message.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • message.component.parent: ComponentInternalInstance | null — 依赖声明

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

    • message.component.root: ComponentInternalInstance — 依赖声明

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

    • message.component.appContext: AppContext — 依赖声明

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

    • message.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

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

    • message.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

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

    • message.component.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

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

    • message.component.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

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

    • message.component.job: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "job"> — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

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

    • message.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • message.component.exposed: Record<string, any> | null — 依赖声明
    • message.component.exposeProxy: Record<string, any> | null — 依赖声明
    • message.component.data: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "data"> — 依赖声明

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

    • message.component.props: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "props"> — 依赖声明

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

    • message.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "attrs"> — 依赖声明

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

    • message.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "slots"> — 依赖声明

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

    • message.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "component">>, "refs"> — 依赖声明

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

    • message.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

    • message.component.isMounted: boolean — 依赖声明

      枚举:false / true

    • message.component.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • message.component.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • message.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
  • message.transition: TransitionHooks<RendererElement> | null — 依赖声明
    • message.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

      枚举:"default" / "in-out" / "out-in"

    • message.transition.persisted: boolean — 依赖声明

      枚举:false / true

    • message.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

      事件参数:(el: RendererElement): void

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

    • message.transition.enter: (el: RendererElement) => void — 依赖声明

      事件参数:(el: RendererElement): void

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

    • message.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

      事件参数:(el: RendererElement, remove: () => void): void

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

    • message.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

    • message.transition.afterLeave: (() => void) | undefined — 依赖声明

      事件参数:(): void

    • message.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

      事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

    • message.transition.delayedLeave: (() => void) | undefined — 依赖声明

      事件参数:(): void

  • message.el: RendererNode | null — 依赖声明
  • message.placeholder: RendererNode | null — 依赖声明
  • message.anchor: RendererNode | null — 依赖声明
  • message.target: RendererElement | null — 依赖声明
  • message.targetStart: RendererNode | null — 依赖声明
  • message.targetAnchor: RendererNode | null — 依赖声明
  • message.suspense: SuspenseBoundary | null — 依赖声明
    • message.suspense.vnode: VNode<RendererNode, RendererElement, SuspenseProps> — 依赖声明

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

    • message.suspense.parent: SuspenseBoundary | null — 依赖声明

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

    • message.suspense.parentComponent: ComponentInternalInstance | null — 依赖声明
      • message.suspense.parentComponent.uid: number — 依赖声明

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

      • message.suspense.parentComponent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.parentComponent.parent: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.parentComponent.root: ComponentInternalInstance — 依赖声明

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

      • message.suspense.parentComponent.appContext: AppContext — 依赖声明

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

      • message.suspense.parentComponent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • message.suspense.parentComponent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • message.suspense.parentComponent.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • message.suspense.parentComponent.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • message.suspense.parentComponent.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • message.suspense.parentComponent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • message.suspense.parentComponent.exposed: Record<string, any> | null — 依赖声明

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

      • message.suspense.parentComponent.exposeProxy: Record<string, any> | null — 依赖声明

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

      • message.suspense.parentComponent.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "data"> — 依赖声明

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

      • message.suspense.parentComponent.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "props"> — 依赖声明

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

      • message.suspense.parentComponent.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "attrs"> — 依赖声明

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

      • message.suspense.parentComponent.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "slots"> — 依赖声明

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

      • message.suspense.parentComponent.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "parentComponent">>, "refs"> — 依赖声明

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

      • message.suspense.parentComponent.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • message.suspense.parentComponent.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • message.suspense.parentComponent.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • message.suspense.parentComponent.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • message.suspense.namespace: ElementNamespace — 依赖声明

      枚举:"svg" / "mathml"

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

    • message.suspense.container: RendererElement — 依赖声明

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

    • message.suspense.hiddenContainer: RendererElement — 依赖声明

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

    • message.suspense.activeBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
      • message.suspense.activeBranch.type: VNodeTypes — 依赖声明

        事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "activeBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.activeBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明

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

      • message.suspense.activeBranch.key: PropertyKey | null — 依赖声明

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

      • message.suspense.activeBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "activeBranch">>, "ref"> — 依赖声明

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

      • message.suspense.activeBranch.scopeId: string | null — 依赖声明

        仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

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

      • message.suspense.activeBranch.children: VNodeNormalizedChildren — 依赖声明

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

      • message.suspense.activeBranch.component: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.activeBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明

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

      • message.suspense.activeBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明

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

      • message.suspense.activeBranch.el: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.placeholder: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.anchor: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.target: RendererElement | null — 依赖声明

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

      • message.suspense.activeBranch.targetStart: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.targetAnchor: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.suspense: SuspenseBoundary | null — 依赖声明

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

      • message.suspense.activeBranch.shapeFlag: number — 依赖声明

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

      • message.suspense.activeBranch.patchFlag: number — 依赖声明

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

      • message.suspense.activeBranch.appContext: AppContext | null — 依赖声明

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

    • message.suspense.isFallbackMountPending: boolean — 依赖声明

      枚举:false / true

    • message.suspense.pendingBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
      • message.suspense.pendingBranch.type: VNodeTypes — 依赖声明

        事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "pendingBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.pendingBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明

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

      • message.suspense.pendingBranch.key: PropertyKey | null — 依赖声明

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

      • message.suspense.pendingBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "pendingBranch">>, "ref"> — 依赖声明

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

      • message.suspense.pendingBranch.scopeId: string | null — 依赖声明

        仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

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

      • message.suspense.pendingBranch.children: VNodeNormalizedChildren — 依赖声明

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

      • message.suspense.pendingBranch.component: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.pendingBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明

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

      • message.suspense.pendingBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明

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

      • message.suspense.pendingBranch.el: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.placeholder: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.anchor: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.target: RendererElement | null — 依赖声明

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

      • message.suspense.pendingBranch.targetStart: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.targetAnchor: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.suspense: SuspenseBoundary | null — 依赖声明

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

      • message.suspense.pendingBranch.shapeFlag: number — 依赖声明

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

      • message.suspense.pendingBranch.patchFlag: number — 依赖声明

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

      • message.suspense.pendingBranch.appContext: AppContext | null — 依赖声明

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

    • message.suspense.deps: number — 依赖声明
    • message.suspense.pendingId: number — 依赖声明
    • message.suspense.timeout: number — 依赖声明
    • message.suspense.isInFallback: boolean — 依赖声明

      枚举:false / true

    • message.suspense.isHydrating: boolean — 依赖声明

      枚举:false / true

    • message.suspense.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • message.suspense.effects: Function[] — 依赖声明

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

    • message.suspense.resolve: (force?: boolean, sync?: boolean) => void — 依赖声明

      事件参数:(force?: boolean | undefined, sync?: boolean | undefined): void

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

    • message.suspense.fallback: (fallbackVNode: VNode) => void — 依赖声明

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

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

    • message.suspense.move: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "move"> — 依赖声明

      事件参数:(container: RendererElement, anchor: RendererNode | null, type: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "move">>, (...args: never[]) => unknown>>[2]): void

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

    • message.suspense.next: () => RendererNode | null — 依赖声明

      事件参数:(): RendererNode | null

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

    • message.suspense.registerDep: PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "registerDep"> — 依赖声明

      事件参数:(instance: ComponentInternalInstance, setupRenderEffect: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamMessageOptions)["message"]>, "suspense">>, "registerDep">>, (...args: never[]) => unknown>>[1], optimized: boolean): void

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

    • message.suspense.unmount: (parentSuspense: SuspenseBoundary | null, doRemove?: boolean) => void — 依赖声明

      事件参数:(parentSuspense: SuspenseBoundary | null, doRemove?: boolean | undefined): void

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

  • message.shapeFlag: number — 依赖声明
  • message.patchFlag: number — 依赖声明
  • message.appContext: AppContext | null — 依赖声明
    • message.appContext.app: App<any> — 依赖声明

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

    • message.appContext.config: AppConfig — 依赖声明

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

    • message.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

    • message.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

    • message.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

    • message.appContext.provides: Record<string | symbol, any> — 依赖声明

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

默认值与来源
""(源码表达式;上游声明)

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

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

plain

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

plain 参数与事件数据

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

枚举:false / true

默认值与来源
false(源码表达式;上游声明)

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

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

showClose

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

showClose 参数与事件数据

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

枚举:false / true

默认值与来源
false(源码表达式;上游声明)

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

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

customClass

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

customClass 参数与事件数据

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

枚举:false

默认值与来源
"asam-message"(已安装运行时;ASAM 声明)

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

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

dangerouslyUseHTMLString

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

dangerouslyUseHTMLString 参数与事件数据

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

枚举:false / true

默认值与来源
false(源码表达式;上游声明)

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

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

grouping

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

grouping 参数与事件数据

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

枚举:false / true

默认值与来源
false(源码表达式;上游声明)

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

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

repeatNum

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

默认值与来源
1(源码表达式;上游声明)

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

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

appendTo

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

appendTo 参数与事件数据

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

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

默认值与来源
isClient ? document.body : void 0(源码表达式;上游声明)

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

AsamMessageOptions 公开类型视图
ts
import type { Attrs, VNode, VNodeTypes, VNodeProps, ComponentInternalInstance, VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNodeNormalizedChildren, ConcreteComponent, ComputedOptions, MethodOptions, AppContext, RendererNode, RendererElement, ReactiveEffect, DirectiveBinding, TransitionHooks, SuspenseBoundary, SuspenseProps, ElementNamespace, App, AppConfig, ComponentOptions, Component, Directive } from 'vue';
import type { AsamMessageOptions, AsamMessageConfigContext, AsamMessageType, AsamMessageBoxData, AsamMessageBoxState, AsamMessageService } from '@asam-ui/ui';

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

// AsamMessageOptions
type PublicContract = {
	"zIndex"?: number | undefined;
	"offset"?: number | undefined;
	"placement"?: "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | undefined;
	"type"?: "primary" | "success" | "warning" | "info" | "error" | undefined;
	"duration"?: number | undefined;
	"icon"?: (AsamMessageOptions)["icon"];
	"onClose"?: (() => void) | undefined;
	"message"?: (AsamMessageOptions)["message"];
	"plain"?: boolean | undefined;
	"showClose"?: boolean | undefined;
	"customClass"?: AsamMessageOptions["customClass"];
	"dangerouslyUseHTMLString"?: boolean | undefined;
	"grouping"?: boolean | undefined;
	"repeatNum"?: number | undefined;
	"appendTo"?: string | HTMLElement | undefined;
};

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

参数与事件说明

type

必填:按分支;声明来源:依赖声明。

type 参数与事件数据

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

契约分支 3

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<VNodeTypes>, (...args: never[]) => unknown>>[1]): any

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

契约分支 4

枚举:"primary" / "success" / "warning" / "info" / "error"

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

来源分支 4

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

props

必填:按分支;声明来源:依赖声明。

key

必填:按分支;声明来源:依赖声明。

ref

必填:按分支;声明来源:依赖声明。

ref 参数与事件数据

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

契约分支 3

  • ref.i: ComponentInternalInstance — 依赖声明

    组件实例。

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

  • ref.r: VNodeRef — 依赖声明

    实际 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.k: string | undefined — 依赖声明

    setup 中的 ref 键。

  • ref.f: boolean | undefined — 依赖声明

    refInFor 标记。

    枚举:false / true

scopeId

必填:按分支;声明来源:依赖声明。

children

必填:按分支;声明来源:依赖声明。

children 参数与事件数据

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

契约分支 3

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

component

必填:按分支;声明来源:依赖声明。

component 参数与事件数据

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

契约分支 3

  • component.uid: number — 依赖声明
  • component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

    事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<ComponentInternalInstance | null>, "type">>, (...args: never[]) => unknown>>[1]): any

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

  • component.parent: ComponentInternalInstance | null — 依赖声明

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

  • component.root: ComponentInternalInstance — 依赖声明

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

  • component.appContext: AppContext — 依赖声明

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

  • component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

    父虚拟 DOM 中代表当前组件的 VNode。

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

  • component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

    当前组件自身虚拟 DOM 树的根 VNode。

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

  • component.effect: ReactiveEffect<any> — 依赖声明

    渲染副作用实例。

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

  • component.update: () => void — 依赖声明

    强制更新渲染副作用。

    事件参数:(): void

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

  • component.job: PublicMember<NonNullable<ComponentInternalInstance | null>, "job"> — 依赖声明

    交给调度器的渲染任务,会检查是否需要更新。

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

  • component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
  • component.exposed: Record<string, any> | null — 依赖声明
  • component.exposeProxy: Record<string, any> | null — 依赖声明
  • component.data: PublicMember<NonNullable<ComponentInternalInstance | null>, "data"> — 依赖声明

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

  • component.props: PublicMember<NonNullable<ComponentInternalInstance | null>, "props"> — 依赖声明

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

  • component.attrs: PublicMember<NonNullable<ComponentInternalInstance | null>, "attrs"> — 依赖声明

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

  • component.slots: PublicMember<NonNullable<ComponentInternalInstance | null>, "slots"> — 依赖声明

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

  • component.refs: PublicMember<NonNullable<ComponentInternalInstance | null>, "refs"> — 依赖声明

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

  • component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

  • component.isMounted: boolean — 依赖声明

    枚举:false / true

  • component.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • component.isDeactivated: boolean — 依赖声明

    枚举:false / true

dirs

必填:按分支;声明来源:依赖声明。

transition

必填:按分支;声明来源:依赖声明。

transition 参数与事件数据

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

契约分支 3

  • transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

    枚举:"default" / "in-out" / "out-in"

  • transition.persisted: boolean — 依赖声明

    枚举:false / true

  • transition.beforeEnter: (el: RendererElement) => void — 依赖声明

    事件参数:(el: RendererElement): void

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

  • transition.enter: (el: RendererElement) => void — 依赖声明

    事件参数:(el: RendererElement): void

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

  • transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

    事件参数:(el: RendererElement, remove: () => void): void

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

  • transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

  • transition.afterLeave: (() => void) | undefined — 依赖声明

    事件参数:(): void

  • transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

    事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

  • transition.delayedLeave: (() => void) | undefined — 依赖声明

    事件参数:(): void

el

必填:按分支;声明来源:依赖声明。

placeholder

必填:按分支;声明来源:依赖声明。

anchor

必填:按分支;声明来源:依赖声明。

target

必填:按分支;声明来源:依赖声明。

targetStart

必填:按分支;声明来源:依赖声明。

targetAnchor

必填:按分支;声明来源:依赖声明。

suspense

必填:按分支;声明来源:依赖声明。

suspense 参数与事件数据

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

契约分支 3

  • suspense.vnode: VNode<RendererNode, RendererElement, SuspenseProps> — 依赖声明

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

  • suspense.parent: SuspenseBoundary | null — 依赖声明

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

  • suspense.parentComponent: ComponentInternalInstance | null — 依赖声明
    • suspense.parentComponent.uid: number — 依赖声明
    • suspense.parentComponent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • suspense.parentComponent.parent: ComponentInternalInstance | null — 依赖声明

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

    • suspense.parentComponent.root: ComponentInternalInstance — 依赖声明

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

    • suspense.parentComponent.appContext: AppContext — 依赖声明

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

    • suspense.parentComponent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

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

    • suspense.parentComponent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

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

    • suspense.parentComponent.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

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

    • suspense.parentComponent.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

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

    • suspense.parentComponent.job: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "job"> — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

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

    • suspense.parentComponent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • suspense.parentComponent.exposed: Record<string, any> | null — 依赖声明
    • suspense.parentComponent.exposeProxy: Record<string, any> | null — 依赖声明
    • suspense.parentComponent.data: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "data"> — 依赖声明

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

    • suspense.parentComponent.props: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "props"> — 依赖声明

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

    • suspense.parentComponent.attrs: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "attrs"> — 依赖声明

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

    • suspense.parentComponent.slots: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "slots"> — 依赖声明

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

    • suspense.parentComponent.refs: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "refs"> — 依赖声明

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

    • suspense.parentComponent.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

    • suspense.parentComponent.isMounted: boolean — 依赖声明

      枚举:false / true

    • suspense.parentComponent.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • suspense.parentComponent.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • suspense.namespace: ElementNamespace — 依赖声明

    枚举:"svg" / "mathml"

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

  • suspense.container: RendererElement — 依赖声明

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

  • suspense.hiddenContainer: RendererElement — 依赖声明

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

  • suspense.activeBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
    • suspense.activeBranch.type: VNodeTypes — 依赖声明

      事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • suspense.activeBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
    • suspense.activeBranch.key: PropertyKey | null — 依赖声明
    • suspense.activeBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "ref"> — 依赖声明
      • suspense.activeBranch.ref.i: ComponentInternalInstance — 依赖声明

        组件实例。

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

      • suspense.activeBranch.ref.r: VNodeRef — 依赖声明

        实际 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

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

      • suspense.activeBranch.ref.k: string | undefined — 依赖声明

        setup 中的 ref 键。

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

      • suspense.activeBranch.ref.f: boolean | undefined — 依赖声明

        refInFor 标记。

        枚举:false / true

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

    • suspense.activeBranch.scopeId: string | null — 依赖声明

      仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

    • suspense.activeBranch.children: VNodeNormalizedChildren — 依赖声明

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

    • suspense.activeBranch.component: ComponentInternalInstance | null — 依赖声明
      • suspense.activeBranch.component.uid: number — 依赖声明

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

      • suspense.activeBranch.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • suspense.activeBranch.component.parent: ComponentInternalInstance | null — 依赖声明

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

      • suspense.activeBranch.component.root: ComponentInternalInstance — 依赖声明

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

      • suspense.activeBranch.component.appContext: AppContext — 依赖声明

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

      • suspense.activeBranch.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • suspense.activeBranch.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • suspense.activeBranch.component.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • suspense.activeBranch.component.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • suspense.activeBranch.component.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • suspense.activeBranch.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • suspense.activeBranch.component.exposed: Record<string, any> | null — 依赖声明

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

      • suspense.activeBranch.component.exposeProxy: Record<string, any> | null — 依赖声明

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

      • suspense.activeBranch.component.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "data"> — 依赖声明

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

      • suspense.activeBranch.component.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "props"> — 依赖声明

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

      • suspense.activeBranch.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "attrs"> — 依赖声明

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

      • suspense.activeBranch.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "slots"> — 依赖声明

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

      • suspense.activeBranch.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "refs"> — 依赖声明

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

      • suspense.activeBranch.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • suspense.activeBranch.component.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.activeBranch.component.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.activeBranch.component.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • suspense.activeBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
    • suspense.activeBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明
      • suspense.activeBranch.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

        枚举:"default" / "in-out" / "out-in"

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

      • suspense.activeBranch.transition.persisted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.activeBranch.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.activeBranch.transition.enter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.activeBranch.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

        事件参数:(el: RendererElement, remove: () => void): void

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

      • suspense.activeBranch.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

      • suspense.activeBranch.transition.afterLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

      • suspense.activeBranch.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

        事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

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

      • suspense.activeBranch.transition.delayedLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

    • suspense.activeBranch.el: RendererNode | null — 依赖声明
    • suspense.activeBranch.placeholder: RendererNode | null — 依赖声明
    • suspense.activeBranch.anchor: RendererNode | null — 依赖声明
    • suspense.activeBranch.target: RendererElement | null — 依赖声明
    • suspense.activeBranch.targetStart: RendererNode | null — 依赖声明
    • suspense.activeBranch.targetAnchor: RendererNode | null — 依赖声明
    • suspense.activeBranch.suspense: SuspenseBoundary | null — 依赖声明

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

    • suspense.activeBranch.shapeFlag: number — 依赖声明
    • suspense.activeBranch.patchFlag: number — 依赖声明
    • suspense.activeBranch.appContext: AppContext | null — 依赖声明
      • suspense.activeBranch.appContext.app: App<any> — 依赖声明

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

      • suspense.activeBranch.appContext.config: AppConfig — 依赖声明

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

      • suspense.activeBranch.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

      • suspense.activeBranch.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

      • suspense.activeBranch.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

      • suspense.activeBranch.appContext.provides: Record<string | symbol, any> — 依赖声明

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

  • suspense.isFallbackMountPending: boolean — 依赖声明

    枚举:false / true

  • suspense.pendingBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
    • suspense.pendingBranch.type: VNodeTypes — 依赖声明

      事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • suspense.pendingBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
    • suspense.pendingBranch.key: PropertyKey | null — 依赖声明
    • suspense.pendingBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "ref"> — 依赖声明
      • suspense.pendingBranch.ref.i: ComponentInternalInstance — 依赖声明

        组件实例。

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

      • suspense.pendingBranch.ref.r: VNodeRef — 依赖声明

        实际 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

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

      • suspense.pendingBranch.ref.k: string | undefined — 依赖声明

        setup 中的 ref 键。

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

      • suspense.pendingBranch.ref.f: boolean | undefined — 依赖声明

        refInFor 标记。

        枚举:false / true

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

    • suspense.pendingBranch.scopeId: string | null — 依赖声明

      仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

    • suspense.pendingBranch.children: VNodeNormalizedChildren — 依赖声明

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

    • suspense.pendingBranch.component: ComponentInternalInstance | null — 依赖声明
      • suspense.pendingBranch.component.uid: number — 依赖声明

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

      • suspense.pendingBranch.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • suspense.pendingBranch.component.parent: ComponentInternalInstance | null — 依赖声明

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

      • suspense.pendingBranch.component.root: ComponentInternalInstance — 依赖声明

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

      • suspense.pendingBranch.component.appContext: AppContext — 依赖声明

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

      • suspense.pendingBranch.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • suspense.pendingBranch.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • suspense.pendingBranch.component.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • suspense.pendingBranch.component.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • suspense.pendingBranch.component.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • suspense.pendingBranch.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • suspense.pendingBranch.component.exposed: Record<string, any> | null — 依赖声明

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

      • suspense.pendingBranch.component.exposeProxy: Record<string, any> | null — 依赖声明

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

      • suspense.pendingBranch.component.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "data"> — 依赖声明

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

      • suspense.pendingBranch.component.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "props"> — 依赖声明

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

      • suspense.pendingBranch.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "attrs"> — 依赖声明

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

      • suspense.pendingBranch.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "slots"> — 依赖声明

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

      • suspense.pendingBranch.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "refs"> — 依赖声明

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

      • suspense.pendingBranch.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • suspense.pendingBranch.component.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.pendingBranch.component.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.pendingBranch.component.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • suspense.pendingBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
    • suspense.pendingBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明
      • suspense.pendingBranch.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

        枚举:"default" / "in-out" / "out-in"

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

      • suspense.pendingBranch.transition.persisted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.pendingBranch.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.pendingBranch.transition.enter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.pendingBranch.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

        事件参数:(el: RendererElement, remove: () => void): void

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

      • suspense.pendingBranch.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

      • suspense.pendingBranch.transition.afterLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

      • suspense.pendingBranch.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

        事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

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

      • suspense.pendingBranch.transition.delayedLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

    • suspense.pendingBranch.el: RendererNode | null — 依赖声明
    • suspense.pendingBranch.placeholder: RendererNode | null — 依赖声明
    • suspense.pendingBranch.anchor: RendererNode | null — 依赖声明
    • suspense.pendingBranch.target: RendererElement | null — 依赖声明
    • suspense.pendingBranch.targetStart: RendererNode | null — 依赖声明
    • suspense.pendingBranch.targetAnchor: RendererNode | null — 依赖声明
    • suspense.pendingBranch.suspense: SuspenseBoundary | null — 依赖声明

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

    • suspense.pendingBranch.shapeFlag: number — 依赖声明
    • suspense.pendingBranch.patchFlag: number — 依赖声明
    • suspense.pendingBranch.appContext: AppContext | null — 依赖声明
      • suspense.pendingBranch.appContext.app: App<any> — 依赖声明

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

      • suspense.pendingBranch.appContext.config: AppConfig — 依赖声明

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

      • suspense.pendingBranch.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

      • suspense.pendingBranch.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

      • suspense.pendingBranch.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

      • suspense.pendingBranch.appContext.provides: Record<string | symbol, any> — 依赖声明

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

  • suspense.deps: number — 依赖声明
  • suspense.pendingId: number — 依赖声明
  • suspense.timeout: number — 依赖声明
  • suspense.isInFallback: boolean — 依赖声明

    枚举:false / true

  • suspense.isHydrating: boolean — 依赖声明

    枚举:false / true

  • suspense.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • suspense.effects: Function[] — 依赖声明

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

  • suspense.resolve: (force?: boolean, sync?: boolean) => void — 依赖声明

    事件参数:(force?: boolean | undefined, sync?: boolean | undefined): void

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

  • suspense.fallback: (fallbackVNode: VNode) => void — 依赖声明

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

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

  • suspense.move: PublicMember<NonNullable<SuspenseBoundary | null>, "move"> — 依赖声明

    事件参数:(container: RendererElement, anchor: RendererNode | null, type: Parameters<Extract<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "move">>, (...args: never[]) => unknown>>[2]): void

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

  • suspense.next: () => RendererNode | null — 依赖声明

    事件参数:(): RendererNode | null

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

  • suspense.registerDep: PublicMember<NonNullable<SuspenseBoundary | null>, "registerDep"> — 依赖声明

    事件参数:(instance: ComponentInternalInstance, setupRenderEffect: Parameters<Extract<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "registerDep">>, (...args: never[]) => unknown>>[1], optimized: boolean): void

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

  • suspense.unmount: (parentSuspense: SuspenseBoundary | null, doRemove?: boolean) => void — 依赖声明

    事件参数:(parentSuspense: SuspenseBoundary | null, doRemove?: boolean | undefined): void

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

shapeFlag

必填:按分支;声明来源:依赖声明。

patchFlag

必填:按分支;声明来源:依赖声明。

appContext

必填:按分支;声明来源:依赖声明。

appContext 参数与事件数据

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

契约分支 3

  • appContext.app: App<any> — 依赖声明

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

  • appContext.config: AppConfig — 依赖声明

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

  • appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

  • appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

  • appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

  • appContext.provides: Record<string | symbol, any> — 依赖声明

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

zIndex

必填:按分支;声明来源:上游声明。

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

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

offset

必填:按分支;声明来源:上游声明。

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

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

placement

必填:按分支;声明来源:上游声明。

placement 参数与事件数据

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

契约分支 4

枚举:"top" / "bottom" / "top-left" / "top-right" / "bottom-left" / "bottom-right"

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

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

duration

必填:按分支;声明来源:上游声明。

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

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

icon

必填:按分支;声明来源:上游声明。

icon 参数与事件数据

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

契约分支 4

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<AsamMessageParams, "icon">>, (...args: never[]) => unknown>>[1]): any

  • icon.__isFragment: undefined — 依赖声明
  • icon.__isTeleport: undefined — 依赖声明
  • icon.__isSuspense: undefined — 依赖声明
默认值与来源
未知 / 未声明

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

onClose

必填:按分支;声明来源:上游声明。

onClose 参数与事件数据

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

契约分支 4

事件参数:(): void

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

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

message

必填:按分支;声明来源:上游声明。

message 参数与事件数据

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

契约分支 4

事件参数:(): ReturnType<Extract<NonNullable<PublicMember<AsamMessageParams, "message">>, (...args: never[]) => unknown>>

  • message.type: VNodeTypes — 依赖声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

  • message.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
  • message.key: PropertyKey | null — 依赖声明
  • message.ref: PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "ref"> — 依赖声明
    • message.ref.i: ComponentInternalInstance — 依赖声明

      组件实例。

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

    • message.ref.r: VNodeRef — 依赖声明

      实际 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

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

    • message.ref.k: string | undefined — 依赖声明

      setup 中的 ref 键。

    • message.ref.f: boolean | undefined — 依赖声明

      refInFor 标记。

      枚举:false / true

  • message.scopeId: string | null — 依赖声明

    仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

  • message.children: VNodeNormalizedChildren — 依赖声明

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

  • message.component: ComponentInternalInstance | null — 依赖声明
    • message.component.uid: number — 依赖声明
    • message.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • message.component.parent: ComponentInternalInstance | null — 依赖声明

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

    • message.component.root: ComponentInternalInstance — 依赖声明

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

    • message.component.appContext: AppContext — 依赖声明

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

    • message.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

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

    • message.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

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

    • message.component.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

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

    • message.component.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

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

    • message.component.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "job"> — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

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

    • message.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • message.component.exposed: Record<string, any> | null — 依赖声明
    • message.component.exposeProxy: Record<string, any> | null — 依赖声明
    • message.component.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "data"> — 依赖声明

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

    • message.component.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "props"> — 依赖声明

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

    • message.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "attrs"> — 依赖声明

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

    • message.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "slots"> — 依赖声明

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

    • message.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "component">>, "refs"> — 依赖声明

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

    • message.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

    • message.component.isMounted: boolean — 依赖声明

      枚举:false / true

    • message.component.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • message.component.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • message.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
  • message.transition: TransitionHooks<RendererElement> | null — 依赖声明
    • message.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

      枚举:"default" / "in-out" / "out-in"

    • message.transition.persisted: boolean — 依赖声明

      枚举:false / true

    • message.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

      事件参数:(el: RendererElement): void

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

    • message.transition.enter: (el: RendererElement) => void — 依赖声明

      事件参数:(el: RendererElement): void

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

    • message.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

      事件参数:(el: RendererElement, remove: () => void): void

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

    • message.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

    • message.transition.afterLeave: (() => void) | undefined — 依赖声明

      事件参数:(): void

    • message.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

      事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

    • message.transition.delayedLeave: (() => void) | undefined — 依赖声明

      事件参数:(): void

  • message.el: RendererNode | null — 依赖声明
  • message.placeholder: RendererNode | null — 依赖声明
  • message.anchor: RendererNode | null — 依赖声明
  • message.target: RendererElement | null — 依赖声明
  • message.targetStart: RendererNode | null — 依赖声明
  • message.targetAnchor: RendererNode | null — 依赖声明
  • message.suspense: SuspenseBoundary | null — 依赖声明
    • message.suspense.vnode: VNode<RendererNode, RendererElement, SuspenseProps> — 依赖声明

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

    • message.suspense.parent: SuspenseBoundary | null — 依赖声明

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

    • message.suspense.parentComponent: ComponentInternalInstance | null — 依赖声明
      • message.suspense.parentComponent.uid: number — 依赖声明

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

      • message.suspense.parentComponent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.parentComponent.parent: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.parentComponent.root: ComponentInternalInstance — 依赖声明

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

      • message.suspense.parentComponent.appContext: AppContext — 依赖声明

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

      • message.suspense.parentComponent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • message.suspense.parentComponent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • message.suspense.parentComponent.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • message.suspense.parentComponent.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • message.suspense.parentComponent.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • message.suspense.parentComponent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • message.suspense.parentComponent.exposed: Record<string, any> | null — 依赖声明

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

      • message.suspense.parentComponent.exposeProxy: Record<string, any> | null — 依赖声明

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

      • message.suspense.parentComponent.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "data"> — 依赖声明

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

      • message.suspense.parentComponent.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "props"> — 依赖声明

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

      • message.suspense.parentComponent.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "attrs"> — 依赖声明

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

      • message.suspense.parentComponent.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "slots"> — 依赖声明

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

      • message.suspense.parentComponent.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "parentComponent">>, "refs"> — 依赖声明

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

      • message.suspense.parentComponent.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • message.suspense.parentComponent.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • message.suspense.parentComponent.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • message.suspense.parentComponent.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • message.suspense.namespace: ElementNamespace — 依赖声明

      枚举:"svg" / "mathml"

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

    • message.suspense.container: RendererElement — 依赖声明

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

    • message.suspense.hiddenContainer: RendererElement — 依赖声明

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

    • message.suspense.activeBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
      • message.suspense.activeBranch.type: VNodeTypes — 依赖声明

        事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "activeBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.activeBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明

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

      • message.suspense.activeBranch.key: PropertyKey | null — 依赖声明

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

      • message.suspense.activeBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "activeBranch">>, "ref"> — 依赖声明

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

      • message.suspense.activeBranch.scopeId: string | null — 依赖声明

        仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

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

      • message.suspense.activeBranch.children: VNodeNormalizedChildren — 依赖声明

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

      • message.suspense.activeBranch.component: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.activeBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明

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

      • message.suspense.activeBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明

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

      • message.suspense.activeBranch.el: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.placeholder: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.anchor: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.target: RendererElement | null — 依赖声明

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

      • message.suspense.activeBranch.targetStart: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.targetAnchor: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.suspense: SuspenseBoundary | null — 依赖声明

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

      • message.suspense.activeBranch.shapeFlag: number — 依赖声明

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

      • message.suspense.activeBranch.patchFlag: number — 依赖声明

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

      • message.suspense.activeBranch.appContext: AppContext | null — 依赖声明

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

    • message.suspense.isFallbackMountPending: boolean — 依赖声明

      枚举:false / true

    • message.suspense.pendingBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
      • message.suspense.pendingBranch.type: VNodeTypes — 依赖声明

        事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "pendingBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.pendingBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明

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

      • message.suspense.pendingBranch.key: PropertyKey | null — 依赖声明

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

      • message.suspense.pendingBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "pendingBranch">>, "ref"> — 依赖声明

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

      • message.suspense.pendingBranch.scopeId: string | null — 依赖声明

        仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

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

      • message.suspense.pendingBranch.children: VNodeNormalizedChildren — 依赖声明

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

      • message.suspense.pendingBranch.component: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.pendingBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明

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

      • message.suspense.pendingBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明

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

      • message.suspense.pendingBranch.el: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.placeholder: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.anchor: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.target: RendererElement | null — 依赖声明

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

      • message.suspense.pendingBranch.targetStart: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.targetAnchor: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.suspense: SuspenseBoundary | null — 依赖声明

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

      • message.suspense.pendingBranch.shapeFlag: number — 依赖声明

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

      • message.suspense.pendingBranch.patchFlag: number — 依赖声明

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

      • message.suspense.pendingBranch.appContext: AppContext | null — 依赖声明

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

    • message.suspense.deps: number — 依赖声明
    • message.suspense.pendingId: number — 依赖声明
    • message.suspense.timeout: number — 依赖声明
    • message.suspense.isInFallback: boolean — 依赖声明

      枚举:false / true

    • message.suspense.isHydrating: boolean — 依赖声明

      枚举:false / true

    • message.suspense.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • message.suspense.effects: Function[] — 依赖声明

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

    • message.suspense.resolve: (force?: boolean, sync?: boolean) => void — 依赖声明

      事件参数:(force?: boolean | undefined, sync?: boolean | undefined): void

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

    • message.suspense.fallback: (fallbackVNode: VNode) => void — 依赖声明

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

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

    • message.suspense.move: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "move"> — 依赖声明

      事件参数:(container: RendererElement, anchor: RendererNode | null, type: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "move">>, (...args: never[]) => unknown>>[2]): void

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

    • message.suspense.next: () => RendererNode | null — 依赖声明

      事件参数:(): RendererNode | null

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

    • message.suspense.registerDep: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "registerDep"> — 依赖声明

      事件参数:(instance: ComponentInternalInstance, setupRenderEffect: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParams, "message">>, "suspense">>, "registerDep">>, (...args: never[]) => unknown>>[1], optimized: boolean): void

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

    • message.suspense.unmount: (parentSuspense: SuspenseBoundary | null, doRemove?: boolean) => void — 依赖声明

      事件参数:(parentSuspense: SuspenseBoundary | null, doRemove?: boolean | undefined): void

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

  • message.shapeFlag: number — 依赖声明
  • message.patchFlag: number — 依赖声明
  • message.appContext: AppContext | null — 依赖声明
    • message.appContext.app: App<any> — 依赖声明

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

    • message.appContext.config: AppConfig — 依赖声明

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

    • message.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

    • message.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

    • message.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

    • message.appContext.provides: Record<string | symbol, any> — 依赖声明

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

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

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

plain

必填:按分支;声明来源:上游声明。

plain 参数与事件数据

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

契约分支 4

枚举:false / true

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

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

showClose

必填:按分支;声明来源:上游声明。

showClose 参数与事件数据

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

契约分支 4

枚举:false / true

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

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

customClass

必填:按分支;声明来源:上游声明。

customClass 参数与事件数据

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

契约分支 4

枚举:false

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

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

dangerouslyUseHTMLString

必填:按分支;声明来源:上游声明。

dangerouslyUseHTMLString 参数与事件数据

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

契约分支 4

枚举:false / true

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

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

grouping

必填:按分支;声明来源:上游声明。

grouping 参数与事件数据

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

契约分支 4

枚举:false / true

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

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

repeatNum

必填:按分支;声明来源:上游声明。

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

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

appendTo

必填:按分支;声明来源:上游声明。

appendTo 参数与事件数据

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

契约分支 4

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

AsamMessageParams 公开类型视图
ts
import type { VNodeTypes, Attrs, VNodeProps, ComponentInternalInstance, VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNodeNormalizedChildren, ConcreteComponent, ComputedOptions, MethodOptions, AppContext, VNode, RendererNode, RendererElement, ReactiveEffect, DirectiveBinding, TransitionHooks, SuspenseBoundary, SuspenseProps, ElementNamespace, App, AppConfig, ComponentOptions, Component, Directive } from 'vue';
import type { AsamMessageParams, AsamMessageConfigContext, AsamMessageOptions, AsamMessageType, AsamMessageBoxData, AsamMessageBoxState, AsamMessageService } from '@asam-ui/ui';

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

// AsamMessageParams
type PublicContract = AsamMessageParams;

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

参数与事件说明

type

必填:按分支;声明来源:依赖声明。

type 参数与事件数据

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

契约分支 3

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<VNodeTypes>, (...args: never[]) => unknown>>[1]): any

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

props

必填:按分支;声明来源:依赖声明。

key

必填:按分支;声明来源:依赖声明。

ref

必填:按分支;声明来源:依赖声明。

ref 参数与事件数据

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

契约分支 3

  • ref.i: ComponentInternalInstance — 依赖声明

    组件实例。

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

  • ref.r: VNodeRef — 依赖声明

    实际 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.k: string | undefined — 依赖声明

    setup 中的 ref 键。

  • ref.f: boolean | undefined — 依赖声明

    refInFor 标记。

    枚举:false / true

scopeId

必填:按分支;声明来源:依赖声明。

children

必填:按分支;声明来源:依赖声明。

children 参数与事件数据

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

契约分支 3

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

component

必填:按分支;声明来源:依赖声明。

component 参数与事件数据

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

契约分支 3

  • component.uid: number — 依赖声明
  • component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

    事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<ComponentInternalInstance | null>, "type">>, (...args: never[]) => unknown>>[1]): any

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

  • component.parent: ComponentInternalInstance | null — 依赖声明

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

  • component.root: ComponentInternalInstance — 依赖声明

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

  • component.appContext: AppContext — 依赖声明

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

  • component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

    父虚拟 DOM 中代表当前组件的 VNode。

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

  • component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

    当前组件自身虚拟 DOM 树的根 VNode。

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

  • component.effect: ReactiveEffect<any> — 依赖声明

    渲染副作用实例。

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

  • component.update: () => void — 依赖声明

    强制更新渲染副作用。

    事件参数:(): void

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

  • component.job: PublicMember<NonNullable<ComponentInternalInstance | null>, "job"> — 依赖声明

    交给调度器的渲染任务,会检查是否需要更新。

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

  • component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
  • component.exposed: Record<string, any> | null — 依赖声明
  • component.exposeProxy: Record<string, any> | null — 依赖声明
  • component.data: PublicMember<NonNullable<ComponentInternalInstance | null>, "data"> — 依赖声明

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

  • component.props: PublicMember<NonNullable<ComponentInternalInstance | null>, "props"> — 依赖声明

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

  • component.attrs: PublicMember<NonNullable<ComponentInternalInstance | null>, "attrs"> — 依赖声明

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

  • component.slots: PublicMember<NonNullable<ComponentInternalInstance | null>, "slots"> — 依赖声明

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

  • component.refs: PublicMember<NonNullable<ComponentInternalInstance | null>, "refs"> — 依赖声明

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

  • component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

  • component.isMounted: boolean — 依赖声明

    枚举:false / true

  • component.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • component.isDeactivated: boolean — 依赖声明

    枚举:false / true

dirs

必填:按分支;声明来源:依赖声明。

transition

必填:按分支;声明来源:依赖声明。

transition 参数与事件数据

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

契约分支 3

  • transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

    枚举:"default" / "in-out" / "out-in"

  • transition.persisted: boolean — 依赖声明

    枚举:false / true

  • transition.beforeEnter: (el: RendererElement) => void — 依赖声明

    事件参数:(el: RendererElement): void

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

  • transition.enter: (el: RendererElement) => void — 依赖声明

    事件参数:(el: RendererElement): void

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

  • transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

    事件参数:(el: RendererElement, remove: () => void): void

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

  • transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

  • transition.afterLeave: (() => void) | undefined — 依赖声明

    事件参数:(): void

  • transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

    事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

  • transition.delayedLeave: (() => void) | undefined — 依赖声明

    事件参数:(): void

el

必填:按分支;声明来源:依赖声明。

placeholder

必填:按分支;声明来源:依赖声明。

anchor

必填:按分支;声明来源:依赖声明。

target

必填:按分支;声明来源:依赖声明。

targetStart

必填:按分支;声明来源:依赖声明。

targetAnchor

必填:按分支;声明来源:依赖声明。

suspense

必填:按分支;声明来源:依赖声明。

suspense 参数与事件数据

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

契约分支 3

  • suspense.vnode: VNode<RendererNode, RendererElement, SuspenseProps> — 依赖声明

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

  • suspense.parent: SuspenseBoundary | null — 依赖声明

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

  • suspense.parentComponent: ComponentInternalInstance | null — 依赖声明
    • suspense.parentComponent.uid: number — 依赖声明
    • suspense.parentComponent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • suspense.parentComponent.parent: ComponentInternalInstance | null — 依赖声明

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

    • suspense.parentComponent.root: ComponentInternalInstance — 依赖声明

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

    • suspense.parentComponent.appContext: AppContext — 依赖声明

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

    • suspense.parentComponent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

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

    • suspense.parentComponent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

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

    • suspense.parentComponent.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

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

    • suspense.parentComponent.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

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

    • suspense.parentComponent.job: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "job"> — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

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

    • suspense.parentComponent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • suspense.parentComponent.exposed: Record<string, any> | null — 依赖声明
    • suspense.parentComponent.exposeProxy: Record<string, any> | null — 依赖声明
    • suspense.parentComponent.data: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "data"> — 依赖声明

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

    • suspense.parentComponent.props: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "props"> — 依赖声明

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

    • suspense.parentComponent.attrs: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "attrs"> — 依赖声明

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

    • suspense.parentComponent.slots: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "slots"> — 依赖声明

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

    • suspense.parentComponent.refs: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "parentComponent">>, "refs"> — 依赖声明

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

    • suspense.parentComponent.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

    • suspense.parentComponent.isMounted: boolean — 依赖声明

      枚举:false / true

    • suspense.parentComponent.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • suspense.parentComponent.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • suspense.namespace: ElementNamespace — 依赖声明

    枚举:"svg" / "mathml"

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

  • suspense.container: RendererElement — 依赖声明

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

  • suspense.hiddenContainer: RendererElement — 依赖声明

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

  • suspense.activeBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
    • suspense.activeBranch.type: VNodeTypes — 依赖声明

      事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • suspense.activeBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
    • suspense.activeBranch.key: PropertyKey | null — 依赖声明
    • suspense.activeBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "ref"> — 依赖声明
      • suspense.activeBranch.ref.i: ComponentInternalInstance — 依赖声明

        组件实例。

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

      • suspense.activeBranch.ref.r: VNodeRef — 依赖声明

        实际 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

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

      • suspense.activeBranch.ref.k: string | undefined — 依赖声明

        setup 中的 ref 键。

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

      • suspense.activeBranch.ref.f: boolean | undefined — 依赖声明

        refInFor 标记。

        枚举:false / true

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

    • suspense.activeBranch.scopeId: string | null — 依赖声明

      仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

    • suspense.activeBranch.children: VNodeNormalizedChildren — 依赖声明

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

    • suspense.activeBranch.component: ComponentInternalInstance | null — 依赖声明
      • suspense.activeBranch.component.uid: number — 依赖声明

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

      • suspense.activeBranch.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • suspense.activeBranch.component.parent: ComponentInternalInstance | null — 依赖声明

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

      • suspense.activeBranch.component.root: ComponentInternalInstance — 依赖声明

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

      • suspense.activeBranch.component.appContext: AppContext — 依赖声明

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

      • suspense.activeBranch.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • suspense.activeBranch.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • suspense.activeBranch.component.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • suspense.activeBranch.component.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • suspense.activeBranch.component.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • suspense.activeBranch.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • suspense.activeBranch.component.exposed: Record<string, any> | null — 依赖声明

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

      • suspense.activeBranch.component.exposeProxy: Record<string, any> | null — 依赖声明

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

      • suspense.activeBranch.component.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "data"> — 依赖声明

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

      • suspense.activeBranch.component.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "props"> — 依赖声明

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

      • suspense.activeBranch.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "attrs"> — 依赖声明

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

      • suspense.activeBranch.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "slots"> — 依赖声明

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

      • suspense.activeBranch.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "activeBranch">>, "component">>, "refs"> — 依赖声明

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

      • suspense.activeBranch.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • suspense.activeBranch.component.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.activeBranch.component.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.activeBranch.component.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • suspense.activeBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
    • suspense.activeBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明
      • suspense.activeBranch.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

        枚举:"default" / "in-out" / "out-in"

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

      • suspense.activeBranch.transition.persisted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.activeBranch.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.activeBranch.transition.enter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.activeBranch.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

        事件参数:(el: RendererElement, remove: () => void): void

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

      • suspense.activeBranch.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

      • suspense.activeBranch.transition.afterLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

      • suspense.activeBranch.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

        事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

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

      • suspense.activeBranch.transition.delayedLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

    • suspense.activeBranch.el: RendererNode | null — 依赖声明
    • suspense.activeBranch.placeholder: RendererNode | null — 依赖声明
    • suspense.activeBranch.anchor: RendererNode | null — 依赖声明
    • suspense.activeBranch.target: RendererElement | null — 依赖声明
    • suspense.activeBranch.targetStart: RendererNode | null — 依赖声明
    • suspense.activeBranch.targetAnchor: RendererNode | null — 依赖声明
    • suspense.activeBranch.suspense: SuspenseBoundary | null — 依赖声明

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

    • suspense.activeBranch.shapeFlag: number — 依赖声明
    • suspense.activeBranch.patchFlag: number — 依赖声明
    • suspense.activeBranch.appContext: AppContext | null — 依赖声明
      • suspense.activeBranch.appContext.app: App<any> — 依赖声明

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

      • suspense.activeBranch.appContext.config: AppConfig — 依赖声明

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

      • suspense.activeBranch.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

      • suspense.activeBranch.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

      • suspense.activeBranch.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

      • suspense.activeBranch.appContext.provides: Record<string | symbol, any> — 依赖声明

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

  • suspense.isFallbackMountPending: boolean — 依赖声明

    枚举:false / true

  • suspense.pendingBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
    • suspense.pendingBranch.type: VNodeTypes — 依赖声明

      事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • suspense.pendingBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
    • suspense.pendingBranch.key: PropertyKey | null — 依赖声明
    • suspense.pendingBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "ref"> — 依赖声明
      • suspense.pendingBranch.ref.i: ComponentInternalInstance — 依赖声明

        组件实例。

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

      • suspense.pendingBranch.ref.r: VNodeRef — 依赖声明

        实际 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

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

      • suspense.pendingBranch.ref.k: string | undefined — 依赖声明

        setup 中的 ref 键。

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

      • suspense.pendingBranch.ref.f: boolean | undefined — 依赖声明

        refInFor 标记。

        枚举:false / true

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

    • suspense.pendingBranch.scopeId: string | null — 依赖声明

      仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

    • suspense.pendingBranch.children: VNodeNormalizedChildren — 依赖声明

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

    • suspense.pendingBranch.component: ComponentInternalInstance | null — 依赖声明
      • suspense.pendingBranch.component.uid: number — 依赖声明

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

      • suspense.pendingBranch.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • suspense.pendingBranch.component.parent: ComponentInternalInstance | null — 依赖声明

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

      • suspense.pendingBranch.component.root: ComponentInternalInstance — 依赖声明

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

      • suspense.pendingBranch.component.appContext: AppContext — 依赖声明

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

      • suspense.pendingBranch.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • suspense.pendingBranch.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • suspense.pendingBranch.component.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • suspense.pendingBranch.component.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • suspense.pendingBranch.component.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • suspense.pendingBranch.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • suspense.pendingBranch.component.exposed: Record<string, any> | null — 依赖声明

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

      • suspense.pendingBranch.component.exposeProxy: Record<string, any> | null — 依赖声明

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

      • suspense.pendingBranch.component.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "data"> — 依赖声明

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

      • suspense.pendingBranch.component.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "props"> — 依赖声明

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

      • suspense.pendingBranch.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "attrs"> — 依赖声明

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

      • suspense.pendingBranch.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "slots"> — 依赖声明

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

      • suspense.pendingBranch.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "pendingBranch">>, "component">>, "refs"> — 依赖声明

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

      • suspense.pendingBranch.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • suspense.pendingBranch.component.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.pendingBranch.component.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.pendingBranch.component.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • suspense.pendingBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
    • suspense.pendingBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明
      • suspense.pendingBranch.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

        枚举:"default" / "in-out" / "out-in"

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

      • suspense.pendingBranch.transition.persisted: boolean — 依赖声明

        枚举:false / true

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

      • suspense.pendingBranch.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.pendingBranch.transition.enter: (el: RendererElement) => void — 依赖声明

        事件参数:(el: RendererElement): void

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

      • suspense.pendingBranch.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

        事件参数:(el: RendererElement, remove: () => void): void

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

      • suspense.pendingBranch.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

      • suspense.pendingBranch.transition.afterLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

      • suspense.pendingBranch.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

        事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

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

      • suspense.pendingBranch.transition.delayedLeave: (() => void) | undefined — 依赖声明

        事件参数:(): void

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

    • suspense.pendingBranch.el: RendererNode | null — 依赖声明
    • suspense.pendingBranch.placeholder: RendererNode | null — 依赖声明
    • suspense.pendingBranch.anchor: RendererNode | null — 依赖声明
    • suspense.pendingBranch.target: RendererElement | null — 依赖声明
    • suspense.pendingBranch.targetStart: RendererNode | null — 依赖声明
    • suspense.pendingBranch.targetAnchor: RendererNode | null — 依赖声明
    • suspense.pendingBranch.suspense: SuspenseBoundary | null — 依赖声明

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

    • suspense.pendingBranch.shapeFlag: number — 依赖声明
    • suspense.pendingBranch.patchFlag: number — 依赖声明
    • suspense.pendingBranch.appContext: AppContext | null — 依赖声明
      • suspense.pendingBranch.appContext.app: App<any> — 依赖声明

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

      • suspense.pendingBranch.appContext.config: AppConfig — 依赖声明

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

      • suspense.pendingBranch.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

      • suspense.pendingBranch.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

      • suspense.pendingBranch.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

      • suspense.pendingBranch.appContext.provides: Record<string | symbol, any> — 依赖声明

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

  • suspense.deps: number — 依赖声明
  • suspense.pendingId: number — 依赖声明
  • suspense.timeout: number — 依赖声明
  • suspense.isInFallback: boolean — 依赖声明

    枚举:false / true

  • suspense.isHydrating: boolean — 依赖声明

    枚举:false / true

  • suspense.isUnmounted: boolean — 依赖声明

    枚举:false / true

  • suspense.effects: Function[] — 依赖声明

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

  • suspense.resolve: (force?: boolean, sync?: boolean) => void — 依赖声明

    事件参数:(force?: boolean | undefined, sync?: boolean | undefined): void

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

  • suspense.fallback: (fallbackVNode: VNode) => void — 依赖声明

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

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

  • suspense.move: PublicMember<NonNullable<SuspenseBoundary | null>, "move"> — 依赖声明

    事件参数:(container: RendererElement, anchor: RendererNode | null, type: Parameters<Extract<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "move">>, (...args: never[]) => unknown>>[2]): void

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

  • suspense.next: () => RendererNode | null — 依赖声明

    事件参数:(): RendererNode | null

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

  • suspense.registerDep: PublicMember<NonNullable<SuspenseBoundary | null>, "registerDep"> — 依赖声明

    事件参数:(instance: ComponentInternalInstance, setupRenderEffect: Parameters<Extract<NonNullable<PublicMember<NonNullable<SuspenseBoundary | null>, "registerDep">>, (...args: never[]) => unknown>>[1], optimized: boolean): void

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

  • suspense.unmount: (parentSuspense: SuspenseBoundary | null, doRemove?: boolean) => void — 依赖声明

    事件参数:(parentSuspense: SuspenseBoundary | null, doRemove?: boolean | undefined): void

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

shapeFlag

必填:按分支;声明来源:依赖声明。

patchFlag

必填:按分支;声明来源:依赖声明。

appContext

必填:按分支;声明来源:依赖声明。

appContext 参数与事件数据

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

契约分支 3

  • appContext.app: App<any> — 依赖声明

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

  • appContext.config: AppConfig — 依赖声明

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

  • appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

  • appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

  • appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

  • appContext.provides: Record<string | symbol, any> — 依赖声明

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

zIndex

必填:按分支;声明来源:上游声明。

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

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

offset

必填:按分支;声明来源:上游声明。

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

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

placement

必填:按分支;声明来源:上游声明。

placement 参数与事件数据

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

契约分支 5

枚举:"top" / "bottom" / "top-left" / "top-right" / "bottom-left" / "bottom-right"

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

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

appendTo

必填:按分支;声明来源:上游声明。

appendTo 参数与事件数据

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

契约分支 5

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

duration

必填:按分支;声明来源:上游声明。

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

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

icon

必填:按分支;声明来源:上游声明。

icon 参数与事件数据

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

契约分支 5

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<AsamMessageParamsWithType, "icon">>, (...args: never[]) => unknown>>[1]): any

  • icon.__isFragment: undefined — 依赖声明
  • icon.__isTeleport: undefined — 依赖声明
  • icon.__isSuspense: undefined — 依赖声明
默认值与来源
未知 / 未声明

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

onClose

必填:按分支;声明来源:上游声明。

onClose 参数与事件数据

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

契约分支 5

事件参数:(): void

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

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

message

必填:按分支;声明来源:上游声明。

message 参数与事件数据

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

契约分支 5

事件参数:(): ReturnType<Extract<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, (...args: never[]) => unknown>>

  • message.type: VNodeTypes — 依赖声明

    事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

  • message.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明
  • message.key: PropertyKey | null — 依赖声明
  • message.ref: PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "ref"> — 依赖声明
    • message.ref.i: ComponentInternalInstance — 依赖声明

      组件实例。

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

    • message.ref.r: VNodeRef — 依赖声明

      实际 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

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

    • message.ref.k: string | undefined — 依赖声明

      setup 中的 ref 键。

    • message.ref.f: boolean | undefined — 依赖声明

      refInFor 标记。

      枚举:false / true

  • message.scopeId: string | null — 依赖声明

    仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

  • message.children: VNodeNormalizedChildren — 依赖声明

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

  • message.component: ComponentInternalInstance | null — 依赖声明
    • message.component.uid: number — 依赖声明
    • message.component.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

      事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

    • message.component.parent: ComponentInternalInstance | null — 依赖声明

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

    • message.component.root: ComponentInternalInstance — 依赖声明

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

    • message.component.appContext: AppContext — 依赖声明

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

    • message.component.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      父虚拟 DOM 中代表当前组件的 VNode。

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

    • message.component.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

      当前组件自身虚拟 DOM 树的根 VNode。

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

    • message.component.effect: ReactiveEffect<any> — 依赖声明

      渲染副作用实例。

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

    • message.component.update: () => void — 依赖声明

      强制更新渲染副作用。

      事件参数:(): void

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

    • message.component.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "job"> — 依赖声明

      交给调度器的渲染任务,会检查是否需要更新。

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

    • message.component.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明
    • message.component.exposed: Record<string, any> | null — 依赖声明
    • message.component.exposeProxy: Record<string, any> | null — 依赖声明
    • message.component.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "data"> — 依赖声明

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

    • message.component.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "props"> — 依赖声明

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

    • message.component.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "attrs"> — 依赖声明

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

    • message.component.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "slots"> — 依赖声明

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

    • message.component.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "component">>, "refs"> — 依赖声明

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

    • message.component.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

    • message.component.isMounted: boolean — 依赖声明

      枚举:false / true

    • message.component.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • message.component.isDeactivated: boolean — 依赖声明

      枚举:false / true

  • message.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明
  • message.transition: TransitionHooks<RendererElement> | null — 依赖声明
    • message.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

      枚举:"default" / "in-out" / "out-in"

    • message.transition.persisted: boolean — 依赖声明

      枚举:false / true

    • message.transition.beforeEnter: (el: RendererElement) => void — 依赖声明

      事件参数:(el: RendererElement): void

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

    • message.transition.enter: (el: RendererElement) => void — 依赖声明

      事件参数:(el: RendererElement): void

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

    • message.transition.leave: (el: RendererElement, remove: () => void) => void — 依赖声明

      事件参数:(el: RendererElement, remove: () => void): void

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

    • message.transition.clone: (vnode: VNode) => TransitionHooks<RendererElement> — 依赖声明

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

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

    • message.transition.afterLeave: (() => void) | undefined — 依赖声明

      事件参数:(): void

    • message.transition.delayLeave: ((el: RendererElement, earlyRemove: () => void, delayedLeave: () => void) => void) | undefined — 依赖声明

      事件参数:(el: RendererElement, earlyRemove: () => void, delayedLeave: () => void): void

    • message.transition.delayedLeave: (() => void) | undefined — 依赖声明

      事件参数:(): void

  • message.el: RendererNode | null — 依赖声明
  • message.placeholder: RendererNode | null — 依赖声明
  • message.anchor: RendererNode | null — 依赖声明
  • message.target: RendererElement | null — 依赖声明
  • message.targetStart: RendererNode | null — 依赖声明
  • message.targetAnchor: RendererNode | null — 依赖声明
  • message.suspense: SuspenseBoundary | null — 依赖声明
    • message.suspense.vnode: VNode<RendererNode, RendererElement, SuspenseProps> — 依赖声明

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

    • message.suspense.parent: SuspenseBoundary | null — 依赖声明

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

    • message.suspense.parentComponent: ComponentInternalInstance | null — 依赖声明
      • message.suspense.parentComponent.uid: number — 依赖声明

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

      • message.suspense.parentComponent.type: ConcreteComponent<{}, any, any, ComputedOptions, MethodOptions, {}, any> — 依赖声明

        事件参数:(props: {}, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.parentComponent.parent: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.parentComponent.root: ComponentInternalInstance — 依赖声明

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

      • message.suspense.parentComponent.appContext: AppContext — 依赖声明

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

      • message.suspense.parentComponent.vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        父虚拟 DOM 中代表当前组件的 VNode。

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

      • message.suspense.parentComponent.subTree: VNode<RendererNode, RendererElement, { [key: string]: any; }> — 依赖声明

        当前组件自身虚拟 DOM 树的根 VNode。

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

      • message.suspense.parentComponent.effect: ReactiveEffect<any> — 依赖声明

        渲染副作用实例。

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

      • message.suspense.parentComponent.update: () => void — 依赖声明

        强制更新渲染副作用。

        事件参数:(): void

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

      • message.suspense.parentComponent.job: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "job"> — 依赖声明

        交给调度器的渲染任务,会检查是否需要更新。

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

      • message.suspense.parentComponent.proxy: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null — 依赖声明

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

      • message.suspense.parentComponent.exposed: Record<string, any> | null — 依赖声明

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

      • message.suspense.parentComponent.exposeProxy: Record<string, any> | null — 依赖声明

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

      • message.suspense.parentComponent.data: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "data"> — 依赖声明

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

      • message.suspense.parentComponent.props: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "props"> — 依赖声明

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

      • message.suspense.parentComponent.attrs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "attrs"> — 依赖声明

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

      • message.suspense.parentComponent.slots: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "slots"> — 依赖声明

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

      • message.suspense.parentComponent.refs: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "parentComponent">>, "refs"> — 依赖声明

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

      • message.suspense.parentComponent.emit: (event: string, ...args: any[]) => void — 依赖声明

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

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

      • message.suspense.parentComponent.isMounted: boolean — 依赖声明

        枚举:false / true

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

      • message.suspense.parentComponent.isUnmounted: boolean — 依赖声明

        枚举:false / true

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

      • message.suspense.parentComponent.isDeactivated: boolean — 依赖声明

        枚举:false / true

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

    • message.suspense.namespace: ElementNamespace — 依赖声明

      枚举:"svg" / "mathml"

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

    • message.suspense.container: RendererElement — 依赖声明

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

    • message.suspense.hiddenContainer: RendererElement — 依赖声明

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

    • message.suspense.activeBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
      • message.suspense.activeBranch.type: VNodeTypes — 依赖声明

        事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "activeBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.activeBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明

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

      • message.suspense.activeBranch.key: PropertyKey | null — 依赖声明

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

      • message.suspense.activeBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "activeBranch">>, "ref"> — 依赖声明

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

      • message.suspense.activeBranch.scopeId: string | null — 依赖声明

        仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

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

      • message.suspense.activeBranch.children: VNodeNormalizedChildren — 依赖声明

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

      • message.suspense.activeBranch.component: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.activeBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明

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

      • message.suspense.activeBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明

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

      • message.suspense.activeBranch.el: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.placeholder: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.anchor: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.target: RendererElement | null — 依赖声明

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

      • message.suspense.activeBranch.targetStart: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.targetAnchor: RendererNode | null — 依赖声明

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

      • message.suspense.activeBranch.suspense: SuspenseBoundary | null — 依赖声明

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

      • message.suspense.activeBranch.shapeFlag: number — 依赖声明

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

      • message.suspense.activeBranch.patchFlag: number — 依赖声明

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

      • message.suspense.activeBranch.appContext: AppContext | null — 依赖声明

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

    • message.suspense.isFallbackMountPending: boolean — 依赖声明

      枚举:false / true

    • message.suspense.pendingBranch: VNode<RendererNode, RendererElement, { [key: string]: any; }> | null — 依赖声明
      • message.suspense.pendingBranch.type: VNodeTypes — 依赖声明

        事件参数:(props: any, ctx: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "pendingBranch">>, "type">>, (...args: never[]) => unknown>>[1]): any

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

      • message.suspense.pendingBranch.props: (VNodeProps & { [key: string]: any; }) | null — 依赖声明

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

      • message.suspense.pendingBranch.key: PropertyKey | null — 依赖声明

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

      • message.suspense.pendingBranch.ref: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "pendingBranch">>, "ref"> — 依赖声明

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

      • message.suspense.pendingBranch.scopeId: string | null — 依赖声明

        仅用于 SFC;创建 VNode 时由 currentScopeId 赋值,与 currentRenderingInstance 配合使用。

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

      • message.suspense.pendingBranch.children: VNodeNormalizedChildren — 依赖声明

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

      • message.suspense.pendingBranch.component: ComponentInternalInstance | null — 依赖声明

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

      • message.suspense.pendingBranch.dirs: DirectiveBinding<any, string, any>[] | null — 依赖声明

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

      • message.suspense.pendingBranch.transition: TransitionHooks<RendererElement> | null — 依赖声明

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

      • message.suspense.pendingBranch.el: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.placeholder: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.anchor: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.target: RendererElement | null — 依赖声明

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

      • message.suspense.pendingBranch.targetStart: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.targetAnchor: RendererNode | null — 依赖声明

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

      • message.suspense.pendingBranch.suspense: SuspenseBoundary | null — 依赖声明

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

      • message.suspense.pendingBranch.shapeFlag: number — 依赖声明

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

      • message.suspense.pendingBranch.patchFlag: number — 依赖声明

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

      • message.suspense.pendingBranch.appContext: AppContext | null — 依赖声明

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

    • message.suspense.deps: number — 依赖声明
    • message.suspense.pendingId: number — 依赖声明
    • message.suspense.timeout: number — 依赖声明
    • message.suspense.isInFallback: boolean — 依赖声明

      枚举:false / true

    • message.suspense.isHydrating: boolean — 依赖声明

      枚举:false / true

    • message.suspense.isUnmounted: boolean — 依赖声明

      枚举:false / true

    • message.suspense.effects: Function[] — 依赖声明

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

    • message.suspense.resolve: (force?: boolean, sync?: boolean) => void — 依赖声明

      事件参数:(force?: boolean | undefined, sync?: boolean | undefined): void

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

    • message.suspense.fallback: (fallbackVNode: VNode) => void — 依赖声明

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

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

    • message.suspense.move: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "move"> — 依赖声明

      事件参数:(container: RendererElement, anchor: RendererNode | null, type: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "move">>, (...args: never[]) => unknown>>[2]): void

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

    • message.suspense.next: () => RendererNode | null — 依赖声明

      事件参数:(): RendererNode | null

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

    • message.suspense.registerDep: PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "registerDep"> — 依赖声明

      事件参数:(instance: ComponentInternalInstance, setupRenderEffect: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<PublicMember<AsamMessageParamsWithType, "message">>, "suspense">>, "registerDep">>, (...args: never[]) => unknown>>[1], optimized: boolean): void

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

    • message.suspense.unmount: (parentSuspense: SuspenseBoundary | null, doRemove?: boolean) => void — 依赖声明

      事件参数:(parentSuspense: SuspenseBoundary | null, doRemove?: boolean | undefined): void

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

  • message.shapeFlag: number — 依赖声明
  • message.patchFlag: number — 依赖声明
  • message.appContext: AppContext | null — 依赖声明
    • message.appContext.app: App<any> — 依赖声明

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

    • message.appContext.config: AppConfig — 依赖声明

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

    • message.appContext.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

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

    • message.appContext.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

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

    • message.appContext.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

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

    • message.appContext.provides: Record<string | symbol, any> — 依赖声明

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

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

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

plain

必填:按分支;声明来源:上游声明。

plain 参数与事件数据

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

契约分支 5

枚举:false / true

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

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

showClose

必填:按分支;声明来源:上游声明。

showClose 参数与事件数据

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

契约分支 5

枚举:false / true

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

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

customClass

必填:按分支;声明来源:上游声明。

customClass 参数与事件数据

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

契约分支 5

枚举:false

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

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

dangerouslyUseHTMLString

必填:按分支;声明来源:上游声明。

dangerouslyUseHTMLString 参数与事件数据

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

契约分支 5

枚举:false / true

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

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

grouping

必填:按分支;声明来源:上游声明。

grouping 参数与事件数据

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

契约分支 5

枚举:false / true

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

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

repeatNum

必填:按分支;声明来源:上游声明。

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

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

AsamMessageParamsWithType 公开类型视图
ts
import type { VNodeTypes, Attrs, VNodeProps, ComponentInternalInstance, VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNodeNormalizedChildren, ConcreteComponent, ComputedOptions, MethodOptions, AppContext, VNode, RendererNode, RendererElement, ReactiveEffect, DirectiveBinding, TransitionHooks, SuspenseBoundary, SuspenseProps, ElementNamespace, App, AppConfig, ComponentOptions, Component, Directive } from 'vue';
import type { AsamMessageParamsWithType, AsamMessageConfigContext, AsamMessageOptions, AsamMessageType, AsamMessageBoxData, AsamMessageBoxState, AsamMessageService } from '@asam-ui/ui';

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

// AsamMessageParamsWithType
type PublicContract = AsamMessageParamsWithType;

参数与事件说明

close

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

close 参数与事件数据

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

事件参数:(): void

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

// AsamMessageHandler
type PublicContract = {
	"close": () => void;
};

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

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

// AsamMessageType
type PublicContract = AsamMessageType;

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

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

// AsamMessagePlacement
type PublicContract = AsamMessagePlacement;

参数与事件说明

max

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

grouping

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

grouping 参数与事件数据

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

枚举:false / true

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

固定上游源码默认表达式:messageDefaults.grouping(2.14.7;源码事实,未作为 ASAM 运行实测)

duration

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:messageDefaults.duration(2.14.7;源码事实,未作为 ASAM 运行实测)

offset

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:messageDefaults.offset(2.14.7;源码事实,未作为 ASAM 运行实测)

showClose

必填:否;声明来源:上游声明。

showClose 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:messageDefaults.showClose(2.14.7;源码事实,未作为 ASAM 运行实测)

plain

必填:否;声明来源:上游声明。

plain 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:messageDefaults.plain(2.14.7;源码事实,未作为 ASAM 运行实测)

placement

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:messageDefaults.placement(2.14.7;源码事实,未作为 ASAM 运行实测)

AsamMessageConfigContext 公开类型视图
ts
import type { AsamMessageConfigContext, AsamMessageOptions } from '@asam-ui/ui';

// AsamMessageConfigContext
type PublicContract = {
	"max"?: number | undefined;
	"grouping"?: boolean | undefined;
	"duration"?: number | undefined;
	"offset"?: number | undefined;
	"showClose"?: boolean | undefined;
	"plain"?: boolean | undefined;
	"placement"?: string | undefined;
};

参数与事件说明

closeAll

必填:是;声明来源:上游声明。

closeAll 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(type?: "primary" | "success" | "warning" | "info" | "error" | undefined): void

closeAllByPlacement

必填:是;声明来源:上游声明。

closeAllByPlacement 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(position: AsamMessagePlacement): void

primary

必填:是;声明来源:上游声明。

primary 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

success

必填:是;声明来源:上游声明。

success 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

warning

必填:是;声明来源:上游声明。

warning 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

info

必填:是;声明来源:上游声明。

info 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

error

必填:是;声明来源:上游声明。

error 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(options?: AsamMessageParamsWithType, appContext?: Parameters<Extract<NonNullable<AsamMessageService["primary"]>, (...args: never[]) => unknown>>[1]): AsamMessageHandler

_context

必填:是;声明来源:ASAM 声明。

_context 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • _context.app: App<any> — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • _context.config: AppConfig — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • _context.mixins: ComponentOptions<{}, any, any, any, any, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>[] — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • _context.components: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>> — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • _context.directives: Record<string, Directive<any, any, string, any>> — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • _context.provides: Record<string | symbol, any> — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

install

必填:是;声明来源:ASAM 声明。

install 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(app: App<any>): void

AsamMessageService 公开类型视图
ts
import type { AppContext, App, AppConfig, ComponentOptions, ComponentProvideOptions, Component, ComputedOptions, MethodOptions, Directive } from 'vue';
import type { AsamMessageService, AsamMessageType, AsamMessageOptions, AsamMessagePlacement, AsamMessageParamsWithType, AsamMessageHandler, AsamMessageParams } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamMessageService
type PublicContract = {
	(options?: AsamMessageParams, appContext?: Parameters<AsamMessageService>[1]): AsamMessageHandler;
	"closeAll": (type?: AsamMessageType) => void;
	"closeAllByPlacement": (position: AsamMessagePlacement) => void;
	"primary": AsamMessageService["primary"];
	"success": AsamMessageService["primary"];
	"warning": AsamMessageService["primary"];
	"info": AsamMessageService["primary"];
	"error": AsamMessageService["primary"];
	"_context": AppContext | null;
	"install": (app: App) => void;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭