harmony 鸿蒙@ohos.promptAction (弹窗)

2025-06-12
浏览 (5)

@ohos.promptAction (弹窗)

创建并显示文本提示框、对话框和操作菜单。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

该模块不支持在UIAbility的文件声明处使用，即不能在UIAbility的生命周期中调用，需要在创建组件实例后使用。

本模块功能依赖UI的执行上下文，不可在UI上下文不明确的地方使用，参见UIContext说明。建议在除ServiceExtension等无UI界面的场景外，均使用UIContext中的弹窗方法。

导入模块

import { promptAction } from '@kit.ArkUI';

promptAction.openToast¹⁸⁺

openToast(options: ShowToastOptions): Promise<number>

显示文本提示框并返回其id。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

参数

参数名	类型	必填	说明
options	ShowToastOptions	是	文本弹窗选项。

返回值

类型	说明
Promise<number>	返回供closeToast使用的文本提示框id。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

说明：

直接使用openToast可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction方法获取到PromptAction对象，再通过该对象调用openToast实现。

import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct toastExample {
  @State toastId: number = 0;

  build() {
    Column() {
      Button('Open Toast')
        .height(100)
        .type(ButtonType.Capsule)
        .onClick(() => {
          promptAction.openToast({
            message: 'Toast Massage',
            duration: 10000,
          }).then((toastId: number) => {
            this.toastId = toastId;
          })
            .catch((error: BusinessError) => {
              console.error(`openToast error code is ${error.code}, message is ${error.message}`)
            })
        })
      Blank().height(50);
      Button('Close Toast')
        .height(100)
        .type(ButtonType.Capsule)
        .onClick(() => {
          try {
            promptAction.closeToast(this.toastId);
          } catch (error) {
            let message = (error as BusinessError).message;
            let code = (error as BusinessError).code;
            console.error(`CloseToast error code is ${code}, message is ${message}`);
          };
        })
    }.height('100%').width('100%').justifyContent(FlexAlign.Center)
  }
}

toast-openclose

promptAction.closeToast¹⁸⁺

closeToast(toastId: number): void

关闭文本提示框。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

参数

参数名	类型	必填	说明
toastId	number	是	openToast返回的文本提示框id。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.
103401	Cannot find the toast.

示例：

说明：

直接使用closeToast可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction方法获取到PromptAction对象，再通过该对象调用openToast实现。

示例请看promptAction.openToaset18的示例。

ShowToastOptions

文本提示框的选项。

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

名称	类型	必填	说明
message	string \| Resource	是	显示的文本信息。说明：默认字体为’Harmony Sans’，不支持设置其他字体。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
duration	number	否	默认值1500ms，取值区间：1500ms-10000ms。若小于1500ms则取默认值，若大于10000ms则取上限值10000ms。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
bottom	string \| number	否	设置弹窗底部边框距离导航条的高度，ToastShowMode.TOP_MOST模式下，软键盘拉起时，如果bottom值过小，toast要被软键盘遮挡时，会自动避让至距离软键盘80vp处。ToastShowMode.DEFAULT模式下，软键盘拉起时，会上移软键盘的高度。默认值：80vp 说明：当底部没有导航条时，bottom为设置弹窗底部边框距离窗口底部的高度。设置对齐方式alignment后，bottom不生效。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
showMode¹¹⁺	ToastShowMode	否	设置弹窗是否显示在应用之上。默认值：ToastShowMode.DEFAULT，默认显示在应用内。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
alignment¹²⁺	Alignment	否	对齐方式。说明：不同alignment下，Toast位置对齐效果，如下图所示。 Toast的文本显示默认自左向右，不支持其他对齐方式。默认值：undefined，默认底部偏上位置。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
offset¹²⁺	Offset	否	在对齐方式上的偏移。默认值：{ dx: 0, dy: 0 }，默认没有偏移。说明：只支持设置px类型的数值，如需设置vp，可以将vp改成px传入。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
backgroundColor¹²⁺	ResourceColor	否	文本提示框背板颜色。默认值：Color.Transparent 说明： backgroundColor会与模糊属性backgroundBlurStyle叠加产生效果，如果不符合预期，可将backgroundBlurStyle设置为BlurStyle.NONE，即可取消模糊。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
textColor¹²⁺	ResourceColor	否	文本提示框文本颜色。默认值：Color.Black 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
backgroundBlurStyle¹²⁺	BlurStyle	否	文本提示框背板模糊材质。默认值：BlurStyle.COMPONENT_ULTRA_THICK 说明：设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时，则不要设置backgroundColor，否则颜色显示将不符合预期效果。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
shadow¹²⁺	ShadowOptions \| ShadowStyle	否	文本提示框背板阴影。默认值：ShadowStyle.OUTER_DEFAULT_MD 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
enableHoverMode¹⁴⁺	boolean	否	是否响应悬停态，值为true时，响应悬停态。默认值：false，默认不响应。原子化服务API：从API version 14开始，该接口支持在原子化服务中使用。
hoverModeArea¹⁴⁺	HoverModeAreaType	否	响应悬停态时，弹窗的显示区域。默认值：HoverModeAreaType.BOTTOM_SCREEN，默认显示在下半屏。原子化服务API：从API version 14开始，该接口支持在原子化服务中使用。

ToastShowMode¹¹⁺

设置弹窗显示模式，默认显示在应用内，支持显示在应用之上。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

名称	值	说明
DEFAULT	0	Toast 显示在应用内。
TOP_MOST	1	Toast 显示在应用之上。

ShowDialogOptions

对话框的选项。

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

