建立對話框
建立對話框。
對話框中顯示的內容可自訂。
此API是異步API。
如果要同步處理,請參閱以下頁面。
函數
電腦版
kintone.createDialog(config)
參數
| 參數名稱 | 類型 | 必須 | 說明 |
|---|---|---|---|
| config | 物件 | 必須 | 對話框設定 |
| config.title | 字串 | 可省略 | 標題字串 如果省略,則不會顯示。 |
| config.body | Element物件 | 可省略 | 對話框內文的元素 如果省略,則不會顯示。 |
| config.showOkButton | 布爾值 | 可省略 | 是否顯示OK按鈕
|
| config.okButtonText | 字串 | 可省略 | 要在[OK]按鈕上顯示的文字 如果省略,將根據登入使用者的語言顯示表示「OK」的文字。 |
| config.showCancelButton | 布爾值 | 可省略 | 是否顯示取消按鈕
|
| config.cancelButtonText | 字串 | 可省略 | 要在取消按鈕上顯示的文字 如果省略,將根據登入使用者的語言顯示表示「Cancel」的文字。 |
| config.showCloseButton | 布爾值 | 可省略 | 是否顯示關閉按鈕
如不顯示,則使用Esc鍵關閉對話框的功能也會被停用。 |
| config.beforeClose | 函數 | 可省略 | 在使用OK按鈕/取消按鈕/關閉按鈕/Esc鍵等方式之一關閉對話框之前執行的函數 使用者所選取的操作會作為引數傳入函式中。
false時,或在解析Promise後傳回為false的值時,不會關閉對話框。 |
返回值
返回值是Promise物件。
解析Promise物件後,可獲取到以下值:
| 返回值 | 類型 | 說明 |
|---|---|---|
| show | 函數 | 顯示所建立的對話框的非同步函數 無參數。 返回值是Promise物件。 關閉對話框會解析Promise物件,可獲取下列值:
|
| close | 函數 | 關閉對話框的函數 沒有引數和傳回值。 |
可使用的畫面
電腦版
可使用的畫面同整體自訂的套用畫面。
kintone整體自訂的套用畫面
但以下畫面不可用。
- 搜尋畫面
- 應用程式商城
- 插件設置畫面
注意事項
引數config.body中指定的Element物件將作為對話框的內文中的元素使用。
請依需要進行資料清理(sanitize)處理。