浮层

对话框 AsamDialog

在独立浮层中完成短流程或确认操作,以 v-model 控制显隐。

使用场景 ​

在独立浮层中完成短流程或确认操作,以 v-model 控制显隐。

受控显隐与标题图标 ​

点击打开,使用底部完成按钮或关闭按钮关闭;焦点返回打开按钮。

受控显隐与标题图标

展开源码

关闭确认与公开方法 ​

存在未保存内容时,关闭按钮进入确认步骤;确认后调用保存的 done。取消确认继续编辑。

关闭确认与公开方法

展开源码

多文件表单与完成关闭 ​

正文由独立 DraftFields.vue 提供;TS/JS 均展示并运行两个原生 SFC。

多文件表单与完成关闭

展开源码

独立浮层尺寸 ​

逐个选择实际宽度档位,显式 width 用于覆盖尺寸值;窄屏由组件样式约束。

独立浮层尺寸

展开源码

使用约定 ​

header、icon、default、footer 插槽分别承载标题、标识、正文和操作。 完整说明。

完整用法 ​

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

显隐与关闭守卫 ​

显隐与关闭守卫

展开源码

表单与表格内容 ​

表单与表格内容

展开源码

标题插槽 ​

标题插槽

展开源码

嵌套弹窗 ​

嵌套弹窗

展开源码

居中内容 ​

居中内容

展开源码

垂直居中 ​

垂直居中

展开源码

关闭后销毁内容 ​

关闭后销毁内容

展开源码

拖动、溢出与复位 ​

拖动、溢出与复位

展开源码

全屏 ​

全屏

展开源码

遮罩配置 ​

遮罩配置

展开源码

自定义动画 ​

自定义动画

展开源码

完整交互:events ​

完整交互:events

展开源码

组合职责与生命周期 ​

modelValue 控制显隐,open/opened 与 close/closed 分别观察开始和过渡完成。 完整说明。

原生显隐与焦点 ​

省略 appendToBody 等交互参数使用 原生公开组件 默认值;显式 undefined、null、false 原样传递。打开、关闭、自动聚焦及过渡事件使用原生顺序,关闭守卫、Esc 和焦点回退交由原生处理。ASAM 仅保留标题、图标与尺寸外观,公开实例方法保留原生 this、返回值及实时引用。

自定义 header 直接接收原生 close/titleId/titleClass,并由调用方声明标题节点;组件不额外包裹 heading 或重复设置 titleId。未提供 header 时,默认标题保留 ASAM 的标题、图标与外观。

参数省略时的默认值 ​

closeOnClickModal、closeOnPressEscape、lockScroll、modal、showClose 省略时均由原生组件采用 true。显式提供 false、undefined 或后续移除参数仍按原生契约透传;API 表的默认值描述省略参数,不是包装层的内部布尔转换结果。

局部与全局挂载 ​

局部模式将遮罩限制在演示区域;全局模式使用默认视口范围。 开关显示当前模式,两个模式均可操作;关闭后可以再次切换。

局部与全局挂载

展开源码

API

属性 AsamDialogProps

