閱讀(1.7k) 書(shū)簽贊(0) 我要糾錯(cuò)

彈窗

2024-01-23 13:11 更新

創(chuàng)建并顯示文本提示框、對(duì)話框和操作菜單。

說(shuō)明

本模塊首批接口從API version 9開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

該模塊不支持在UIAbility的文件聲明處使用，即不能在UIAbility的生命周期中調(diào)用，需要在創(chuàng)建組件實(shí)例后使用。

導(dǎo)入模塊


import promptAction from '@ohos.promptAction'

promptAction.showToast

showToast(options: ShowToastOptions): void

創(chuàng)建并顯示文本提示框。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

參數(shù)名	類(lèi)型	必填	說(shuō)明
options	ShowToastOptions	是	文本彈窗選項(xiàng)。

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)ohos.promptAction(彈窗)錯(cuò)誤碼。

錯(cuò)誤碼ID	錯(cuò)誤信息
100001	if UI execution context not found.

示例：


try {
  promptAction.showToast({            
    message: 'Message Info',
    duration: 2000,      
  });
} catch (error) {
  console.error(`showToast args error code is ${error.code}, message is ${error.message}`);
};

ShowToastOptions

文本提示框的選項(xiàng)。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full。

名稱	類(lèi)型	必填	說(shuō)明
message	string\| Resource9+	是	顯示的文本信息。默認(rèn)字體為'Harmony Sans'，不支持設(shè)置其他字體。
duration	number	否	默認(rèn)值1500ms，取值區(qū)間：1500ms-10000ms。若小于1500ms則取默認(rèn)值，若大于10000ms則取上限值10000ms。
bottom	string\| number	否	設(shè)置彈窗邊框距離屏幕底部的位置。

promptAction.showDialog

showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>

創(chuàng)建并顯示對(duì)話框，對(duì)話框響應(yīng)后同步返回結(jié)果。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

參數(shù)名	類(lèi)型	必填	說(shuō)明
options	ShowDialogOptions	是	對(duì)話框選項(xiàng)。

返回值：

類(lèi)型	說(shuō)明
Promise<ShowDialogSuccessResponse>	對(duì)話框響應(yīng)結(jié)果。

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)ohos.promptAction(彈窗)錯(cuò)誤碼。

錯(cuò)誤碼ID	錯(cuò)誤信息
100001	if UI execution context not found.

示例：


try {
  promptAction.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);
    })
} catch (error) {
  console.error(`showDialog args error code is ${error.code}, message is ${error.message}`);
};

promptAction.showDialog

showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSuccessResponse>):void

創(chuàng)建并顯示對(duì)話框，對(duì)話框響應(yīng)結(jié)果異步返回。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

參數(shù)名	類(lèi)型	必填	說(shuō)明
options	ShowDialogOptions	是	頁(yè)面顯示對(duì)話框信息描述。
callback	AsyncCallback<ShowDialogSuccessResponse>	是	對(duì)話框響應(yīng)結(jié)果回調(diào)。

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)ohos.promptAction(彈窗)錯(cuò)誤碼。

錯(cuò)誤碼ID	錯(cuò)誤信息
100001	if UI execution context not found.

示例：


try {
  promptAction.showDialog({
    title: 'showDialog Title Info',
    message: 'Message Info',
    buttons: [
      {
        text: 'button1',
        color: '#000000',
      },
      {
        text: 'button2',
        color: '#000000',
      }
    ]
  }, (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}`);
};

ShowDialogOptions

對(duì)話框的選項(xiàng)。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

名稱	類(lèi)型	必填	說(shuō)明
title	string\| Resource9+	否	標(biāo)題文本。
message	string\| Resource9+	否	內(nèi)容文本。
buttons	[Button,Button?,Button?]	否	對(duì)話框中按鈕的數(shù)組，結(jié)構(gòu)為：{text:'button', color: '#666666'}，支持1-3個(gè)按鈕。其中第一個(gè)為positiveButton；第二個(gè)為negativeButton；第三個(gè)為neutralButton。

ShowDialogSuccessResponse

對(duì)話框的響應(yīng)結(jié)果。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

名稱	類(lèi)型	必填	說(shuō)明
index	number	否	選中按鈕在buttons數(shù)組中的索引。

promptAction.showActionMenu

showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenuSuccessResponse>):void

創(chuàng)建并顯示操作菜單，菜單響應(yīng)結(jié)果異步返回。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full。

參數(shù)：

參數(shù)名	類(lèi)型	必填	說(shuō)明
options	ActionMenuOptions	是	操作菜單選項(xiàng)。
callback	AsyncCallback<ActionMenuSuccessResponse>	是	菜單響應(yīng)結(jié)果回調(diào)。

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)ohos.promptAction(彈窗)錯(cuò)誤碼。

錯(cuò)誤碼ID	錯(cuò)誤信息
100001	if UI execution context not found.

示例：


try {
  promptAction.showActionMenu({
    title: 'Title Info',
    buttons: [
      {
        text: 'item1',
        color: '#666666',
      },
      {
        text: 'item2',
        color: '#000000',
      },
    ]
  }, (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}`);
};

promptAction.showActionMenu

showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse>

創(chuàng)建并顯示操作菜單，菜單響應(yīng)后同步返回結(jié)果。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

參數(shù)名	類(lèi)型	必填	說(shuō)明
options	ActionMenuOptions	是	操作菜單選項(xiàng)。

返回值：

類(lèi)型	說(shuō)明
Promise<ActionMenuSuccessResponse>	菜單響應(yīng)結(jié)果。

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)ohos.promptAction(彈窗)錯(cuò)誤碼。

錯(cuò)誤碼ID	錯(cuò)誤信息
100001	if UI execution context not found.

示例：


try {
  promptAction.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);
    })
} catch (error) {
  console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`);
};

ActionMenuOptions

操作菜單的選項(xiàng)。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full。

名稱	類(lèi)型	必填	說(shuō)明
title	string\| Resource9+	否	標(biāo)題文本。
buttons	[Button,Button?,Button?,Button?,Button?,Button?]	是	菜單中菜單項(xiàng)按鈕的數(shù)組，結(jié)構(gòu)為：{text:'button', color: '#666666'}，支持1-6個(gè)按鈕。大于6個(gè)按鈕時(shí)彈窗不顯示。

ActionMenuSuccessResponse

操作菜單的響應(yīng)結(jié)果。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

名稱	類(lèi)型	必填	說(shuō)明
index	number	否	選中按鈕在buttons數(shù)組中的索引，從0開(kāi)始。

Button

菜單中的菜單項(xiàng)按鈕。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

名稱	類(lèi)型	必填	說(shuō)明
text	string\| Resource9+	是	按鈕文本內(nèi)容。
color	string\| Resource9+	是	按鈕文本顏色。

以上內(nèi)容是否對(duì)您有幫助：

← 媒體查詢

頁(yè)面路由 →

寫(xiě)筆記

我要補(bǔ)充

彈窗

導(dǎo)入模塊

promptAction.showToast

ShowToastOptions

promptAction.showDialog

promptAction.showDialog

ShowDialogOptions

ShowDialogSuccessResponse

promptAction.showActionMenu

promptAction.showActionMenu

ActionMenuOptions

ActionMenuSuccessResponse

Button

推薦文章

推薦教程

推薦課程