js-apis-promptAction.md 11.2 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.promptAction (弹窗)
Z
zhaoxinyu 已提交
2 3 4 5 6 7

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

> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Y
yamila 已提交
8
>
Y
yamila 已提交
9
> 该模块不支持在[UIAbility](./js-apis-app-ability-uiAbility.md)中使用,需要在创建组件实例后使用。
Z
zhaoxinyu 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

## 导入模块

```js
import promptAction from '@ohos.promptAction'
```

## promptAction.showToast

showToast(options: ShowToastOptions): void

创建并显示文本提示框。

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

**参数:**

| 参数名     | 类型                                    | 必填   | 说明      |
| ------- | ------------------------------------- | ---- | ------- |
| options | [ShowToastOptions](#showtoastoptions) | 是    | 文本弹窗选项。 |

**错误码:**

以下错误码的详细介绍请参见[ohos.promptAction(弹窗)](../errorcodes/errorcode-promptAction.md)错误码。

35
| 错误码ID   | 错误信息 |
Z
zhaoxinyu 已提交
36
| --------- | ------- |
L
luoying_ace_admin 已提交
37
| 100001    | if UI execution context not found. |
Z
zhaoxinyu 已提交
38 39 40 41 42 43 44

**示例:**

```js
try {
  promptAction.showToast({            
    message: 'Message Info',
Y
yamila 已提交
45
    duration: 2000 
Z
zhaoxinyu 已提交
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
  });
} catch (error) {
  console.error(`showToast args error code is ${error.code}, message is ${error.message}`);
};

```

![zh-cn_image_0001](figures/zh-cn_image_0001.gif)

## ShowToastOptions

文本提示框的选项。

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

| 名称       | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| message  | string\| [Resource](../arkui-ts/ts-types.md#resource类型)<sup>9+</sup> | 是    | 显示的文本信息。                                 |
| duration | number                                   | 否    | 默认值1500ms,取值区间:1500ms-10000ms。若小于1500ms则取默认值,若大于10000ms则取上限值10000ms。 |
| bottom   | string\| number                          | 否    | 设置弹窗边框距离屏幕底部的位置。                         |

## promptAction.showDialog

showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt;

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

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

**参数:**

| 参数名     | 类型                                      | 必填   | 说明     |
| ------- | --------------------------------------- | ---- | ------ |
| options | [ShowDialogOptions](#showdialogoptions) | 是    | 对话框选项。 |

**返回值:**

| 类型                                       | 说明       |
| ---------------------------------------- | -------- |
| Promise&lt;[ShowDialogSuccessResponse](#showdialogsuccessresponse)&gt; | 对话框响应结果。 |

**错误码:**

以下错误码的详细介绍请参见[ohos.promptAction(弹窗)](../errorcodes/errorcode-promptAction.md)错误码。

91
| 错误码ID   | 错误信息 |
Z
zhaoxinyu 已提交
92
| --------- | ------- |
L
luoying_ace_admin 已提交
93
| 100001    | if UI execution context not found. |
Z
zhaoxinyu 已提交
94 95 96 97 98 99 100 101 102 103 104

**示例:**

```js
try {
  promptAction.showDialog({
    title: 'Title Info',
    message: 'Message Info',
    buttons: [
      {
        text: 'button1',
Y
yamila 已提交
105
        color: '#000000'
Z
zhaoxinyu 已提交
106 107 108
      },
      {
        text: 'button2',
Y
yamila 已提交
109
        color: '#000000'
Z
zhaoxinyu 已提交
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
      }
    ],
  })
    .then(data => {
      console.info('showDialog success, click button: ' + data.index);
    })
    .catch(err => {
      console.info('showDialog error: ' + err);
    })
} catch (error) {
  console.error(`showDialog args error code is ${error.code}, message is ${error.message}`);
};
```

![zh-cn_image_0002](figures/zh-cn_image_0002.gif)

## promptAction.showDialog

showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSuccessResponse&gt;):void 

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

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

**参数:**

| 参数名      | 类型                                       | 必填   | 说明           |
| -------- | ---------------------------------------- | ---- | ------------ |
| options  | [ShowDialogOptions](#showdialogoptions)  | 是    | 页面显示对话框信息描述。 |
| callback | AsyncCallback&lt;[ShowDialogSuccessResponse](#showdialogsuccessresponse)&gt; | 是    | 对话框响应结果回调。   |

**错误码:**

以下错误码的详细介绍请参见[ohos.promptAction(弹窗)](../errorcodes/errorcode-promptAction.md)错误码。

145
| 错误码ID   | 错误信息 |
Z
zhaoxinyu 已提交
146
| --------- | ------- |
L
luoying_ace_admin 已提交
147
| 100001    | if UI execution context not found. |
Z
zhaoxinyu 已提交
148 149 150 151 152 153 154 155 156 157 158

**示例:**

```js
try {
  promptAction.showDialog({
    title: 'showDialog Title Info',
    message: 'Message Info',
    buttons: [
      {
        text: 'button1',
Y
yamila 已提交
159
        color: '#000000'
Z
zhaoxinyu 已提交
160 161 162
      },
      {
        text: 'button2',
Y
yamila 已提交
163
        color: '#000000'
Z
zhaoxinyu 已提交
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
      }
    ]
  }, (err, data) => {
    if (err) {
      console.info('showDialog err: ' + err);
      return;
    }
    console.info('showDialog success callback, click button: ' + data.index);
  });
} catch (error) {
  console.error(`showDialog args error code is ${error.code}, message is ${error.message}`);
};
```

![zh-cn_image_0002](figures/zh-cn_image_0002.gif)

## ShowDialogOptions

对话框的选项。

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

Y
yamila 已提交
186 187 188 189 190
| 名称    | 类型                                                         | 必填 | 说明                                                         |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| title   | string\| [Resource](../arkui-ts/ts-types.md#resource类型)<sup>9+</sup> | 否   | 标题文本。                                                   |
| message | string\| [Resource](../arkui-ts/ts-types.md#resource类型)<sup>9+</sup> | 否   | 内容文本。                                                   |
| buttons | [[Button](#button),[Button](#button)?,[Button](#button)?]    | 否   | 对话框中按钮的数组,结构为:{text:'button',&nbsp;color:&nbsp;'\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 |
Z
zhaoxinyu 已提交
191 192 193 194 195 196 197

## ShowDialogSuccessResponse 

对话框的响应结果。

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

Y
yamila 已提交
198 199 200
| 名称  | 类型   | 必填 | 说明                            |
| ----- | ------ | ---- | ------------------------------- |
| index | number | 否   | 选中按钮在buttons数组中的索引。 |
Z
zhaoxinyu 已提交
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

## promptAction.showActionMenu

showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenuSuccessResponse&gt;):void

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

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

**参数:**

| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
| options  | [ActionMenuOptions](#actionmenuoptions)  | 是    | 操作菜单选项。   |
| callback | AsyncCallback&lt;[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | 是    | 菜单响应结果回调。 |

**错误码:**

以下错误码的详细介绍请参见[ohos.promptAction(弹窗)](../errorcodes/errorcode-promptAction.md)错误码。

221
| 错误码ID   | 错误信息 |
Z
zhaoxinyu 已提交
222
| --------- | ------- |
L
luoying_ace_admin 已提交
223
| 100001    | if UI execution context not found. |
Z
zhaoxinyu 已提交
224 225 226 227 228 229 230 231 232 233

**示例:**

```js
try {
  promptAction.showActionMenu({
    title: 'Title Info',
    buttons: [
      {
        text: 'item1',
Y
yamila 已提交
234
        color: '#666666'
Z
zhaoxinyu 已提交
235 236 237
      },
      {
        text: 'item2',
Y
yamila 已提交
238
        color: '#000000'
Z
zhaoxinyu 已提交
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
      },
    ]
  }, (err, data) => {
    if (err) {
      console.info('showActionMenu err: ' + err);
      return;
    }
    console.info('showActionMenu success callback, click button: ' + data.index);
  })
} catch (error) {
  console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`);
};
```

![zh-cn_image_0005](figures/zh-cn_image_0005.gif)

## promptAction.showActionMenu

showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse&gt;

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

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

**参数:**

| 参数名     | 类型                                      | 必填   | 说明      |
| ------- | --------------------------------------- | ---- | ------- |
| options | [ActionMenuOptions](#actionmenuoptions) | 是    | 操作菜单选项。 |

**返回值:**

| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
| Promise&lt;[ActionMenuSuccessResponse](#actionmenusuccessresponse)&gt; | 菜单响应结果。 |

**错误码:**

以下错误码的详细介绍请参见[ohos.promptAction(弹窗)](../errorcodes/errorcode-promptAction.md)错误码。

279
| 错误码ID   | 错误信息 |
Z
zhaoxinyu 已提交
280
| --------- | ------- |
L
luoying_ace_admin 已提交
281
| 100001    | if UI execution context not found. |
Z
zhaoxinyu 已提交
282 283 284 285 286 287 288 289 290 291

**示例:**

```js
try {
  promptAction.showActionMenu({
    title: 'showActionMenu Title Info',
    buttons: [
      {
        text: 'item1',
Y
yamila 已提交
292
        color: '#666666'
Z
zhaoxinyu 已提交
293 294 295
      },
      {
        text: 'item2',
Y
yamila 已提交
296
        color: '#000000'
Z
zhaoxinyu 已提交
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
      },
    ]
  })
    .then(data => {
      console.info('showActionMenu success, click button: ' + data.index);
    })
    .catch(err => {
      console.info('showActionMenu error: ' + err);
    })
} catch (error) {
  console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`);
};
```

![zh-cn_image_0005](figures/zh-cn_image_0005.gif)

## ActionMenuOptions

操作菜单的选项。

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

Y
yamila 已提交
319 320 321 322
| 名称    | 类型                                                         | 必填 | 说明                                                         |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| title   | string\| [Resource](../arkui-ts/ts-types.md#resource类型)<sup>9+</sup> | 否   | 标题文本。                                                   |
| buttons | [[Button](#button),[Button](#button)?,[Button](#button)?,[Button](#button)?,[Button](#button)?,[Button](#button)?] | 是   | 菜单中菜单项按钮的数组,结构为:{text:'button',&nbsp;color:&nbsp;'\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 |
Z
zhaoxinyu 已提交
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

## ActionMenuSuccessResponse

操作菜单的响应结果。

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

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

## Button

菜单中的菜单项按钮。

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

| 名称    | 类型                                       | 必填   | 说明      |
| ----- | ---------------------------------------- | ---- | ------- |
| text  | string\| [Resource](../arkui-ts/ts-types.md#resource类型)<sup>9+</sup> | 是    | 按钮文本内容。 |
| color | string\| [Resource](../arkui-ts/ts-types.md#resource类型)<sup>9+</sup> | 是    | 按钮文本颜色。 |