名称	类型	必填	说明
title	string \| Resource	否	标题文本。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
message	string \| Resource	否	内容文本。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
buttons	Array<Button>	否	对话框中按钮的数组，结构为：{text:‘button’, color: ‘#666666’}，支持大于1个按钮。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
alignment¹⁰⁺	DialogAlignment	否	弹窗在竖直方向上的对齐方式。默认值：DialogAlignment.Default 说明：若在UIExtension中设置showInSubWindow为true, 弹窗将基于UIExtension的宿主窗口对齐。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
offset¹⁰⁺	Offset	否	弹窗相对alignment所在位置的偏移量。默认值：{ dx: 0 , dy: 0 } 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
maskRect¹⁰⁺	Rectangle	否	弹窗遮蔽层区域，在遮蔽层区域内的事件不透传，在遮蔽层区域外的事件透传。默认值：{ x: 0, y: 0, width: ‘100%’, height: ‘100%’ } 说明： showInSubWindow为true时，maskRect不生效。 maskRect在设置部分属性值后，其余属性值默认为0。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
showInSubWindow¹¹⁺	boolean	否	某弹框需要显示在主窗口之外时，是否在子窗口显示此弹窗。值为true表示在子窗口显示弹窗。默认值：false，弹窗显示在应用内，而非独立子窗口。说明：showInSubWindow为true的弹窗无法触发显示另一个showInSubWindow为true的弹窗。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
isModal¹¹⁺	boolean	否	弹窗是否为模态窗口。值为true表示为模态窗口且有蒙层，不可与弹窗周围其他控件进行交互，即蒙层区域无法事件透传。值为false表示为非模态窗口且无蒙层，可以与弹窗周围其他控件进行交互。默认值：true 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
backgroundColor¹²⁺	ResourceColor	否	弹窗背板颜色。默认值：Color.Transparent 说明： backgroundColor会与模糊属性backgroundBlurStyle叠加产生效果，如果不符合预期，可将backgroundBlurStyle设置为BlurStyle.NONE，即可取消模糊。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
backgroundBlurStyle¹²⁺	BlurStyle	否	弹窗背板模糊材质。默认值：BlurStyle.COMPONENT_ULTRA_THICK 说明：设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时，则不要设置backgroundColor，否则颜色显示将不符合预期效果。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
backgroundBlurStyleOptions¹⁹⁺	BackgroundBlurStyleOptions	否	背景模糊效果。默认值请参考BackgroundBlurStyleOptions类型说明。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
backgroundEffect¹⁹⁺	BackgroundEffectOptions	否	背景效果参数。默认值请参考BackgroundEffectOptions类型说明。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
shadow¹²⁺	ShadowOptions \| ShadowStyle	否	设置弹窗背板的阴影。当设备为2in1时，默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD，失焦为ShadowStyle.OUTER_FLOATING_SM。其他设备默认无阴影。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
enableHoverMode¹⁴⁺	boolean	否	是否响应悬停态，值为true时，响应悬停态。默认值：false，默认不响应。原子化服务API：从API version 14开始，该接口支持在原子化服务中使用。
hoverModeArea¹⁴⁺	HoverModeAreaType	否	设置悬停态下弹窗的默认展示区域。默认值：HoverModeAreaType.BOTTOM_SCREEN 原子化服务API：从API version 14开始，该接口支持在原子化服务中使用。
onWillAppear¹⁹⁺	Callback<void>	否	弹窗显示动效前的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。 2.在onWillAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
onDidAppear¹⁹⁺	Callback<void>	否	弹窗弹出时的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。 2.在onDidAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。 3.快速点击弹出，关闭弹窗时，onWillDisappear在onDidAppear前生效。 4.弹窗入场动效未完成时彻底关闭弹窗，动效打断，onDidAppear不会触发。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
onWillDisappear¹⁹⁺	Callback<void>	否	弹窗退出动效前的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
onDidDisappear¹⁹⁺	Callback<void>	否	弹窗消失时的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
levelMode¹⁵⁺	LevelMode	否	设置弹窗显示层级。说明： - 默认值：LevelMode.OVERLAY - 当且仅当showInSubWindow属性设置为false时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
levelUniqueId¹⁵⁺	number	否	设置页面级弹窗需要显示的层级下的节点 uniqueId。取值范围：大于等于0的数字。说明： - 当且仅当levelMode属性设置为LevelMode.EMBEDDED时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
immersiveMode¹⁵⁺	ImmersiveMode	否	设置页面内弹窗蒙层效果。说明： - 默认值：ImmersiveMode.DEFAULT - 当且仅当levelMode属性设置为LevelMode.EMBEDDED时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
levelOrder¹⁸⁺	LevelOrder	否	设置弹窗显示的顺序。说明： - 默认值：LevelOrder.clamp(0) - 不支持动态刷新顺序。原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。
onWillAppear²⁰⁺	Callback<void>	否	弹窗显示动效前的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。 2.在onWillAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。
onDidAppear²⁰⁺	Callback<void>	否	弹窗弹出时的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。 2.在onDidAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。 3.快速点击弹出，关闭弹窗时，onWillDisappear在onDidAppear前生效。 4.弹窗入场动效未完成时彻底关闭弹窗，动效打断，onDidAppear不会触发。原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。
onWillDisappear²⁰⁺	Callback<void>	否	弹窗退出动效前的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。
onDidDisappear²⁰⁺	Callback<void>	否	弹窗消失时的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>onWillDisappear>>onDidDisappear。原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。

ShowDialogSuccessResponse

对话框的响应结果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

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

名称	类型	必填	说明
index	number	是	选中按钮在buttons数组中的索引。

ActionMenuOptions

操作菜单的选项。

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

名称	类型	必填	说明
title	string \| Resource	否	标题文本。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
buttons	[Button,Button?,Button?,Button?,Button?,Button?]	是	菜单中菜单项按钮的数组，结构为：{text:‘button’, color: ‘#666666’}，支持1-6个按钮。按钮数量大于6个时，仅显示前6个按钮，之后的按钮不显示。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
showInSubWindow¹¹⁺	boolean	否	某弹框需要显示在主窗口之外时，是否在子窗口显示此弹窗。值为true表示在子窗口显示弹窗。默认值：false，在子窗口不显示弹窗。说明： - showInSubWindow为true的弹窗无法触发显示另一个showInSubWindow为true的弹窗。 - 若在UIExtension中设置showInSubWindow为true, 弹窗将基于UIExtension的宿主窗口对齐。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
isModal¹¹⁺	boolean	否	弹窗是否为模态窗口。值为true表示为模态窗口且有蒙层，不可与弹窗周围其他控件进行交互，即蒙层区域无法事件透传。值为false表示为非模态窗口且无蒙层，可以与弹窗周围其他控件进行交互。默认值：true 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
levelMode¹⁵⁺	LevelMode	否	设置弹窗显示层级。说明： - 默认值：LevelMode.OVERLAY - 当且仅当showInSubWindow属性设置为false时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
levelUniqueId¹⁵⁺	number	否	设置页面级弹窗需要显示的层级下的节点 uniqueId。取值范围：大于等于0的数字。说明： - 当且仅当levelMode属性设置为LevelMode.EMBEDDED时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
immersiveMode¹⁵⁺	ImmersiveMode	否	设置页面内弹窗蒙层效果。说明： - 默认值：ImmersiveMode.DEFAULT - 当且仅当levelMode属性设置为LevelMode.EMBEDDED时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

ActionMenuSuccessResponse

操作菜单的响应结果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

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

名称	类型	必填	说明
index	number	是	选中按钮在buttons数组中的索引，从0开始。

CommonState²⁰⁺枚举说明

自定义弹窗的状态。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

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

名称	值	说明
UNINITIALIZED	0	未初始化，控制器未与dialog绑定时。
INITIALIZED	1	已初始化，控制器与dialog绑定后。
APPEARING	2	显示中，dialog显示动画过程中。
APPEARED	3	已显示，dialog显示动画结束。
DISAPPEARING	4	消失中，dialog消失动画过程中。
DISAPPEARED	5	已消失，dialog消失动画结束后。

DialogController¹⁸⁺

自定义弹窗控制器，继承自CommonController。

DialogController可作为UIContext弹出自定义弹窗的成员变量，具体用法可看openCustomDialogWithController和presentCustomDialog示例。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

CommonController¹⁸⁺

公共控制器，可以控制promptAction相关组件。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

constructor

constructor()

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

close

close(): void

关闭显示的自定义弹窗，若已关闭，则不生效。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

getState²⁰⁺

getState(): CommonState

获取自定义弹窗的状态。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
CommonState	返回对应的弹窗状态。

LevelOrder¹⁸⁺

弹窗层级，可以控制弹窗显示的顺序。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

clamp¹⁸⁺

static clamp(order: number): LevelOrder

创建指定顺序的弹窗层级。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
order	number	是	弹窗显示顺序。取值范围为[-100000.0, 100000.0]，如果值小于-100000.0则设置为-100000.0，如果值大于100000.0则设置为100000.0。

返回值：

类型	说明
LevelOrder	返回当前对象实例。

getOrder¹⁸⁺

getOrder(): number

获取弹窗显示顺序。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
number	返回显示顺序数值。

DialogOptions¹⁸⁺

自定义弹窗的内容，继承自BaseDialogOptions。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

名称	类型	必填	说明
backgroundColor	ResourceColor	否	设置弹窗背板颜色。默认值：Color.Transparent 说明： backgroundColor会与模糊属性backgroundBlurStyle叠加产生效果，如果不符合预期，可将backgroundBlurStyle设置为BlurStyle.NONE，即可取消模糊。
cornerRadius	DialogOptionsCornerRadius	否	设置弹窗背板的圆角半径。可分别设置4个圆角的半径。默认值：{ topLeft: ‘32vp’, topRight: ‘32vp’, bottomLeft: ‘32vp’, bottomRight: ‘32vp’ } 圆角大小受组件尺寸限制，最大值为组件宽或高的一半，若值为负，则按照默认值处理。百分比参数方式：以父元素弹窗宽和高的百分比来设置弹窗的圆角。
borderWidth	DialogOptionsBorderWidth	否	设置弹窗背板的边框宽度。可分别设置4个边框宽度。默认值：0 单位：vp 百分比参数方式：以父元素弹窗宽的百分比来设置弹窗的边框宽度。当弹窗左边框和右边框大于弹窗宽度，弹窗上边框和下边框大于弹窗高度，显示可能不符合预期。
borderColor	DialogOptionsBorderColor	否	设置弹窗背板的边框颜色。默认值：Color.Black 如果使用borderColor属性，需要和borderWidth属性一起使用。
borderStyle	DialogOptionsBorderStyle	否	设置弹窗背板的边框样式。默认值：BorderStyle.Solid。如果使用borderStyle属性，需要和borderWidth属性一起使用。
width	Dimension	否	设置弹窗背板的宽度。说明： - 默认最大值：400vp - 百分比参数方式：弹窗参考宽度基于所在窗口宽度调整。
height	Dimension	否	设置弹窗背板的高度。说明： - 默认最大值：0.9 *（窗口高度 - 安全区域）。 - 百分比参数方式：弹窗参考高度为（窗口高度 - 安全区域），在此基础上调小或调大。
shadow	DialogOptionsShadow	否	设置弹窗背板的阴影。当设备为2in1时，默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD，失焦为ShadowStyle.OUTER_FLOATING_SM。其他设备默认无阴影。
backgroundBlurStyle	BlurStyle	否	弹窗背板模糊材质。默认值：BlurStyle.COMPONENT_ULTRA_THICK 说明：设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时，则不要设置backgroundColor，否则颜色显示将不符合预期效果。

DialogOptionsCornerRadius¹⁸⁺

type DialogOptionsCornerRadius = Dimension | BorderRadiuses

表示弹窗背板的圆角半径允许的数据字段类型。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

类型	说明
Dimension	表示值类型为长度类型，用于描述尺寸单位。
BorderRadiuses	表示值类型为圆角类型，用于描述组件边框圆角半径。

DialogOptionsBorderWidth¹⁸⁺

type DialogOptionsBorderWidth = Dimension | EdgeWidths

表示弹窗背板的边框宽度允许的数据字段类型。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

类型	说明
Dimension	表示值类型为长度类型，用于描述尺寸单位。
EdgeWidths	表示值类型为边框宽度类型，用于描述组件边框不同方向的宽度。

DialogOptionsBorderColor¹⁸⁺

type DialogOptionsBorderColor = ResourceColor | EdgeColors

表示弹窗背板的边框颜色允许的数据字段类型。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

类型	说明
ResourceColor	表示值类型为颜色类型，用于描述资源颜色类型。
EdgeColors	表示值类型为边框颜色，用于描述组件边框四条边的颜色。

DialogOptionsBorderStyle¹⁸⁺

type DialogOptionsBorderStyle = BorderStyle | EdgeStyles

表示弹窗背板的边框样式允许的数据字段类型。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

类型	说明
BorderStyle	表示值类型为边框类型，用于描述组件边框的类型。
EdgeStyles	表示值类型为边框样式，用于描述组件边框四条边的样式。

DialogOptionsShadow¹⁸⁺

type DialogOptionsShadow = ShadowOptions | ShadowStyle

表示弹窗背板的阴影允许的数据字段类型。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

类型	说明
ShadowOptions	表示值类型为阴影属性集合，用于设置阴影的模糊半径、阴影的颜色、X轴和Y轴的偏移量。
ShadowStyle	表示值类型为阴影类型，用于描述阴影的类型。

CustomDialogOptions¹¹⁺

自定义弹窗的内容，继承自BaseDialogOptions。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

名称	类型	必填	说明
builder	CustomBuilder	是	设置自定义弹窗的内容。说明： builder需要赋值为箭头函数，格式如下：() => { this.XXX() }，其中XXX是内部builder名。全局builder需要在组件内部创建，并在内部builder中调用。 builder根节点宽高百分比相对弹框容器大小。 builder非根节点宽高百分比相对父节点大小。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
backgroundColor ¹²⁺	ResourceColor	否	设置弹窗背板颜色。默认值：Color.Transparent 说明：当设置了backgroundColor为非透明色时，backgroundBlurStyle需要设置为BlurStyle.NONE，否则颜色显示将不符合预期效果。
cornerRadius¹²⁺	Dimension \| BorderRadiuses	否	设置背板的圆角半径。可分别设置4个圆角的半径。默认值：{ topLeft: ‘32vp’, topRight: ‘32vp’, bottomLeft: ‘32vp’, bottomRight: ‘32vp’ } 圆角大小受组件尺寸限制，最大值为组件宽或高的一半，若值为负，则按照默认值处理。百分比参数方式：以父元素弹窗宽和高的百分比来设置弹窗的圆角。
borderWidth¹²⁺	Dimension \| EdgeWidths	否	设置弹窗背板的边框宽度。可分别设置4个边框宽度。默认值：0 单位：vp 百分比参数方式：以父元素弹窗宽的百分比来设置弹窗的边框宽度。当弹窗左边框和右边框大于弹窗宽度，弹窗上边框和下边框大于弹窗高度，显示可能不符合预期。
borderColor¹²⁺	ResourceColor \| EdgeColors	否	设置弹窗背板的边框颜色。默认值：Color.Black 如果使用borderColor属性，需要和borderWidth属性一起使用。
borderStyle¹²⁺	BorderStyle \| EdgeStyles	否	设置弹窗背板的边框样式。默认值：BorderStyle.Solid 如果使用borderStyle属性，需要和borderWidth属性一起使用。
width¹²⁺	Dimension	否	设置弹窗背板的宽度。说明： - 弹窗宽度默认最大值：400vp - 百分比参数方式：弹窗参考宽度基于所在窗口的宽度的基础上调整。
height¹²⁺	Dimension	否	设置弹窗背板的高度。说明： - 弹窗高度默认最大值：0.9 *（窗口高度 - 安全区域）。 - 百分比参数方式：弹窗参考高度为（窗口高度 - 安全区域），在此基础上调小或调大。
shadow¹²⁺	ShadowOptions \| ShadowStyle	否	设置弹窗背板的阴影。当设备为2in1时，默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD，失焦为ShadowStyle.OUTER_FLOATING_SM。其他设备默认无阴影。
backgroundBlurStyle¹²⁺	BlurStyle	否	弹窗背板模糊材质。默认值：BlurStyle.COMPONENT_ULTRA_THICK 说明：设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时，则不要设置backgroundColor，否则颜色显示将不符合预期效果。

BaseDialogOptions¹¹⁺

弹窗的选项。

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

名称	类型	必填	说明
maskRect	Rectangle	否	弹窗遮蔽层区域。默认值：{ x: 0, y: 0, width: ‘100%’, height: ‘100%’ } 说明： showInSubWindow为true时，maskRect不生效。 maskRect在设置部分属性值后，其余属性值默认为0。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
alignment	DialogAlignment	否	弹窗在竖直方向上的对齐方式。默认值：DialogAlignment.Default 说明：若在UIExtension中设置showInSubWindow为true, 弹窗将基于UIExtension的宿主窗口对齐。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
offset	Offset	否	弹窗相对alignment所在位置的偏移量。默认值：{ dx: 0 , dy: 0 } 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
isModal	boolean	否	弹窗是否为模态窗口。值为true表示为模态窗口且有蒙层，不可与弹窗周围其他控件进行交互，即蒙层区域无法事件透传。值为false表示为非模态窗口且无蒙层，可以与弹窗周围其他控件进行交互。默认值：true 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
showInSubWindow	boolean	否	某弹框需要显示在主窗口之外时，是否在子窗口显示此弹窗。值为true表示在子窗口显示弹窗。默认值：false，弹窗显示在应用内，而非独立子窗口。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
onWillDismiss¹²⁺	Callback<DismissDialogAction>	否	交互式关闭回调函数。说明： 1.当用户执行点击遮障层关闭、侧滑（左滑/右滑）、三键back、键盘ESC关闭交互操作时，如果注册该回调函数，则不会立刻关闭弹窗。在回调函数中可以通过reason得到阻拦关闭弹窗的操作类型，从而根据原因选择是否能关闭弹窗。当前组件返回的reason中，暂不支持CLOSE_BUTTON的枚举值。 2.在onWillDismiss回调中，不能再做onWillDismiss拦截。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
autoCancel¹²⁺	boolean	否	点击遮障层时，是否关闭弹窗，true表示关闭弹窗。false表示不关闭弹窗。默认值：true 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
maskColor¹²⁺	ResourceColor	否	自定义蒙层颜色。默认值: 0x33000000 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
transition¹²⁺	TransitionEffect	否	设置弹窗显示和退出的过渡效果。说明： 1.如果不设置，则使用默认的显示/退出动效。 2.显示动效中按back键，打断显示动效，执行退出动效，动画效果为显示动效与退出动效的曲线叠加后的效果。 3.退出动效中按back键，不会打断退出动效，退出动效继续执行，继续按back键退出应用。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
dialogTransition¹⁹⁺	TransitionEffect	否	设置弹窗内容显示的过渡效果。默认无动效。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
maskTransition¹⁹⁺	TransitionEffect	否	设置蒙层显示的过渡效果。默认无动效。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
onDidAppear¹²⁺	() => void	否	弹窗弹出时的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。 2.在onDidAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。 3.快速点击弹出，消失弹窗时，存在onWillDisappear在onDidAppear前生效。 4. 当弹窗入场动效未完成时关闭弹窗，该回调不会触发。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
onDidDisappear¹²⁺	() => void	否	弹窗消失时的事件回调。说明：正常时序依次为：onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。当弹窗退场动画未完成时（例如：同时触发弹窗关闭和页面切换），该回调不会触发。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
onWillAppear¹²⁺	() => void	否	弹窗显示动效前的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。 2.在onWillAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
onWillDisappear¹²⁺	() => void	否	弹窗退出动效前的事件回调。说明： 1.正常时序依次为：onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。 2.快速点击弹出，消失弹窗时，存在onWillDisappear在onDidAppear前生效。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
keyboardAvoidMode¹²⁺	KeyboardAvoidMode	否	用于设置弹窗是否在拉起软键盘时进行自动避让。默认值：KeyboardAvoidMode.DEFAULT 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
enableHoverMode¹⁴⁺	boolean	否	是否响应悬停态，值为true时，响应悬停态。默认值：false，默认不响应。原子化服务API：从API version 14开始，该接口支持在原子化服务中使用。
hoverModeArea¹⁴⁺	HoverModeAreaType	否	悬停态下弹窗默认展示区域。默认值：HoverModeAreaType.BOTTOM_SCREEN 原子化服务API：从API version 14开始，该接口支持在原子化服务中使用。
backgroundBlurStyleOptions¹⁹⁺	BackgroundBlurStyleOptions	否	背景模糊效果。默认值请参考BackgroundBlurStyleOptions类型说明。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
backgroundEffect¹⁹⁺	BackgroundEffectOptions	否	背景效果参数。默认值请参考BackgroundEffectOptions类型说明。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。
keyboardAvoidDistance¹⁵⁺	LengthMetrics	否	弹窗避让键盘后，和键盘之间距离。说明： - 默认值：16vp - 默认单位：vp - 当且仅当keyboardAvoidMode属性设置为DEFAULT时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
levelMode¹⁵⁺	LevelMode	否	设置弹窗显示层级。说明： - 默认值：LevelMode.OVERLAY - 当且仅当showInSubWindow属性设置为false时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
levelUniqueId¹⁵⁺	number	否	设置页面级弹窗需要显示的层级下的节点 uniqueId。取值范围：大于等于0的数字。说明： - 当且仅当levelMode属性设置为LevelMode.EMBEDDED时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
immersiveMode¹⁵⁺	ImmersiveMode	否	设置页面内弹窗蒙层效果。说明： - 默认值：ImmersiveMode.DEFAULT - 当且仅当levelMode属性设置为LevelMode.EMBEDDED时生效。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
levelOrder¹⁸⁺	LevelOrder	否	设置弹窗显示的顺序。说明： - 默认值：LevelOrder.clamp(0) - 不支持动态刷新顺序。原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。
focusable¹⁹⁺	boolean	否	设置弹窗是否获取焦点。值为true表示获取焦点，值为false表示不获取焦点。默认值：true 说明：只有弹出覆盖在当前窗口之上的弹窗才可以获取焦点。原子化服务API：从API version 19开始，该接口支持在原子化服务中使用。

DismissDialogAction¹²⁺

Dialog关闭的信息。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

属性

名称	类型	可读	可写	说明
dismiss	Callback<void>	否	否	Dialog关闭回调函数。开发者需要退出时调用，不需要退出时无需调用。
reason	DismissReason	否	否	Dialog无法关闭原因。根据开发者需求选择不同操作下，Dialog是否关闭。

DismissReason¹²⁺枚举说明

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

名称	值	描述
PRESS_BACK	0	点击三键back、侧滑（左滑/右滑）、键盘ESC。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
TOUCH_OUTSIDE	1	点击遮障层时。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
CLOSE_BUTTON	2	点击关闭按钮。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
SLIDE_DOWN	3	下拉关闭。说明：该接口仅支持在半模态转场中使用。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
SLIDE²⁰⁺	4	侧拉关闭。说明：该接口仅支持在半模态转场中使用。原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。

LevelMode¹⁵⁺枚举说明

弹窗显示层级模式。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

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

名称	值	说明
OVERLAY	0	弹窗层级为应用窗口根节点，应用内路由导航切换弹窗不隐藏。
EMBEDDED	1	弹窗节点为页面内路由/导航下的节点，随路由导航切换，弹窗随页面隐藏。

ImmersiveMode¹⁵⁺枚举说明

页面内弹窗蒙层显示区域模式。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

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

名称	值	说明
DEFAULT	0	弹窗蒙层遵循父节点布局约束进行显示。
EXTEND	1	弹窗蒙层可扩展至覆盖状态栏和导航条。

Button

菜单中的菜单项按钮。

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

名称	类型	必填	说明
text	string \|  Resource	是	按钮文本内容。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
color	string \| Resource	是	按钮文本颜色。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
primary¹²⁺	boolean	否	在弹窗获焦且未进行tab键走焦时，按钮是否默认响应Enter键。多个Button时，只允许一个Button的该字段配置为true，否则所有Button均不响应。多重弹窗可自动获焦连续响应。值为true表示按钮默认响应Entry键，值为false时，按钮不默认响应Entry键。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

示例

该示例实现了在promptAction.DialogController中调用getState获取弹窗当前状态。

// xxx.ets
import { BusinessError } from '@kit.BasicServicesKit';
import { ComponentContent, promptAction } from '@kit.ArkUI';

@Component
struct CustomDialogExample {
  build() {
    Column() {
      Text('Hello')
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .margin({ bottom: 36 })
      Button('点我关闭弹窗')
        .onClick(() => {
          if (this.getDialogController()) {
            this.getDialogController().close();
          }
        })
      Button('点我获取状态')
        .onClick(() => {
          if (this.getDialogController()) {
            let state: promptAction.CommonState = this.getDialogController().getState();
            console.info('state:' + state); // 打印弹窗状态
          }
        })

    }.backgroundColor('#FFF0F0F0')
  }
}

@Builder
function buildText() {
   CustomDialogExample()
}

@Entry
@Component
struct Index {

  private dialogController: promptAction.DialogController = new promptAction.DialogController()

  build() {
    Row() {
      Column() {
        Button("click me")
          .onClick(() => {
            let uiContext = this.getUIContext();
            let promptAction = uiContext.getPromptAction();
            let contentNode = new ComponentContent(uiContext, wrapBuilder(buildText),
            );

            promptAction.openCustomDialogWithController(contentNode, this.dialogController, {

              transition: TransitionEffect.OPACITY.animation({
                duration: 3000
              })
            }).then(() => {
              console.info('succeeded')
            }).catch((error: BusinessError) => {
              console.error(`OpenCustomDialogWithController args error code is ${error.code}, message is ${error.message}`);
            })
          })
      }
      .width('100%')
      .height('100%')
    }
    .height('100%')
  }
}

promptAction.showToast^(deprecated)

showToast(options: ShowToastOptions): void

创建并显示文本提示框。

说明：

从API version 18开始废弃，且直接使用showToast可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法showToast。

从API version 10开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
options	ShowToastOptions	是	文本弹窗选项。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct toastExample {
  build() {
    Column() {
      Button('Show toast').fontSize(20)
        .onClick(() => {
          try {
            promptAction.showToast({
              message: 'Hello World',
              duration: 2000
            });
          } catch (error) {
            let message = (error as BusinessError).message;
            let code = (error as BusinessError).code;
            console.error(`showToast args error code is ${code}, message is ${message}`);
          };
        })
    }.height('100%').width('100%').justifyContent(FlexAlign.Center)
  }
}

API version 11及之前Toast样式。

zh-cn_image_0001

API version 12及之后Toast样式。

zh-cn_image_0001

promptAction.showDialog^(deprecated)

showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>

创建并显示对话框，对话框响应后异步返回结果。

说明：

从API version 18开始废弃，且直接使用showDialog可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法showDialog。

从API version 10开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
options	ShowDialogOptions	是	对话框选项。

返回值：

类型	说明
Promise<ShowDialogSuccessResponse>	对话框响应结果。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

import { promptAction } from '@kit.ArkUI';

promptAction.showDialog({
  title: 'Title Info',
  message: 'Message Info',
  buttons: [
    {
      text: 'button1',
      color: '#000000'
    },
    {
      text: 'button2',
      color: '#000000'
    }
  ],
})
  .then(data => {
    console.info('showDialog success, click button: ' + data.index);
  })
  .catch((err: Error) => {
    console.info('showDialog error: ' + err);
  })

zh-cn_image_0002

promptAction.showDialog^(deprecated)

showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSuccessResponse>):void

创建并显示对话框，对话框响应结果异步返回。

说明：

从API version 18开始废弃，且直接使用showDialog可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法showDialog。

从API version 10开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
options	ShowDialogOptions	是	页面显示对话框信息描述。
callback	AsyncCallback<ShowDialogSuccessResponse>	是	对话框响应结果回调。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  promptAction.showDialog({
    title: 'showDialog Title Info',
    message: 'Message Info',
    buttons: [
      {
        text: 'button1',
        color: '#000000'
      },
      {
        text: 'button2',
        color: '#000000'
      }
    ]
  }, (err, data) => {
    if (err) {
      console.info('showDialog err: ' + err);
      return;
    }
    console.info('showDialog success callback, click button: ' + data.index);
  });
} catch (error) {
  let message = (error as BusinessError).message;
  let code = (error as BusinessError).code;
  console.error(`showDialog args error code is ${code}, message is ${message}`);
};

