js-apis-system-prompt.md 5.7 KB
Newer Older
Z
zengyawen 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# 弹窗

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块


```
import prompt from '@system.prompt';
```

## prompt.showToast

16
showToast(options: ShowToastOptions): void
Z
zengyawen 已提交
17 18 19 20 21 22 23 24 25

显示文本弹窗。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
26
| options | [ShowToastOptions](#showtoastoptions) | 是 | 定义ShowToast的选项。 |
Z
zengyawen 已提交
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

**示例:** 

```
export default {    
  showToast() {        
    prompt.showToast({            
      message: 'Message Info',            
      duration: 2000,        
    });    
  }
}
```


## prompt.showDialog

44
showDialog(options: ShowDialogOptions): void
Z
zengyawen 已提交
45

46
显示对话框。
Z
zengyawen 已提交
47 48 49 50 51 52 53

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
54
| options | [ShowDialogOptions](#showdialogoptions) | 是 | 定义显示对话框的选项。|
Z
zengyawen 已提交
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


**示例:**

```
export default {    
  showDialog() {       
    prompt.showDialog({           
      title: 'Title Info',            
      message: 'Message Info',           
      buttons: [                
        {                    
           text: 'button',                   
           color: '#666666',                
         },            
       ],            
       success: function(data) {                
         console.log('dialog success callback,click button : ' + data.index);            
       },            
       cancel: function() {                
         console.log('dialog cancel callback');            
       },
     });    
  }
}
```

## prompt.showActionMenu<sup>6+</sup>

84
showActionMenu(options: ShowActionMenuOptions): void
Z
zengyawen 已提交
85 86 87 88 89 90 91 92 93

显示操作菜单。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
94
| options | [ShowActionMenuOptions](#showactionmenuoptions) | 是 | 定义ShowActionMenu的选项。 |
Z
zengyawen 已提交
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122


**示例:**

```
export default {    
  showActionMenu() {        
    prompt.showActionMenu({            
      title: 'Title Info',            
      buttons: [                
        {                    
          text: 'item1',                    
          color: '#666666',                
        },                
        {                    
           text: 'item2',                    
           color: '#000000',                
        },            
      ],            
      success: function(data) {                
        console.log('dialog success callback,click button : ' + data.tapIndex);            
      },            
      fail: function(data) {                
        console.log('dialog fail callback' + data.errMsg);            
      },       
    });    
  }
}
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
```
## ShowToastOptions

定义ShowToast的选项。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| message | string | 是 | 显示的文本信息。 |
| duration | number | 否 | 默认值1500ms,建议区间:1500ms-10000ms。若小于1500ms则取默认值,最大取值为10000ms。 |
| bottom<sup>5+</sup> | string\|number| 否 | 设置弹窗边框距离屏幕底部的位置,仅手机和平板设备支持。 |

## Button

定义按钮的提示信息。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 定义按钮信息。 |
| color | string | 是 | 定义按钮颜色。 |

## ShowDialogSuccessResponse

定义ShowDialog的响应。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 定义数据的索引信息。 |

## ShowDialogOptions

定义显示对话框的选项。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| title | string | 否 | 标题文本。 |
| message | string | 否 | 文本内容。 |
| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?] | 否 | 对话框中按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 |
| success | (data: [ShowDialogSuccessResponse](#showdialogsuccessresponse)) => void | 否 | 接口调用成功的回调函数。 |
| cancel | (data: string, code: string) => void | 否 | 接口调用失败的回调函数。 |
| complete | (data: string) => void | 否 | 接口调用结束的回调函数。 |

## ShowActionMenuOptions<sup>6+</sup>

定义ShowActionMenu的选项。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| title | string | 否 | 标题文本。 |
| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?] | 是 | 对话框中按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-6个按钮。|
| success | (tapIndex: number, errMsg: string) => void | 否 | 弹出对话框时调用。 |
| fail | (errMsg: string) => void | 否 | 接口调用失败的回调函数。 |
| complete | (data: string) => void | 否 | 关闭对话框时调用。 |