1# @system.prompt (弹窗) 2 3创建并显示文本提示框、对话框和操作菜单。 4 5> **说明：** 6> 7> - 从API Version 8 开始，该接口不再维护，推荐使用新接口[@ohos.promptAction (弹窗)](js-apis-promptAction.md)。 8> 9> 10> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 11 12 13## 导入模块 14 15 16```ts 17import prompt from '@system.prompt'; 18``` 19 20## prompt.showToast 21 22showToast(options: ShowToastOptions): void 23 24显示文本弹窗。 25 26**系统能力：** SystemCapability.ArkUI.ArkUI.Full 27 28**参数：** 29 30| 参数名 | 类型 | 必填 | 说明 | 31| ------- | ------------------------------------- | ---- | --------------- | 32| options | [ShowToastOptions](#showtoastoptions) | 是 | 定义ShowToast的选项。 | 33 34**示例：** 35 36```ts 37import prompt from '@system.prompt'; 38class A{ 39 showToast() { 40 prompt.showToast({ 41 message: 'Message Info', 42 duration: 2000 43 }); 44 } 45} 46export default new A() 47``` 48 49 50## prompt.showDialog 51 52showDialog(options: ShowDialogOptions): void 53 54显示对话框。 55 56**系统能力：** SystemCapability.ArkUI.ArkUI.Full 57 58**参数：** 59 60| 参数名 | 类型 | 必填 | 说明 | 61| ------- | --------------------------------------- | ---- | ----------- | 62| options | [ShowDialogOptions](#showdialogoptions) | 是 | 定义显示对话框的选项。 | 63 64 65**示例：** 66 67```ts 68import prompt from '@system.prompt'; 69class B{ 70 showDialog() { 71 prompt.showDialog({ 72 title: 'Title Info', 73 message: 'Message Info', 74 buttons: [ 75 { 76 text: 'button', 77 color: '#666666' 78 }, 79 ], 80 success: (data)=> { 81 console.log('dialog success callback，click button : ' + data.index); 82 }, 83 cancel: ()=> { 84 console.log('dialog cancel callback'); 85 }, 86 }); 87 } 88} 89export default new B() 90``` 91 92## prompt.showActionMenu<sup>6+</sup> 93 94showActionMenu(options: ShowActionMenuOptions): void 95 96显示操作菜单。 97 98**系统能力：** SystemCapability.ArkUI.ArkUI.Full 99 100**参数：** 101 102| 参数名 | 类型 | 必填 | 说明 | 103| ------- | ---------------------------------------- | ---- | -------------------- | 104| options | [ShowActionMenuOptions](#showactionmenuoptions) | 是 | 定义ShowActionMenu的选项。 | 105 106 107**示例：** 108 109```ts 110import prompt from '@system.prompt'; 111class C{ 112 showActionMenu() { 113 prompt.showActionMenu({ 114 title: 'Title Info', 115 buttons: [ 116 { 117 text: 'item1', 118 color: '#666666' 119 }, 120 { 121 text: 'item2', 122 color: '#000000' 123 }, 124 ], 125 success: (tapIndex)=> { 126 console.log('dialog success callback，click button : ' + tapIndex); 127 }, 128 fail: (errMsg)=> { 129 console.log('dialog fail callback' + errMsg); 130 }, 131 }); 132 } 133} 134export default new C() 135``` 136## ShowToastOptions 137 138定义ShowToast的选项。 139 140**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full 141 142| 名称 | 类型 | 必填 | 说明 | 143| ------------------- | -------------- | ---- | ---------------------------------------- | 144| message | string | 是 | 显示的文本信息。 | 145| duration | number | 否 | 默认值1500ms，建议区间：1500ms-10000ms。若小于1500ms则取默认值，最大取值为10000ms。 | 146| bottom<sup>5+</sup> | string\|number | 否 | 设置弹窗边框距离屏幕底部的位置。 | 147 148## Button 149 150定义按钮的提示信息。 151 152**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full 153 154| 名称 | 类型 | 必填 | 说明 | 155| ----- | ------ | ---- | ------- | 156| text | string | 是 | 定义按钮信息。 | 157| color | string | 是 | 定义按钮颜色。 | 158 159## ShowDialogSuccessResponse 160 161定义ShowDialog的响应。 162 163**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full 164 165| 名称 | 类型 | 必填 | 说明 | 166| ----- | ------ | ---- | ---------- | 167| index | number | 是 | 定义数据的索引信息。 | 168 169## ShowDialogOptions 170 171定义显示对话框的选项。 172 173**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full 174 175| 名称 | 类型 | 必填 | 说明 | 176| -------- | ---------------------------------------- | ---- | ---------------------------------------- | 177| title | string | 否 | 标题文本。 | 178| message | string | 否 | 文本内容。 | 179| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?] | 否 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-6个按钮。大于6个按钮时弹窗不显示。 | 180| success | (data: [ShowDialogSuccessResponse](#showdialogsuccessresponse)) => void | 否 | 接口调用成功的回调函数。 | 181| cancel | (data: string, code: string) => void | 否 | 接口调用失败的回调函数。 | 182| complete | (data: string) => void | 否 | 接口调用结束的回调函数。 | 183 184## ShowActionMenuOptions<sup>6+</sup> 185 186定义ShowActionMenu的选项。 187 188**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full 189 190| 名称 | 类型 | 必填 | 说明 | 191| -------- | ---------------------------------------- | ---- | ---------------------------------------- | 192| title | string | 否 | 标题文本。 | 193| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?] | 是 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-6个按钮。 | 194| success | (tapIndex: number, errMsg: string) => void | 否 | 弹出对话框时调用。 | 195| fail | (errMsg: string) => void | 否 | 接口调用失败的回调函数。 | 196| complete | (data: string) => void | 否 | 关闭对话框时调用。 | 197