鸿蒙5.0开发进阶:API ArkUI框架-ArkTS组件(Popup控制)

往期鸿蒙全套实战文章必看:(文中附带全栈鸿蒙学习资料)


Popup控制

给组件绑定popup弹窗,并设置弹窗内容,交互逻辑和显示状态。

说明

  • 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

  • popup弹窗的显示状态在onStateChange事件回调中反馈,其显隐与组件的创建或销毁无强对应关系。

bindPopup

bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions)

给组件绑定Popup弹窗。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
show boolean 弹窗显示状态,默认值为false,隐藏弹窗。popup弹窗必须等待页面全部构建完成才能展示,因此show不能在页面构建中设置为true,否则会导致popup弹窗显示位置及形状错误。
popup PopupOptions | CustomPopupOptions8+ 配置弹出弹窗的参数。

PopupOptions类型说明

名称 类型 必填 描述
message string

弹窗信息内容。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

placementOnTop(deprecated) boolean

是否在组件上方显示,默认值为false。

说明:

从 API version 10 开始废弃,建议使用placement替代。

primaryButton

{

value: string,

action: () => void

}

第一个按钮。

value: 弹窗里主按钮的文本。

action: 点击主按钮的回调函数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

secondaryButton

{

value: string,

action: () => void

}

第二个按钮。

value: 弹窗里辅助按钮的文本。

action: 点击辅助按钮的回调函数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

onStateChange (event: { isVisible: boolean }) => void

弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

arrowOffset9+ Length

popup箭头在弹窗处的偏移。箭头在气泡上下方时,数值为0表示箭头居最左侧,偏移量为箭头至最左侧的距离,默认居中。箭头在气泡左右侧时,偏移量为箭头至最上侧的距离,默认居中。如果显示在屏幕边缘,气泡会自动左右偏移,数值为0时箭头始终指向绑定组件。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

showInSubWindow9+ boolean

是否在子窗口显示气泡,默认值为false。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

mask10+ boolean | { color : ResourceColor }

设置气泡是否有遮罩层及遮罩颜色。如果设置为false,则没有遮罩层;如果设置为true,则设置有遮罩层并且颜色为透明色;如果设置为Color,则为遮罩层的颜色。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

messageOptions10+ PopupMessageOptions

设置弹窗信息文本参数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

targetSpace10+ Length

设置popup与目标的间隙。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

placement10+ Placement

设置popup组件相对于目标的显示位置,默认值为Placement.Bottom。

如果同时设置了placementOnTop和placement,则以placement的设置生效。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

offset10+ Position

设置popup组件相对于placement设置的显示位置的偏移。

说明:

不支持设置百分比。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

enableArrow10+ boolean

设置是否显示箭头。

默认值:true

说明:

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值