harmony 鸿蒙@ohos.promptAction (弹窗)

  • 2022-10-28
  • 浏览 (1606)

@ohos.promptAction (弹窗)

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

说明：

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

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

本模块功能依赖UI的执行上下文，不可在UI上下文不明确的地方使用，参见UIContext说明。

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

导入模块

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.

示例：

import promptAction from '@ohos.promptAction'
import { BusinessError } from '@ohos.base';
try {
  promptAction.showToast({            
    message: 'Message Info',
    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}`);
};

zh-cn_image_0001

ShowToastOptions

文本提示框的选项。

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

名称 类型 必填 说明
message string|Resource9+ 是 显示的文本信息。
说明：
默认字体为’Harmony Sans’，不支持设置其他字体。
duration number 否 默认值1500ms，取值区间：1500ms-10000ms。若小于1500ms则取默认值，若大于10000ms则取上限值10000ms。
bottom string|number 否 设置弹窗边框距离屏幕底部的位置。
默认值：80vp
showMode11+ ToastShowMode 否 设置弹窗是否显示在应用之上。
默认值：ToastShowMode.DEFAULT，默认显示在应用内

ToastShowMode11+

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

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

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

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.

示例：

import promptAction from '@ohos.promptAction'
import { BusinessError } from '@ohos.base';
try {
  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);
    })
} 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

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.

示例：

import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
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_0002

ShowDialogOptions

对话框的选项。

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

名称 类型 必填 说明
title string|Resource9+ 否 标题文本。
message string|Resource9+ 否 内容文本。
buttons Array<Button> 否 对话框中按钮的数组，结构为：{text:‘button’, color: ‘#666666’}，支持大于1个按钮。
alignment10+ DialogAlignment 否 弹窗在竖直方向上的对齐方式。
默认值：DialogAlignment.Default
offset10+ Offset 否 弹窗相对alignment所在位置的偏移量。
默认值：{ dx: 0 , dy: 0 }
maskRect10+ Rectangle 否 弹窗遮蔽层区域，在遮蔽层区域内的事件不透传，在遮蔽层区域外的事件透传。
默认值：{ x: 0, y: 0, width: ‘100%’, height: ‘100%’ }

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.

示例：

import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
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

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.

示例：

import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
try {
  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);
    })
} 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

ActionMenuOptions

操作菜单的选项。

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

名称 类型 必填 说明
title string|Resource9+ 否 标题文本。
buttons [Button,Button?,Button?,Button?,Button?,Button?] 是 菜单中菜单项按钮的数组，结构为：{text:‘button’, color: ‘#666666’}，支持1-6个按钮。按钮数量大于6个时，仅显示前6个按钮，之后的按钮不显示。

ActionMenuSuccessResponse

操作菜单的响应结果。

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

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

Button

菜单中的菜单项按钮。

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

名称 类型 必填 说明
text string|Resource9+ 是 按钮文本内容。
color string|Resource9+ 是 按钮文本颜色。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/785e46f43b55448998e15c42ccd4fe9b
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录