属性名说明类型默认值
showClose省略时采用透传的原生默认值。boolean | undefinedtrue
modal省略时采用透传的原生默认值。boolean | undefinedtrue
lockScroll省略时采用透传的原生默认值。boolean | undefinedtrue
closeOnPressEscape省略时采用透传的原生默认值。boolean | undefinedtrue
closeOnClickModal省略时采用透传的原生默认值。boolean | undefinedtrue
size—enum"large" | "default" | "small" | "mini"完整类型:AsamDialogSize | undefined—
icon—Component | undefined—
zIndex和原生的 CSS 的 z-index 相同,改变 z 轴的顺序number | undefined—
appendTo对话框挂载的目标元素。string | HTMLElement | undefined—
transition对话框过渡配置,可以是过渡名称字符串,或 Vue 过渡属性对象。AsamDialogTransition—
titleDialog 对话框 Dialog 的标题, 也可通过具名 slot (见下表)传入string | undefined—
width对话框的宽度,默认值为 50%string | number | undefined—
topdialog CSS 中的 margin-top 值,默认为 15vhstring | undefined—
center是否让 Dialog 的 header 和 footer 部分居中排列boolean | undefinedfalse
modelValue是否显示 Dialogboolean | undefinedfalse
alignCenter是否水平垂直对齐对话框boolean | undefinedfalse
headerClassheader 部分的自定义 class 名AsamDialogProps["headerClass"]false
draggable为 Dialog 启用可拖拽功能boolean | undefinedfalse
bodyClassbody 部分的自定义 class 名AsamDialogProps["headerClass"]false
footerClassfooter 部分的自定义 class 名AsamDialogProps["headerClass"]false
appendToBodyDialog 自身是否插入至 body 元素上。嵌套的 Dialog 必须指定该属性并赋值为 trueboolean | undefinedfalse
beforeClose关闭前的回调,会暂停 Dialog 的关闭. 回调函数内执行 done 参数方法的时候才是真正关闭对话框的时候.(AsamDialogProps)["beforeClose"]—
destroyOnClose当关闭 Dialog 时,销毁其中的元素boolean | undefinedfalse
modalPenetrable遮罩是否允许点击穿透。boolean | undefinedfalse
openDelaydialog 打开的延时时间,单位毫秒number | undefined—
closeDelaydialog 关闭的延时时间,单位毫秒number | undefined—
modalClass遮罩的自定义类名AsamDialogProps["headerClass"]false
trapFocus将焦点限制在对话框内。boolean | undefinedfalse
headerAriaLevelheader 的 aria-level 属性string | undefined—
closeIcon自定义关闭图标,默认Close(AsamDialogProps)["closeIcon"]—
overflow拖动范围可以超出可视区boolean | undefinedfalse
fullscreen是否为全屏 Dialogboolean | undefinedfalse
ariaLevelheader 的 aria-level 属性string | undefined—

事件 AsamDialogEmits

属性名说明类型默认值
update:modelValue—[value: boolean]—
open—(AsamDialogEmits)["open"]—
opened—(AsamDialogEmits)["opened"]—
close—(AsamDialogEmits)["close"]—
closed—(AsamDialogEmits)["closed"]—
openAutoFocus—(AsamDialogEmits)["openAutoFocus"]—
closeAutoFocus—(AsamDialogEmits)["closeAutoFocus"]—

插槽 AsamDialogSlots

属性名说明类型默认值
header—((props: { close: () => void; titleId: string; titleClass: string; }) => unknown) | undefined—
title—(() => unknown) | undefined—
icon—(() => unknown) | undefined—
default—(() => unknown) | undefined—
footer—(() => unknown) | undefined—

实例方法与状态 AsamDialogExpose

属性名说明类型默认值
visible对话框是否可见。boolean—
dialogContentRef—any—
resetPosition—() => void—
handleClose—() => void—

类型 AsamDialogSize

类型 AsamDialogTransition

属性名说明类型默认值
name—string | undefined—
type—enum"transition" | "animation"完整类型:PublicMember<AsamDialogTransition, "type">—
css—boolean | undefined—
duration—number | { enter: number; leave: number; } | undefined—
enterFromClass—string | undefined—
enterActiveClass—string | undefined—
enterToClass—string | undefined—
appearFromClass—string | undefined—
appearActiveClass—string | undefined—
appearToClass—string | undefined—
leaveFromClass—string | undefined—
leaveActiveClass—string | undefined—
leaveToClass—string | undefined—
mode—enum"default" | "in-out" | "out-in"完整类型:"default" | "in-out" | "out-in" | undefined—
appear—boolean | undefined—
persisted—boolean | undefined—
onBeforeEnter—PublicMember<AsamDialogTransition, "onBeforeEnter">—
onEnter—PublicMember<AsamDialogTransition, "onEnter">—
onAfterEnter—PublicMember<AsamDialogTransition, "onAfterEnter">—
onEnterCancelled—PublicMember<AsamDialogTransition, "onEnterCancelled">—
onBeforeLeave—PublicMember<AsamDialogTransition, "onBeforeLeave">—
onLeave—PublicMember<AsamDialogTransition, "onLeave">—
onAfterLeave—PublicMember<AsamDialogTransition, "onAfterLeave">—
onLeaveCancelled—PublicMember<AsamDialogTransition, "onLeaveCancelled">—
onBeforeAppear—PublicMember<AsamDialogTransition, "onBeforeAppear">—
onAppear—PublicMember<AsamDialogTransition, "onAppear">—
onAfterAppear—PublicMember<AsamDialogTransition, "onAfterAppear">—
onAppearCancelled—PublicMember<AsamDialogTransition, "onAppearCancelled">—

用法与契约补充说明 ​

使用约定 ​