zh-cn_image_0004

当弹窗的showInSubWindow属性为true时，弹窗可显示在窗口外。

import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  promptAction.showDialog({
    title: 'showDialog Title Info',
    message: 'Message Info',
    isModal: true,
    showInSubWindow: true,
    buttons: [
      {
        text: 'button1',
        color: '#000000'
      },
      {
        text: 'button2',
        color: '#000000'
      }
    ]
  }, (err, data) => {
    if (err) {
      console.info('showDialog err: ' + err);
      return;
    }
    console.info('showDialog success callback, click button: ' + data.index);
  });
} catch (error) {
  let message = (error as BusinessError).message;
  let code = (error as BusinessError).code;
  console.error(`showDialog args error code is ${code}, message is ${message}`);
};

zh-cn_image_0002_showinsubwindow

以下示例展示了弹窗生命周期的相关接口的使用方法。

// xxx.ets
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct DialogExample {
  @State log:string = 'Log information:';
  build() {
    Column() {
      Button('showdialog')
        .width(200)
        .height(60)
        .margin(20)
        .fontSize(16)
        .onClick(() => {
          this.showCustomDialog();
        })
      Text(this.log).fontSize(30).margin({ top: 200 })
    }.width('100%').margin({ top: 5 })
  }

  showCustomDialog() {
    try {
      this.getUIContext().getPromptAction().showDialog({
        title: '操作确认',
        message: '您确定要执行此操作吗？',
        alignment: DialogAlignment.Bottom,
        buttons: [
          {
            text: '取消',
            color: '#999999'
          },
          {
            text: '确定',
            color: '#007DFF'
          }
        ],
        onDidAppear: () => {
          this.log += '# onDidAppear'
          console.info("prompAction,is onDidAppear!")
        },
        onDidDisappear: () => {
          this.log += '# onDidDisappear'
          console.info("prompAction,is onDidDisappear!")
        },
        onWillAppear: () => {
          this.log = 'Log information:#onWillAppear'
          console.info("prompAction,is onWillAppear!")
        },
        onWillDisappear: () => {
          this.log += '# onWillDisappear'
          console.info("prompAction,is onWillDisappear!")
        },
      })
    } catch (error) {
      let err: BusinessError = error as BusinessError;
      console.error(`捕获到异常: ${err.code}, ${err.message}`);
    }
  }
}

