diff --git a/en/application-dev/reference/apis/js-apis-prompt.md b/en/application-dev/reference/apis/js-apis-prompt.md
index 3facc0146ebe2484672cffb3c9a45d0ac7d9f164..971b3408c9a9fdd616fe1133ca3cab3844ee7fd1 100644
--- a/en/application-dev/reference/apis/js-apis-prompt.md
+++ b/en/application-dev/reference/apis/js-apis-prompt.md
@@ -1,22 +1,22 @@
# Prompt
+The **Prompt** module provides APIs for creating and showing toasts, dialog boxes, and action menus.
+
> **NOTE**
+>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
-```
+```js
import prompt from '@ohos.prompt'
```
-## Required Permissions
-
-None.
## prompt.showToast
showToast(options: ShowToastOptions): void
-Shows the toast.
+Shows a toast.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
@@ -26,15 +26,11 @@ Shows the toast.
| options | [ShowToastOptions](#showtoastoptions) | Yes | Toast options.|
**Example**
- ```
- export default {
- showToast() {
- prompt.showToast({
- message: 'Message Info',
- duration: 2000,
- });
- }
- }
+ ```js
+prompt.showToast({
+ message: 'Message Info',
+ duration: 2000,
+});
```
## ShowToastOptions
@@ -42,11 +38,11 @@ Describes the options for showing the toast.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| -------- | -------------- | ---- | ---------------------------------------- |
-| message | string | Yes | Text to display. |
-| duration | number | No | Duration that the toast will remain on the screen. The default value is 1500 ms. The recommended value range is 1500 ms to 10000 ms. If a value less than 1500 ms is set, the default value is used.|
-| bottom | <length> | No | Distance between the toast border and the bottom of the screen. |
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------------------------- | ------ | ---------------------------------------- |
+| message | string\| [Resource](.../ui/ts-types.md#resource-type)9+| Yes | Text to display. |
+| duration | number | No | Duration that the toast will remain on the screen. The default value is 1500 ms. The recommended value range is 1500 ms to 10000 ms. If a value less than 1500 ms is set, the default value is used.|
+| bottom | string\| number | No | Distance between the toast border and the bottom of the screen. |
## prompt.showDialog
@@ -69,38 +65,34 @@ Shows a dialog box. This API uses a promise to return the result synchronously.
**Example**
- ```
- export default {
- showDialog() {
- prompt.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 => {
- console.info('showDialog error: ' + err);
- })
+ ```js
+prompt.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 => {
+ console.info('showDialog error: ' + err);
+ })
```
## prompt.showDialog
showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSuccessResponse>):void
-Shows a dialog box. This API uses a callback to return the result asynchronously.
+Shows a dialog box. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
@@ -112,32 +104,27 @@ Shows a dialog box. This API uses a callback to return the result asynchronously
| callback | AsyncCallback<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | Yes | Callback used to return the dialog box response result. |
**Example**
- ```
- export default {
- callback(err, data) {
- if(err) {
- console.info('showDialog err: ' + err);
- return;
- }
- console.info('showDialog success callback, click button: ' + data.index);
+ ```js
+prompt.showDialog({
+ title: 'showDialog Title Info',
+ message: 'Message Info',
+ buttons: [
+ {
+ text: 'button1',
+ color: '#000000',
},
- showDialog() {
- prompt.showDialog({
- title: 'showDialog Title Info',
- message: 'Message Info',
- buttons: [
- {
- text: 'button1',
- color: '#000000',
- },
- {
- text: 'button2',
- color: '#000000',
- }
- ]
- }, this.callback);
+ {
+ text: 'button2',
+ color: '#000000',
}
+ ]
+}, (err, data) => {
+ if (err) {
+ console.info('showDialog err: ' + err);
+ return;
}
+ console.info('showDialog success callback, click button: ' + data.index);
+});
```
## ShowDialogOptions
@@ -146,11 +133,11 @@ Describes the options for showing the dialog box.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| ------- | ------ | ---- | ---------------------------------------- |
-| title | string | No | Title of the text to display. |
-| message | string | No | Text body. |
-| buttons | Array | No | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. One to three buttons are supported. The first button is of the **positiveButton** type, the second is of the **negativeButton** type, and the third is of the **neutralButton** type.|
+| Name | Type | Mandatory | Description |
+| ------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| title | string\| [Resource](.../ui/ts-types.md#resource-type)9+| No | Title of the dialog box. |
+| message | string\| [Resource](.../ui/ts-types.md#resource-type)9+| No | Text body. |
+| buttons | Array | No | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. Up to three buttons are supported. The first button is of the **positiveButton** type, the second is of the **negativeButton** type, and the third is of the **neutralButton** type.|
## ShowDialogSuccessResponse
@@ -160,7 +147,7 @@ Describes the dialog box response result.
| Name | Type | Description |
| ----- | ------ | ------------------- |
-| index | number | Index of the selected button in the array.|
+| index | number | Index of the selected button in the **buttons** array.|
## prompt.showActionMenu
@@ -179,36 +166,31 @@ Shows an action menu. This API uses a callback to return the result asynchronous
**Example**
- ```
- export default {
- callback(err, data) {
- if(err) {
- console.info('showActionMenu err: ' + err);
- return;
- }
- console.info('showActionMenu success callback, click button: ' + data.index);
+ ```js
+prompt.showActionMenu({
+ title: 'Title Info',
+ buttons: [
+ {
+ text: 'item1',
+ color: '#666666',
},
- showActionMenu() {
- prompt.showActionMenu({
- title: 'Title Info',
- buttons: [
- {
- text: 'item1',
- color: '#666666',
- },
- {
- text: 'item2',
- color: '#000000',
- },
- ]
- }, this.callback)
- }
+ {
+ text: 'item2',
+ color: '#000000',
+ },
+ ]
+}, (err, data) => {
+ if (err) {
+ console.info('showActionMenu err: ' + err);
+ return;
}
+ console.info('showActionMenu success callback, click button: ' + data.index);
+})
```
## prompt.showActionMenu
-showActionMenu(options: ActionMenuOptions): Promise\
+showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse>
Shows an action menu. This API uses a promise to return the result synchronously.
@@ -225,30 +207,26 @@ Shows an action menu. This API uses a promise to return the result synchronously
| Promise<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | Promise used to return the action menu response result.|
**Example**
- ```
- export default {
- showActionMenu() {
- prompt.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 => {
- console.info('showActionMenu error: ' + err);
- })
- }
- }
+ ```js
+prompt.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 => {
+ console.info('showActionMenu error: ' + err);
+ })
```
## ActionMenuOptions
@@ -256,10 +234,10 @@ Describes the options for showing the action menu.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| ------- | ------ | ---- | ---------------------------------------- |
-| title | string | No | Title of the text to display. |
-| buttons | Array | Yes | Array of menu items. The array structure is **{text:'button', color: '\#666666'}**. One to six items are supported. If there are more than six items, extra items will not be displayed.|
+| Name | Type | Mandatory | Description |
+| ------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| title | string\| [Resource](.../ui/ts-types.md#resource-type)9+| No | Title of the text to display. |
+| buttons | Array<[Button](#button)> | Yes | Array of menu item buttons. The array structure is **{text:'button', color: '\#666666'}**. Up to six buttons are supported. If there are more than six buttons, extra buttons will not be displayed.|
## ActionMenuSuccessResponse
@@ -269,4 +247,15 @@ Describes the action menu response result.
| Name | Type | Mandatory | Description |
| ----- | ------ | ---- | ------------------------ |
-| index | number | No | Index of the selected button in the array, starting from **0**.|
+| index | number | No | Index of the selected button in the **buttons** array, starting from **0**.|
+
+## Button
+
+Describes the menu item button in the action menu.
+
+**System capability**: SystemCapability.ArkUI.ArkUI.Full
+
+| Name | Type | Mandatory | Description |
+| ----- | ---------------------------------------- | ---- | ------- |
+| text | string\| [Resource](.../ui/ts-types.md#resource-type)9+| Yes | Button text.|
+| color | string\| [Resource](.../ui/ts-types.md#resource-type)9+| Yes | Text color of the button.|