弹窗

2024-01-23 13:11 更新

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

说明

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

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

导入模块

  1. import promptAction from '@ohos.promptAction'

promptAction.showToast

showToast(options: ShowToastOptions): void

创建并显示文本提示框。

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

参数:

参数名

类型

必填

说明

options

ShowToastOptions

文本弹窗选项。

错误码:

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

错误码ID

错误信息

100001

if UI execution context not found.

示例:

  1. try {
  2. promptAction.showToast({
  3. message: 'Message Info',
  4. duration: 2000,
  5. });
  6. } catch (error) {
  7. console.error(`showToast args error code is ${error.code}, message is ${error.message}`);
  8. };

ShowToastOptions

文本提示框的选项。

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

名称

类型

必填

说明

message

string| Resource9+

显示的文本信息。默认字体为'Harmony Sans',不支持设置其他字体。

duration

number

默认值1500ms,取值区间:1500ms-10000ms。若小于1500ms则取默认值,若大于10000ms则取上限值10000ms。

bottom

string| number

设置弹窗边框距离屏幕底部的位置。

promptAction.showDialog

showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>

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

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

参数:

参数名

类型

必填

说明

options

ShowDialogOptions

对话框选项。

返回值:

类型

说明

Promise<ShowDialogSuccessResponse>

对话框响应结果。

错误码:

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

错误码ID

错误信息

100001

if UI execution context not found.

示例:

  1. try {
  2. promptAction.showDialog({
  3. title: 'Title Info',
  4. message: 'Message Info',
  5. buttons: [
  6. {
  7. text: 'button1',
  8. color: '#000000',
  9. },
  10. {
  11. text: 'button2',
  12. color: '#000000',
  13. }
  14. ],
  15. })
  16. .then(data => {
  17. console.info('showDialog success, click button: ' + data.index);
  18. })
  19. .catch(err => {
  20. console.info('showDialog error: ' + err);
  21. })
  22. } catch (error) {
  23. console.error(`showDialog args error code is ${error.code}, message is ${error.message}`);
  24. };

promptAction.showDialog

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

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

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

参数:

参数名

类型

必填

说明

options

ShowDialogOptions

页面显示对话框信息描述。

callback

AsyncCallback<ShowDialogSuccessResponse>

对话框响应结果回调。

错误码:

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

错误码ID

错误信息

100001

if UI execution context not found.

示例:

  1. try {
  2. promptAction.showDialog({
  3. title: 'showDialog Title Info',
  4. message: 'Message Info',
  5. buttons: [
  6. {
  7. text: 'button1',
  8. color: '#000000',
  9. },
  10. {
  11. text: 'button2',
  12. color: '#000000',
  13. }
  14. ]
  15. }, (err, data) => {
  16. if (err) {
  17. console.info('showDialog err: ' + err);
  18. return;
  19. }
  20. console.info('showDialog success callback, click button: ' + data.index);
  21. });
  22. } catch (error) {
  23. console.error(`showDialog args error code is ${error.code}, message is ${error.message}`);
  24. };

ShowDialogOptions

对话框的选项。

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

名称

类型

必填

说明

title

string| Resource9+

标题文本。

message

string| Resource9+

内容文本。

buttons

[Button,Button?,Button?]

对话框中按钮的数组,结构为:{text:'button', color: '#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。

ShowDialogSuccessResponse

对话框的响应结果。

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

名称

类型

必填

说明

index

number

选中按钮在buttons数组中的索引。

promptAction.showActionMenu

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

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

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

参数:

参数名

类型

必填

说明

options

ActionMenuOptions

操作菜单选项。

callback

AsyncCallback<ActionMenuSuccessResponse>

菜单响应结果回调。

错误码:

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

错误码ID

错误信息

100001

if UI execution context not found.

示例:

  1. try {
  2. promptAction.showActionMenu({
  3. title: 'Title Info',
  4. buttons: [
  5. {
  6. text: 'item1',
  7. color: '#666666',
  8. },
  9. {
  10. text: 'item2',
  11. color: '#000000',
  12. },
  13. ]
  14. }, (err, data) => {
  15. if (err) {
  16. console.info('showActionMenu err: ' + err);
  17. return;
  18. }
  19. console.info('showActionMenu success callback, click button: ' + data.index);
  20. })
  21. } catch (error) {
  22. console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`);
  23. };

promptAction.showActionMenu

showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse>

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

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

参数:

参数名

类型

必填

说明

options

ActionMenuOptions

操作菜单选项。

返回值:

类型

说明

Promise<ActionMenuSuccessResponse>

菜单响应结果。

错误码:

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

错误码ID

错误信息

100001

if UI execution context not found.

示例:

  1. try {
  2. promptAction.showActionMenu({
  3. title: 'showActionMenu Title Info',
  4. buttons: [
  5. {
  6. text: 'item1',
  7. color: '#666666',
  8. },
  9. {
  10. text: 'item2',
  11. color: '#000000',
  12. },
  13. ]
  14. })
  15. .then(data => {
  16. console.info('showActionMenu success, click button: ' + data.index);
  17. })
  18. .catch(err => {
  19. console.info('showActionMenu error: ' + err);
  20. })
  21. } catch (error) {
  22. console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`);
  23. };

ActionMenuOptions

操作菜单的选项。

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

名称

类型

必填

说明

title

string| Resource9+

标题文本。

buttons

[Button,Button?,Button?,Button?,Button?,Button?]

菜单中菜单项按钮的数组,结构为:{text:'button', color: '#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。

ActionMenuSuccessResponse

操作菜单的响应结果。

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

名称

类型

必填

说明

index

number

选中按钮在buttons数组中的索引,从0开始。

Button

菜单中的菜单项按钮。

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

名称

类型

必填

说明

text

string| Resource9+

按钮文本内容。

color

string| Resource9+

按钮文本颜色。

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号