zh-cn_image_0002_lifecycle

promptAction.showActionMenu^(deprecated)

showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenuSuccessResponse>):void

创建并显示操作菜单，菜单响应结果异步返回。

说明：

从API version 18开始废弃，且直接使用showActionMenu可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法showActionMenu。

从API version 11开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full。

参数：

参数名	类型	必填	说明
options	ActionMenuOptions	是	操作菜单选项。
callback	AsyncCallback<ActionMenuSuccessResponse>	是	菜单响应结果回调。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：1

import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  promptAction.showActionMenu({
    title: 'Title Info',
    buttons: [
      {
        text: 'item1',
        color: '#666666'
      },
      {
        text: 'item2',
        color: '#000000'
      },
    ]
  }, (err, data) => {
    if (err) {
      console.info('showActionMenu err: ' + err);
      return;
    }
    console.info('showActionMenu success callback, click button: ' + data.index);
  })
} catch (error) {
  let message = (error as BusinessError).message
  let code = (error as BusinessError).code
  console.error(`showActionMenu args error code is ${code}, message is ${message}`);
};

zh-cn_image_0005

示例：2

该示例为showActionMenu配置生命周期回调。

import { promptAction } from '@kit.ArkUI';

@Entry
@Component
struct Index {
  @State isShown: boolean = false
  @State textColor: Color = Color.Black
  @State blueColor: Color = Color.Blue