header、icon、default、footer 插槽分别承载标题、标识、正文和操作。ASAM 提供默认标题 icon 与独立尺寸 default/small/mini/large;焦点恢复沿用原生行为,width 可明确覆盖尺寸宽度。这组尺寸是浮层宽度,不是控件四档密度。beforeClose(done) 可拦截关闭按钮/遮罩;自定义底部按钮自行决定何时关闭。open/opened 与 close/closed 分别对应开始和动画完成。公开 handleClose 可走关闭流程,resetPosition 可重置拖动位置;不要写入内部 refs。

组合职责与生命周期 ​

modelValue 控制显隐,open/opened 与 close/closed 分别观察开始和过渡完成。beforeClose 只拦截组件的关闭入口;业务直接修改 modelValue 时自己执行校验。header 可获得 close/titleId/titleClass,footer 承担业务操作,title 与 icon 为 ASAM 扩展。handleClose 经过关闭守卫;visible/dialogContentRef 为实时句柄,resetPosition 用于拖动后复位。嵌套层使用独立状态,并按 appendToBody/appendTo 决定挂载容器;destroyOnClose 销毁内容,重新打开会创建新的内容节点。fullscreen、alignCenter、modalPenetrable 与 transition 可独立组合。size 的 default/small/mini/large 是弹层宽度别名,width 显式值优先,和四档控件密度分别配置。

参数与事件补充说明

参数与事件说明

showClose

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

showClose 参数与事件数据

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

枚举:false / true

默认值与来源
true(声明注释;ASAM 声明)

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

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

modal

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

modal 参数与事件数据

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

枚举:false / true

默认值与来源
true(声明注释;ASAM 声明)

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

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

lockScroll

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

lockScroll 参数与事件数据

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

枚举:false / true

默认值与来源
true(声明注释;ASAM 声明)

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

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

closeOnPressEscape

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

closeOnPressEscape 参数与事件数据

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

枚举:false / true

默认值与来源
true(声明注释;ASAM 声明)

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

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

closeOnClickModal

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

closeOnClickModal 参数与事件数据

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

枚举:false / true

默认值与来源
true(声明注释;ASAM 声明)

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

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

size

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

size 参数与事件数据

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

枚举:"large" / "default" / "small" / "mini"

icon

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

icon 参数与事件数据

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

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

  • icon.__isFragment: undefined — 依赖声明
  • icon.__isTeleport: undefined — 依赖声明
  • icon.__isSuspense: undefined — 依赖声明
zIndex

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

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

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

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

appendTo

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

appendTo 参数与事件数据

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

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

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

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

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

transition

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

transition 参数与事件数据

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

  • transition.name: string | undefined — 依赖声明
  • transition.type: PublicMember<NonNullable<AsamDialogTransition>, "type"> — 依赖声明

    枚举:"transition" / "animation"

  • transition.css: boolean | undefined — 依赖声明

    枚举:false / true

  • transition.duration: number | { enter: number; leave: number; } | undefined — 依赖声明
    • transition.duration.enter: number — 依赖声明
    • transition.duration.leave: number — 依赖声明
  • transition.enterFromClass: string | undefined — 依赖声明
  • transition.enterActiveClass: string | undefined — 依赖声明
  • transition.enterToClass: string | undefined — 依赖声明
  • transition.appearFromClass: string | undefined — 依赖声明
  • transition.appearActiveClass: string | undefined — 依赖声明
  • transition.appearToClass: string | undefined — 依赖声明
  • transition.leaveFromClass: string | undefined — 依赖声明
  • transition.leaveActiveClass: string | undefined — 依赖声明
  • transition.leaveToClass: string | undefined — 依赖声明
  • transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

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

  • transition.appear: boolean | undefined — 依赖声明

    枚举:false / true

  • transition.persisted: boolean | undefined — 依赖声明

    枚举:false / true

  • transition.onBeforeEnter: PublicMember<NonNullable<AsamDialogTransition>, "onBeforeEnter"> — 依赖声明

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

  • transition.onEnter: PublicMember<NonNullable<AsamDialogTransition>, "onEnter"> — 依赖声明

    事件参数:(el: Element, done: () => void): void

  • transition.onAfterEnter: PublicMember<NonNullable<AsamDialogTransition>, "onAfterEnter"> — 依赖声明

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

  • transition.onEnterCancelled: PublicMember<NonNullable<AsamDialogTransition>, "onEnterCancelled"> — 依赖声明

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

  • transition.onBeforeLeave: PublicMember<NonNullable<AsamDialogTransition>, "onBeforeLeave"> — 依赖声明

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

  • transition.onLeave: PublicMember<NonNullable<AsamDialogTransition>, "onLeave"> — 依赖声明

    事件参数:(el: Element, done: () => void): void

  • transition.onAfterLeave: PublicMember<NonNullable<AsamDialogTransition>, "onAfterLeave"> — 依赖声明

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

  • transition.onLeaveCancelled: PublicMember<NonNullable<AsamDialogTransition>, "onLeaveCancelled"> — 依赖声明

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

  • transition.onBeforeAppear: PublicMember<NonNullable<AsamDialogTransition>, "onBeforeAppear"> — 依赖声明

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

  • transition.onAppear: PublicMember<NonNullable<AsamDialogTransition>, "onAppear"> — 依赖声明

    事件参数:(el: Element, done: () => void): void

  • transition.onAfterAppear: PublicMember<NonNullable<AsamDialogTransition>, "onAfterAppear"> — 依赖声明

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

  • transition.onAppearCancelled: PublicMember<NonNullable<AsamDialogTransition>, "onAppearCancelled"> — 依赖声明

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

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

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

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

