往期鸿蒙5.0全套实战文章必看:(文中附带全栈鸿蒙5.0学习资料)
自定义弹窗 (CustomDialog)
通过CustomDialogController类显示自定义弹窗。使用弹窗组件时,可优先考虑自定义弹窗,便于自定义弹窗的样式与内容。
说明
从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
接口
constructor(value: CustomDialogControllerOptions)
配置自定义弹窗的参数。
说明
自定义弹窗的所有参数,不支持动态刷新。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | CustomDialogControllerOptions | 是 | 配置自定义弹窗的参数。 |
CustomDialogControllerOptions对象说明
系统能力: SystemCapability.ArkUI.ArkUI.Full
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
builder | CustomDialog | 是 | 自定义弹窗内容构造器。 说明: 若builder构造器使用回调函数作为入参,请注意使用this绑定问题,如build: custombuilder({ callback: ()=> {...}})。 若在builder构造器中监听数据变化请使用@Link,其他方式如@Prop、@ObjectLink不适用此场景。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
cancel | () => void | 否 | 返回、ESC键和点击遮障层弹窗退出时的回调。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
autoCancel | boolean | 否 | 是否允许点击遮障层退出,true表示关闭弹窗。false表示不关闭弹窗。 默认值:true 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
alignment | DialogAlignment | 否 | 弹窗在竖直方向上的对齐方式。 默认值:DialogAlignment.Default 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
offset | Offset | 否 | 弹窗相对alignment所在位置的偏移量。 默认值:{ dx: 0, dy: 0 } 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
customStyle | boolean | 否 | 弹窗容器样式是否自定义。 设置false时(默认值): 1、圆角为32vp。 2、未设置弹窗宽度高度:弹窗容器的宽度根据栅格系统自适应。高度自适应自定义的内容节点。 3、设置弹窗宽度高度:弹窗容器的宽度不超过默认样式下的最大宽度(自定义节点设置100%的宽度),弹窗容器的高度不超过默认样式下的最大高度(自定义节点设置100%的高度)。 设置为true: 1、圆角为0,弹窗背景色为透明色。 2、不支持设置弹窗宽度、高度、边框宽度、边框样式、边框颜色以及阴影宽度。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
gridCount8+ | number | 否 | 弹窗宽度占栅格宽度的个数。 默认为按照窗口大小自适应,异常值按默认值处理,最大栅格数为系统最大栅格数。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
maskColor10+ |