  @State onWillAppear: boolean = false
  @State onDidAppear: boolean = false
  @State onWillDisappear: boolean = false
  @State onDidDisappear: boolean = false
  build() {
    Column({ space: 50 }) {
      Text('onWillAppear').fontColor(this.onWillAppear ? this.blueColor : this.textColor)
      Text('onDidAppear').fontColor(this.onDidAppear ? this.blueColor : this.textColor)
      Text('onWillDisappear').fontColor(this.onWillDisappear ? this.blueColor : this.textColor)
      Text('onDidDisappear').fontColor(this.onDidDisappear ? this.blueColor : this.textColor)
      Button('click')
        .width(200)
        .height(100)
        .margin(100)
        .fontColor(this.textColor)
        .onClick(() => {
          promptAction.showActionMenu({
            title: 'showActionMenu Title Info',
            buttons: [
              {
                text: 'item1',
                color: '#666666'
              },
              {
                text: 'item2',
                color: '#000000'
              },
            ],
            onWillAppear:() => {
              console.info("promptAction menu cycle life onWillAppear");
                  this.onWillAppear = true;
            },
            onDidAppear:() => {
              console.info("promptAction menu cycle life onDidAppear");
                  this.onDidAppear = true;
            },
            onWillDisappear:() => {
              this.isShown = false;
              console.info("promptAction menu cycle life onWillDisappear");
                  this.onWillDisappear = true;
            },
            onDidDisappear:() => {
              console.info("promptAction menu cycle life onDidDisappear");
                  this.onDidDisappear = true;
            }
          })
            .then(data => {
              console.info('showActionMenu success, click button: ' + data.index);
            })
            .catch((err: Error) => {
              console.info('showActionMenu error: ' + err);
            })
        })
    }
    .width('100%')
  }
}

