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