title

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

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

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

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

width

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

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

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

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

top

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

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

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

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

center

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

center 参数与事件数据

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

枚举:false / true

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

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

modelValue

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

modelValue 参数与事件数据

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

枚举:false / true

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

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

alignCenter

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

alignCenter 参数与事件数据

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

枚举:false / true

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

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

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

headerClass

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

headerClass 参数与事件数据

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

枚举:false

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

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

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

draggable

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

draggable 参数与事件数据

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

枚举:false / true

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

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

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

bodyClass

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

bodyClass 参数与事件数据

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

枚举:false

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

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

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

footerClass

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

footerClass 参数与事件数据

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

枚举:false

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

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

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

appendToBody

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

appendToBody 参数与事件数据

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

枚举:false / true

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

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

beforeClose

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

beforeClose 参数与事件数据

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

事件参数:(done: Parameters<Extract<NonNullable<(AsamDialogProps)["beforeClose"]>, (...args: never[]) => unknown>>[0]): void

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

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

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

destroyOnClose

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

destroyOnClose 参数与事件数据

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

枚举:false / true

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

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

modalPenetrable

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

modalPenetrable 参数与事件数据

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

枚举:false / true

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

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

openDelay

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

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

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

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

closeDelay

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

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

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

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

modalClass

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

modalClass 参数与事件数据

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

枚举:false

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

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

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

trapFocus

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

trapFocus 参数与事件数据

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

枚举:false / true

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

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

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

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

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

closeIcon

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

closeIcon 参数与事件数据

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

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

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

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

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

overflow

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

overflow 参数与事件数据

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

枚举:false / true

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

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

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

fullscreen

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

fullscreen 参数与事件数据

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

枚举:false / true

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

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

ariaLevel

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

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

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

AsamDialogProps 公开类型视图
ts
import type { Component, Attrs } from 'vue';
import type { AsamDialogProps, AsamDialogSize, AsamDialogExpose, AsamDialogTransition } from '@asam-ui/ui';

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

// AsamDialogProps
type PublicContract = {
	"showClose"?: boolean | undefined;
	"modal"?: boolean | undefined;
	"lockScroll"?: boolean | undefined;
	"closeOnPressEscape"?: boolean | undefined;
	"closeOnClickModal"?: boolean | undefined;
	"size"?: AsamDialogSize | undefined;
	"icon"?: Component | undefined;
	"zIndex"?: number | undefined;
	"appendTo"?: string | HTMLElement | undefined;
	"transition"?: AsamDialogTransition;
	"title"?: string | undefined;
	"width"?: string | number | undefined;
	"top"?: string | undefined;
	"center"?: boolean | undefined;
	"modelValue"?: boolean | undefined;
	"alignCenter"?: boolean | undefined;
	"headerClass"?: AsamDialogProps["headerClass"];
	"draggable"?: boolean | undefined;
	"bodyClass"?: AsamDialogProps["headerClass"];
	"footerClass"?: AsamDialogProps["headerClass"];
	"appendToBody"?: boolean | undefined;
	"beforeClose"?: (AsamDialogProps)["beforeClose"];
	"destroyOnClose"?: boolean | undefined;
	"modalPenetrable"?: boolean | undefined;
	"openDelay"?: number | undefined;
	"closeDelay"?: number | undefined;
	"modalClass"?: AsamDialogProps["headerClass"];
	"trapFocus"?: boolean | undefined;
	"headerAriaLevel"?: string | undefined;
	"closeIcon"?: (AsamDialogProps)["closeIcon"];
	"overflow"?: boolean | undefined;
	"fullscreen"?: boolean | undefined;
	"ariaLevel"?: string | undefined;
};