zh-cn_image_0008

promptAction.showActionMenu^(deprecated)

showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse>

创建并显示操作菜单，菜单响应后异步返回结果。

说明：

从API version 18开始废弃，且直接使用showActionMenu可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法showActionMenu。

从API version 10开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
options	ActionMenuOptions	是	操作菜单选项。

返回值：

类型	说明
Promise<ActionMenuSuccessResponse>	菜单响应结果。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

import { promptAction } from '@kit.ArkUI';

promptAction.showActionMenu({
  title: 'showActionMenu Title Info',
  buttons: [
    {
      text: 'item1',
      color: '#666666'
    },
    {
      text: 'item2',
      color: '#000000'
    },
  ]
})
  .then(data => {
    console.info('showActionMenu success, click button: ' + data.index);
  })
  .catch((err: Error) => {
    console.info('showActionMenu error: ' + err);
  })

zh-cn_image_0006

promptAction.openCustomDialog^(deprecated)

openCustomDialog(options: CustomDialogOptions): Promise<number>

打开自定义弹窗。

不支持在ServiceExtension中使用。

暂不支持isModal = true与showInSubWindow = true同时使用。

弹窗宽度在设备竖屏时默认为所在窗口宽度 - 左右margin（16vp，设备为2in1时为40vp），最大默认宽度为400vp。

