大网数据广告活动
Web 标准与前端开发

HTMLDialogElement: requestClose() method

· 52CE 我爱测

The **`requestClose()`** method of the HTMLDialogElement interface requests to close the dialog. An optional string may be passed as an argument, updating the HTMLDialogElement.returnValue of the dialog.

HTML DOM

The requestClose() method of the HTMLDialogElement interface requests to close the dialog. An optional string may be passed as an argument, updating the HTMLDialogElement.returnValue of the dialog.

This method differs from HTMLDialogElement.close() in that it fires a HTMLDialogElement.cancel_event event before firing the HTMLDialogElement.close_event event. Authors can call Event.preventDefault() in the handler for the HTMLDialogElement.cancel_event event to prevent the dialog from closing.

This method exposes the same behavior as the dialog's internal close watcher.

Syntax

requestClose()
requestClose(returnValue)

Parameters

  • returnValue
    • : A string representing an updated value for the HTMLDialogElement.returnValue of the dialog.

Return value

None (undefined).

Examples

Using requestClose()

The following example shows a button that, when clicked, opens a dialog using the HTMLDialogElement.showModal() method. From there you can click the either Close button to call the requestClose() method and close the dialog.

The Close button closes the dialog without a HTMLDialogElement.returnValue, while the Close w/ return value button closes the dialog with a HTMLDialogElement.returnValue.

Preventing the dialog from closing is demonstrated with a checkbox.

HTML

<dialog id="dialog">
  <div>
    <label><input type="checkbox" id="prevent-close" /> Cancel close</label>
  </div>
  <button type="button" id="close">Close</button>
  <button type="button" id="close-w-value">Close w/ return value</button>
</dialog>

<button id="open">Open dialog</button>
<pre id="log"></pre>
#log {
  height: 170px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}
const logElement = document.getElementById("log");
function log(text) {
  logElement.innerText = `${logElement.innerText}${text}\n`;
  logElement.scrollTop = logElement.scrollHeight;
}
const dialog = document.getElementById("dialog");
const openButton = document.getElementById("open");
const closeButton = document.getElementById("close");
const closeWithValueButton = document.getElementById("close-w-value");
const preventCloseInput = document.getElementById("prevent-close");

// Open button opens a modal dialog
openButton.addEventListener("click", () => {
  // Reset the return value
  dialog.returnValue = "";
  // Show the dialog
  dialog.showModal();
});

// Close button closes the dialog box
closeButton.addEventListener("click", () => {
  dialog.requestClose();
});

// Close button closes the dialog box with a return value
closeWithValueButton.addEventListener("click", () => {
  dialog.requestClose("some value");
});

// Fired when requestClose() is called
// Prevent the dialog from closing by calling event.preventDefault()
dialog.addEventListener("cancel", (event) => {
  if (preventCloseInput.checked) {
    log("Dialog close canceled");
    event.preventDefault();
  }
});

// cancel event is not prevented, dialog will close
dialog.addEventListener("close", () => {
  log(`Dialog closed. Return value: "${dialog.returnValue}"`);
});

Result

Using requestClose()

Specifications

Browser compatibility

See also

  • HTML dialog element
  • The HTMLDialogElement.cancel_event event

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。