参数与事件说明

update:modelValue

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

open

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

opened

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

close

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

closed

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

openAutoFocus

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

closeAutoFocus

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

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

// AsamDialogEmits
type PublicContract = {
	"update:modelValue": [value: boolean];
	"open": (AsamDialogEmits)["open"];
	"opened": (AsamDialogEmits)["opened"];
	"close": (AsamDialogEmits)["close"];
	"closed": (AsamDialogEmits)["closed"];
	"openAutoFocus": (AsamDialogEmits)["openAutoFocus"];
	"closeAutoFocus": (AsamDialogEmits)["closeAutoFocus"];
};

参数与事件说明

header

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

header 参数与事件数据

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

事件参数:(props: { close: () => void; titleId: string; titleClass: string; }): unknown

title

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

title 参数与事件数据

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

事件参数:(): unknown

icon

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

icon 参数与事件数据

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

事件参数:(): unknown

default

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

default 参数与事件数据

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

事件参数:(): unknown

footer

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

footer 参数与事件数据

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

事件参数:(): unknown

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

// AsamDialogSlots
type PublicContract = {
	"header"?: ((props: { close: () => void; titleId: string; titleClass: string; }) => unknown) | undefined;
	"title"?: (() => unknown) | undefined;
	"icon"?: (() => unknown) | undefined;
	"default"?: (() => unknown) | undefined;
	"footer"?: (() => unknown) | undefined;
};

参数与事件说明

visible

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

visible 参数与事件数据

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

枚举:false / true

dialogContentRef

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

resetPosition

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

resetPosition 参数与事件数据

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

事件参数:(): void

handleClose

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

handleClose 参数与事件数据

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

事件参数:(): void

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

// AsamDialogExpose
type PublicContract = {
	"visible": boolean;
	"dialogContentRef": any;
	"resetPosition": () => void;
	"handleClose": () => void;
};

浮层使用独立尺寸,与控件密度分别配置。

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

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

// AsamDialogSize
type PublicContract = AsamDialogSize;

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

参数与事件说明

name

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

type

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

type 参数与事件数据

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

契约分支 3

枚举:"transition" / "animation"

css

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

css 参数与事件数据

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

契约分支 3

枚举:false / true

duration

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

duration 参数与事件数据

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

契约分支 3

  • duration.enter: number — 依赖声明
  • duration.leave: number — 依赖声明
enterFromClass

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

enterActiveClass

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

enterToClass

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

appearFromClass

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

appearActiveClass

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

appearToClass

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

leaveFromClass

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

leaveActiveClass

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

leaveToClass

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

mode

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

mode 参数与事件数据

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

契约分支 3

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

appear

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

appear 参数与事件数据

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

契约分支 3

枚举:false / true

persisted

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

persisted 参数与事件数据

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

契约分支 3

枚举:false / true

onBeforeEnter

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

onBeforeEnter 参数与事件数据

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

契约分支 3

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

onEnter

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

onEnter 参数与事件数据

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

契约分支 3

事件参数:(el: Element, done: () => void): void

onAfterEnter

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

onAfterEnter 参数与事件数据

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

契约分支 3

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

onEnterCancelled

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

onEnterCancelled 参数与事件数据

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

契约分支 3

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

onBeforeLeave

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

onBeforeLeave 参数与事件数据

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

契约分支 3

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

onLeave

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

onLeave 参数与事件数据

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

契约分支 3

事件参数:(el: Element, done: () => void): void

onAfterLeave

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

onAfterLeave 参数与事件数据

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

契约分支 3

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

onLeaveCancelled

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

onLeaveCancelled 参数与事件数据

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

契约分支 3

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

onBeforeAppear

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

onBeforeAppear 参数与事件数据

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

契约分支 3

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

onAppear

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

onAppear 参数与事件数据

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

契约分支 3

事件参数:(el: Element, done: () => void): void

onAfterAppear

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

onAfterAppear 参数与事件数据

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

契约分支 3

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

onAppearCancelled

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

onAppearCancelled 参数与事件数据

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

契约分支 3

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

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

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

// AsamDialogTransition
type PublicContract = AsamDialogTransition;

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