说明：

从API version 11开始支持，从API version 18开始废弃，且直接使用openCustomDialog可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法openCustomDialog。

从API version 12开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
options	CustomDialogOptions	是	自定义弹窗的内容。

返回值：

类型	说明
Promise<number>	返回供closeCustomDialog使用的对话框id。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  private customDialogComponentId: number = 0;

  @Builder
  customDialogComponent() {
    Column() {
      Text('弹窗').fontSize(30)
      Row({ space: 50 }) {
        Button("确认").onClick(() => {
          try {
            promptAction.closeCustomDialog(this.customDialogComponentId)
          } catch (error) {
            let message = (error as BusinessError).message;
            let code = (error as BusinessError).code;
            console.error(`closeCustomDialog error code is ${code}, message is ${message}`);
          }
        })
        Button("取消").onClick(() => {
          try {
            promptAction.closeCustomDialog(this.customDialogComponentId)
          } catch (error) {
            let message = (error as BusinessError).message;
            let code = (error as BusinessError).code;
            console.error(`closeCustomDialog error code is ${code}, message is ${message}`);
          }
        })
      }
    }.height(200).padding(5).justifyContent(FlexAlign.SpaceBetween)
  }

  build() {
    Row() {
      Column({ space: 20 }) {
        Text('组件内弹窗')
          .fontSize(30)
          .onClick(() => {
            promptAction.openCustomDialog({
              builder: () => {
                this.customDialogComponent()
              },
              onWillDismiss: (dismissDialogAction: DismissDialogAction) => {
                console.info("reason" + JSON.stringify(dismissDialogAction.reason));
                console.log("dialog onWillDismiss");
                if (dismissDialogAction.reason == DismissReason.PRESS_BACK) {
                  dismissDialogAction.dismiss();
                }
                if (dismissDialogAction.reason == DismissReason.TOUCH_OUTSIDE) {
                  dismissDialogAction.dismiss();
                }
              }
            }).then((dialogId: number) => {
              this.customDialogComponentId = dialogId;
            })
              .catch((error: BusinessError) => {
                console.error(`openCustomDialog error code is ${error.code}, message is ${error.message}`);
              })
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

该示例定义了弹窗样式，如宽度、高度、背景色、阴影等。

说明：

直接使用openCustomDialog可能导致实例不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法openCustomDialog。

import { LevelMode, ImmersiveMode } from '@kit.ArkUI';

let customDialogId: number = 0;

@Builder
function customDialogBuilder(uiContext: UIContext) {
  Column() {
    Text('Custom dialog Message').fontSize(10)
    Row() {
      Button("确认").onClick(() => {
        uiContext.getPromptAction().closeCustomDialog(customDialogId);
      })
      Blank().width(50)
      Button("取消").onClick(() => {
        uiContext.getPromptAction().closeCustomDialog(customDialogId);
      })
    }
  }
}

@Entry
@Component
struct Index {
  @State message: string = 'Hello World';
  private uiContext: UIContext = this.getUIContext();

  @Builder
  customDialogComponent() {
    customDialogBuilder(this.uiContext)
  }

  build() {
    Row() {
      Column() {
        Text(this.message).id("test_text")
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(() => {
            const node: FrameNode|null = this.uiContext.getFrameNodeById("test_text")||null;
            this.uiContext.getPromptAction().openCustomDialog({
              builder: () => {
                this.customDialogComponent()
              },
              keyboardAvoidMode: KeyboardAvoidMode.NONE,
              showInSubWindow: false,
              offset: { dx: 5, dy: 5 },
              backgroundColor: 0xd9ffffff,
              cornerRadius: 20,
              width: '80%',
              height: 200,
              borderWidth: 1,
              borderStyle: BorderStyle.Dashed, // 使用borderStyle属性，需要和borderWidth属性一起使用
              borderColor: Color.Blue, // 使用borderColor属性，需要和borderWidth属性一起使用
              shadow: ({
                radius: 20,
                color: Color.Grey,
                offsetX: 50,
                offsetY: 0
              }),
              levelMode: LevelMode.EMBEDDED,
              levelUniqueId: node?.getUniqueId(),
              immersiveMode: ImmersiveMode.DEFAULT,
            }).then((dialogId: number) => {
              customDialogId = dialogId;
            })
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

zh-cn_image_0007

该示例实现了一个页面内的弹窗。

说明：

直接使用openCustomDialog可能导致实例不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法openCustomDialog。

// Index.ets
import { LevelMode, ImmersiveMode } from '@kit.ArkUI';

let customDialogId: number = 0;

@Builder
function customDialogBuilder(uiContext: UIContext) {
  Column() {
    Text('Custom dialog Message').fontSize(10).height(100)
    Row() {
      Button("Next").onClick(() => {
        uiContext.getRouter().pushUrl({ url: 'pages/Next' });
      })
      Blank().width(50)
      Button("Close").onClick(() => {
        uiContext.getPromptAction().closeCustomDialog(customDialogId);
      })
    }
  }.padding(20)
}

@Entry
@Component
struct Index {
  @State message: string = 'Hello World';
  private uiContext: UIContext = this.getUIContext();

  @Builder
  customDialogComponent() {
    customDialogBuilder(this.uiContext)
  }

  build() {
    Row() {
      Column() {
        Text(this.message).id("test_text")
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(() => {
            const node: FrameNode|null = this.uiContext.getFrameNodeById("test_text")||null;
            this.uiContext.getPromptAction().openCustomDialog({
              builder: () => {
                this.customDialogComponent()
              },
              levelMode: LevelMode.EMBEDDED,
              levelUniqueId: node?.getUniqueId(),
              immersiveMode: ImmersiveMode.DEFAULT,
            }).then((dialogId: number) => {
              customDialogId = dialogId;
            })
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

// Next.ets
@Entry
@Component
struct Next {
  @State message: string = 'Back';

  build() {
    Row() {
      Column() {
        Button(this.message)
          .onClick(() => {
            this.getUIContext().getRouter().back();
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

embedded_dialog

promptAction.closeCustomDialog^(deprecated)

closeCustomDialog(dialogId: number): void

关闭自定义弹窗。

说明：

从API version 11开始支持，从API version 18开始废弃，且直接使用closeCustomDialog可能导致UI上下文不明确的问题，建议使用UIContext中的getPromptAction获取PromptAction实例，再通过此实例调用替代方法closeCustomDialog。

从API version 12开始，可以通过使用UIContext中的getPromptAction方法获取当前UI上下文关联的PromptAction对象。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
dialogId	number	是	openCustomDialog返回的对话框id。

错误码：

以下错误码的详细介绍请参见通用错误码和ohos.promptAction(弹窗)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	Internal error.

示例：

示例请看promptAction.openCustomDialog的示例。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI（方舟UI框架）

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/4gZWom

harmony 鸿蒙@ohos.promptAction (弹窗)

@ohos.promptAction (弹窗)

导入模块

promptAction.openToast18+

promptAction.closeToast18+

ShowToastOptions

ToastShowMode11+

ShowDialogOptions

ShowDialogSuccessResponse

ActionMenuOptions

ActionMenuSuccessResponse

CommonState20+枚举说明

DialogController18+

CommonController18+

constructor

close

getState20+

LevelOrder18+

clamp18+

getOrder18+

DialogOptions18+

DialogOptionsCornerRadius18+

DialogOptionsBorderWidth18+

DialogOptionsBorderColor18+

DialogOptionsBorderStyle18+

DialogOptionsShadow18+

CustomDialogOptions11+

BaseDialogOptions11+

DismissDialogAction12+

属性

DismissReason12+枚举说明

LevelMode15+枚举说明

ImmersiveMode15+枚举说明

Button

示例

promptAction.showToast(deprecated)

promptAction.showDialog(deprecated)

promptAction.showDialog(deprecated)

promptAction.showActionMenu(deprecated)

promptAction.showActionMenu(deprecated)

promptAction.openCustomDialog(deprecated)

promptAction.closeCustomDialog(deprecated)

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

promptAction.openToast¹⁸⁺

promptAction.closeToast¹⁸⁺

ToastShowMode¹¹⁺

CommonState²⁰⁺枚举说明

DialogController¹⁸⁺

CommonController¹⁸⁺

getState²⁰⁺

LevelOrder¹⁸⁺

clamp¹⁸⁺

getOrder¹⁸⁺

DialogOptions¹⁸⁺

DialogOptionsCornerRadius¹⁸⁺

DialogOptionsBorderWidth¹⁸⁺

DialogOptionsBorderColor¹⁸⁺

DialogOptionsBorderStyle¹⁸⁺

DialogOptionsShadow¹⁸⁺

CustomDialogOptions¹¹⁺

BaseDialogOptions¹¹⁺

DismissDialogAction¹²⁺

DismissReason¹²⁺枚举说明

LevelMode¹⁵⁺枚举说明

ImmersiveMode¹⁵⁺枚举说明

promptAction.showToast^(deprecated)

promptAction.showDialog^(deprecated)

promptAction.showDialog^(deprecated)

promptAction.showActionMenu^(deprecated)

promptAction.showActionMenu^(deprecated)

promptAction.openCustomDialog^(deprecated)

promptAction.closeCustomDialog^(deprecated)