HTMLDialogElement: showModal() 方法

Baseline 已廣泛支援

此特性已經十分成熟,可在許多裝置和瀏覽器版本上使用。自 2022 年 3 月起,它已在各瀏覽器中可用。

HTMLDialogElement 介面的 showModal() 方法會以模態方式顯示對話方塊,覆蓋在其他任何可能存在的對話方塊之上。它會顯示在 頂層,並伴隨有一個 ::backdrop 偽元素。與對話方塊位於同一文件中的元素(除了對話方塊本身及其後代元素)將變為惰性(如同指定了 inert 屬性)。只有包含的文件會被阻止;如果對話方塊渲染在 iframe 中,頁面的其餘部分將保持互動狀態。

語法

js
showModal()

引數

無。

返回值

無(undefined)。

異常

InvalidStateError DOMException

如果對話方塊已開啟且非模態(即,如果對話方塊已使用 HTMLDialogElement.show() 開啟),則會丟擲此錯誤。

示例

開啟模態對話方塊

以下示例展示了一個按鈕,當點選該按鈕時,將透過 HTMLDialogElement.showModal() 函式開啟一個包含表單的模態 <dialog> 元素。開啟期間,除了模態對話方塊的內容外,其他所有內容都將處於惰性狀態。然後,您可以點選取消按鈕(透過 HTMLDialogElement.close() 函式)關閉對話方塊,或透過提交按鈕提交表單。選擇取消按鈕會關閉對話方塊,並觸發一個 close 事件,而不是 cancel 事件。

HTML

html
<!-- pop-up dialog box, containing a form -->
<dialog id="favDialog">
  <form method="dialog">
    <p>
      <label for="favAnimal">Favorite animal:</label>
      <select id="favAnimal" name="favAnimal">
        <option></option>
        <option>Brine shrimp</option>
        <option>Red panda</option>
        <option>Spider monkey</option>
      </select>
    </p>
    <div>
      <button id="cancel" type="reset">Cancel</button>
      <button type="submit">Confirm</button>
    </div>
  </form>
</dialog>

<div>
  <button id="updateDetails">Update details</button>
</div>

JavaScript

js
const updateButton = document.getElementById("updateDetails");
const cancelButton = document.getElementById("cancel");
const dialog = document.getElementById("favDialog");
dialog.returnValue = "favAnimal";

function openCheck(dialog) {
  if (dialog.open) {
    console.log("Dialog open");
  } else {
    console.log("Dialog closed");
  }
}

// Update button opens a modal dialog
updateButton.addEventListener("click", () => {
  dialog.showModal();
  openCheck(dialog);
});

// Form cancel button closes the dialog box
cancelButton.addEventListener("click", () => {
  dialog.close("animalNotChosen");
  openCheck(dialog);
});

結果

規範

規範
HTML
# dom-dialog-showmodal-dev

瀏覽器相容性

另見

  • 實現此介面的 HTML 元素:<dialog>