【鸿蒙next开发】ArkUI框架:UI界面-@ohos.promptAction (弹窗)

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


@ohos.promptAction (弹窗)

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

说明

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

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

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

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

导入模块

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

promptAction.showToast

showToast(options: ShowToastOptions): void

创建并显示文本提示框。

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

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

参数:

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

错误码:

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

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001Internal 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样式。

API version 12及之后Toast样式。

promptAction.showDialog

showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>

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

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

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

参数:

参数名类型必填说明
optionsShowDialogOptions对话框选项。

返回值:

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

错误码:

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

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001Internal 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);
  })

promptAction.showDialog

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

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

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

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

参数:

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

错误码:

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

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001Internal 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}`);
};

当弹窗的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}`);
};

promptAction.showActionMenu

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

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

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

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

参数:

参数名类型必填说明
optionsActionMenuOptions操作菜单选项。
callbackAsyncCallback<ActionMenuSuccessResponse>菜单响应结果回调。

错误码:

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

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

示例:

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}`);
};

promptAction.showActionMenu

showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse>

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

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

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

参数:

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

返回值:

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

错误码:

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

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001Internal 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);
  })

promptAction.openCustomDialog11+

openCustomDialog(options: CustomDialogOptions): Promise<number>

打开自定义弹窗。

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

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

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

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

参数:

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

返回值:

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

错误码:

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

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001Internal 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%')
  }
}

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

import { promptAction } from '@kit.ArkUI'

let customDialogId: number = 0

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

@Entry
@Component
struct Index {
  @State message: string = 'Hello World'

  @Builder
  customDialogComponent() {
    customDialogBuilder()
  }

  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(() => {
            promptAction.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
              }),
            }).then((dialogId: number) => {
              customDialogId = dialogId
            })
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

promptAction.closeCustomDialog11+

closeCustomDialog(dialogId: number): void

关闭自定义弹窗。

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

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

参数:

参数名类型必填说明
dialogIdnumberopenCustomDialog返回的对话框id。

错误码:

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

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

示例:

示例请看promptAction.openCustomDialog的示例。

ShowToastOptions

文本提示框的选项。

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

名称类型必填说明
messagestring | Resource

显示的文本信息。

说明:

默认字体为'Harmony Sans',不支持设置其他字体。

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

durationnumber

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

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

bottomstring | number

设置弹窗底部边框距离导航条的高度,ToastShowMode.TOP_MOST模式下,软键盘拉起时,如果bottom值过小,toast要被软键盘遮挡时,会自动避让至距离软键盘80vp处。ToastShowMode.DEFAULT模式下,软键盘拉起时,会上移软键盘的高度。

默认值:80vp

说明:

当底部没有导航条时,bottom为设置弹窗底部边框距离窗口底部的高度。

设置对齐方式alignment后,bottom不生效。

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

showMode11+ToastShowMode

设置弹窗是否显示在应用之上。

默认值:ToastShowMode.DEFAULT,默认显示在应用内。

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

alignment12+Alignment

对齐方式。

默认值:undefined,默认底部偏上位置。

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

offset12+Offset

在对齐方式上的偏移。

默认值:{ dx: 0, dy: 0 },默认没有偏移。

说明:

只支持设置px类型的数值,如需设置vp,可以将vp改成px传入。

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

backgroundColor12+ResourceColor

文本提示框背板颜色

默认值:Color.Transparent

说明:

当设置了backgroundColor为非透明色时,backgroundBlurStyle需要设置为BlurStyle.NONE,否则颜色显示将不符合预期效果。

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

textColor12+ResourceColor

文本提示框文本颜色

默认值:Color.Black

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

backgroundBlurStyle12+BlurStyle

文本提示框背板模糊材质

默认值:BlurStyle.COMPONENT_ULTRA_THICK

说明:

设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时,则不要设置backgroundColor,否则颜色显示将不符合预期效果。

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

shadow12+ShadowOptions | ShadowStyle

文本提示框背板阴影

默认值:ShadowStyle.OUTER_DEFAULT_MD

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

ToastShowMode11+

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

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

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

名称说明
DEFAULT0Toast 显示在应用内。
TOP_MOST1Toast 显示在应用之上。

ShowDialogOptions

对话框的选项。

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

名称类型必填说明
titlestring | Resource

标题文本。

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

messagestring | Resource

内容文本。

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

buttonsArray<Button>

对话框中按钮的数组,结构为:{text:'button', color: '#666666'},支持大于1个按钮。

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

alignment10+DialogAlignment

弹窗在竖直方向上的对齐方式。

默认值:DialogAlignment.Default

说明

若在UIExtension中设置showInSubWindow为true, 弹窗将基于UIExtension的宿主窗口对齐。

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

offset10+Offset

弹窗相对alignment所在位置的偏移量。

默认值:{ dx: 0 , dy: 0 }

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

maskRect10+Rectangle

弹窗遮蔽层区域,在遮蔽层区域内的事件不透传,在遮蔽层区域外的事件透传。

默认值:{ x: 0, y: 0, width: '100%', height: '100%' }

说明:

showInSubWindow为true时,maskRect不生效。

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

showInSubWindow11+boolean

某弹框需要显示在主窗口之外时,是否在子窗口显示此弹窗。

默认值:false,弹窗显示在应用内,而非独立子窗口。

说明:showInSubWindow为true的弹窗无法触发显示另一个showInSubWindow为true的弹窗。

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

isModal11+boolean

弹窗是否为模态窗口,模态窗口有蒙层,非模态窗口无蒙层。

默认值:true,此时弹窗有蒙层。

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

backgroundColor12+ResourceColor

弹窗背板颜色。

默认值:Color.Transparent

说明:

当设置了backgroundColor为非透明色时,backgroundBlurStyle需要设置为BlurStyle.NONE,否则颜色显示将不符合预期效果。

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

backgroundBlurStyle12+BlurStyle

弹窗背板模糊材质。

默认值:BlurStyle.COMPONENT_ULTRA_THICK

说明:

设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时,则不要设置backgroundColor,否则颜色显示将不符合预期效果。

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

shadow12+ShadowOptions | ShadowStyle

设置弹窗背板的阴影。

当设备为2in1时,默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD,失焦为ShadowStyle.OUTER_FLOATING_SM

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

ShowDialogSuccessResponse

对话框的响应结果。

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

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

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

ActionMenuOptions

操作菜单的选项。

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

名称类型必填说明
titlestring | Resource

标题文本。

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

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

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

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

showInSubWindow11+boolean

某弹框需要显示在主窗口之外时,是否在子窗口显示此弹窗。

默认值:false,在子窗口不显示弹窗。

说明

- showInSubWindow为true的弹窗无法触发显示另一个showInSubWindow为true的弹窗。

- 若在UIExtension中设置showInSubWindow为true, 弹窗将基于UIExtension的宿主窗口对齐。

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

isModal11+boolean

弹窗是否为模态窗口,模态窗口有蒙层,非模态窗口无蒙层。

默认值:true,此时弹窗有蒙层。

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

ActionMenuSuccessResponse

操作菜单的响应结果。

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

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

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

CustomDialogOptions11+

自定义弹窗的内容,继承自BaseDialogOptions

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

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

名称类型必填说明
builderCustomBuilder

设置自定义弹窗的内容。

说明:

builder需要赋值为箭头函数,格式如下:() => { this.XXX() },其中XXX是内部builder名。

如果是全局builder需要在组件内部创建一个builder,在内部builder中调用全局builder。

builder根节点宽高百分比相对弹框容器大小。

builder非根节点宽高百分比相对父节点大小。

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

backgroundColor 12+ResourceColor

设置弹窗背板颜色。

默认值:Color.Transparent

说明:

当设置了backgroundColor为非透明色时,backgroundBlurStyle需要设置为BlurStyle.NONE,否则颜色显示将不符合预期效果。

cornerRadius12+Dimension | BorderRadiuses

设置背板的圆角半径。

可分别设置4个圆角的半径。

默认值:{ topLeft: '32vp', topRight: '32vp', bottomLeft: '32vp', bottomRight: '32vp' }。

圆角大小受组件尺寸限制,最大值为组件宽或高的一半,若值为负,则按照默认值处理。

百分比参数方式:以父元素弹窗宽和高的百分比来设置弹窗的圆角。

borderWidth12+Dimension | EdgeWidths

设置弹窗背板的边框宽度。

可分别设置4个边框宽度。

默认值:0。

百分比参数方式:以父元素弹窗宽的百分比来设置弹窗的边框宽度。

当弹窗左边框和右边框大于弹窗宽度,弹窗上边框和下边框大于弹窗高度,显示可能不符合预期。

borderColor12+ResourceColor | EdgeColors

设置弹窗背板的边框颜色。

默认值:Color.Black。

如果使用borderColor属性,需要和borderWidth属性一起使用。

borderStyle12+BorderStyle | EdgeStyles

设置弹窗背板的边框样式。

默认值:BorderStyle.Solid。

如果使用borderStyle属性,需要和borderWidth属性一起使用。

width12+Dimension

设置弹窗背板的宽度。

说明:

- 弹窗宽度默认最大值:400vp。

- 百分比参数方式:弹窗参考宽度为所在窗口的宽度,在此基础上调小或调大。

height12+Dimension

设置弹窗背板的高度。

说明:

- 弹窗高度默认最大值:0.9 *(窗口高度 - 安全区域)。

- 百分比参数方式:弹窗参考高度为(窗口高度 - 安全区域),在此基础上调小或调大。

shadow12+ShadowOptions | ShadowStyle

设置弹窗背板的阴影。

当设备为2in1时,默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD,失焦为ShadowStyle.OUTER_FLOATING_SM

backgroundBlurStyle12+BlurStyle

弹窗背板模糊材质。

默认值:BlurStyle.COMPONENT_ULTRA_THICK

说明:

设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时,则不要设置backgroundColor,否则颜色显示将不符合预期效果。

BaseDialogOptions11+

弹窗的选项。

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

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

名称类型必填说明
maskRectRectangle

弹窗遮蔽层区域。

默认值:{ x: 0, y: 0, width: '100%', height: '100%' }

说明:

showInSubWindow为true时,maskRect不生效。

alignmentDialogAlignment

弹窗在竖直方向上的对齐方式。

默认值:DialogAlignment.Default

说明

若在UIExtension中设置showInSubWindow为true, 弹窗将基于UIExtension的宿主窗口对齐。

offsetOffset

弹窗相对alignment所在位置的偏移量。

默认值:{ dx: 0 , dy: 0 }

isModalboolean

弹窗是否为模态窗口,模态窗口有蒙层,非模态窗口无蒙层。

默认值:true,此时弹窗有蒙层。

showInSubWindowboolean

某弹框需要显示在主窗口之外时,是否在子窗口显示此弹窗。

默认值:false,弹窗显示在应用内,而非独立子窗口。

onWillDismiss12+Callback<DismissDialogAction>

交互式关闭回调函数。

说明:

1.当用户执行点击遮障层关闭、左滑/右滑、三键back、键盘ESC关闭交互操作时,如果注册该回调函数,则不会立刻关闭弹窗。在回调函数中可以通过reason得到阻拦关闭弹窗的操作类型,从而根据原因选择是否能关闭弹窗。当前组件返回的reason中,暂不支持CLOSE_BUTTON的枚举值。

2.在onWillDismiss回调中,不能再做onWillDismiss拦截。

autoCancel12+boolean

点击遮障层时,是否关闭弹窗,true表示关闭弹窗。false表示不关闭弹窗。

默认值:true

maskColor12+ResourceColor

自定义蒙层颜色。

默认值: 0x33000000

transition12+TransitionEffect

设置弹窗显示和退出的过渡效果。

说明:

1.如果不设置,则使用默认的显示/退出动效。

2.显示动效中按back键,打断显示动效,执行退出动效,动画效果为显示动效与退出动效的曲线叠加后的效果。

3.退出动效中按back键,不会打断退出动效,退出动效继续执行,继续按back键退出应用。

onDidAppear12+() => void

弹窗弹出时的事件回调。

说明:

1.正常时序依次为:onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。

2.在onDidAppear内设置改变弹窗显示效果的回调事件,二次弹出生效。

3.快速点击弹出,消失弹窗时,存在onWillDisappear在onDidAppear前生效。

4. 当弹窗入场动效未完成时关闭弹窗,该回调不会触发。

onDidDisappear12+() => void

弹窗消失时的事件回调。

说明:

正常时序依次为:onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。

onWillAppear12+() => void

弹窗显示动效前的事件回调。

说明:

1.正常时序依次为:onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。

2.在onWillAppear内设置改变弹窗显示效果的回调事件,二次弹出生效。

onWillDisappear12+() => void

弹窗退出动效前的事件回调。

说明:

1.正常时序依次为:onWillAppear>>onDidAppear>>(onDateAccept/onCancel/onDateChange)>>onWillDisappear>>onDidDisappear。

2.快速点击弹出,消失弹窗时,存在onWillDisappear在onDidAppear前生效。

keyboardAvoidMode12+KeyboardAvoidMode

用于设置弹窗是否在拉起软键盘时进行自动避让。

默认值:KeyboardAvoidMode.DEFAULT

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

DismissDialogAction12+

Dialog关闭的信息。

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

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

属性

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

DismissReason12+枚举说明

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

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

名称描述
PRESS_BACK0点击三键back、左滑/右滑、键盘ESC。
TOUCH_OUTSIDE1点击遮障层时。
CLOSE_BUTTON2点击关闭按钮。
SLIDE_DOWN3

下拉关闭。

说明:

该接口仅支持在半模态转场中使用。

Button

菜单中的菜单项按钮。

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

名称类型必填说明
textstring | Resource

按钮文本内容。

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

colorstring | Resource

按钮文本颜色。

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

primary12+boolean

在弹窗获焦且未进行tab键走焦时,按钮是否默认响应Enter键。多个Button时,只允许一个Button的该字段配置为true,否则所有Button均不响应。多重弹窗可自动获焦连续响应。

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值