requestCloseでdialogを閉じる前に確認を挟む
requestClose()は、cancelイベントを経てdialogを閉じるメソッドです。close()と違い、入力中ならpreventDefault()で閉じるのを止められます。Escキーとの違いとreturnValueも説明します。
- Chrome134
- Edge134
- Firefox139
- Safari18.4
はじめに
requestCloseメソッドは、<dialog>要素を閉じる前にcancelイベントを発火させるメソッドです。cancelイベントでpreventDefaultメソッドを呼ぶと、閉じるのを止められます。Firefox 139が対応して、Baseline 2025に入りました。
ダイアログは、closeメソッドや<form method="dialog">の送信で閉じられます。ただ、closeメソッドはcancelイベントを出さずにすぐ閉じるので、入力中なら閉じないといった確認を挟めません。
<dialog id="dialog">
<input id="name" />
<button type="button" id="close-button">閉じる</button>
</dialog>
<script>
const dialog = document.getElementById('dialog');
const input = document.getElementById('name');
dialog.addEventListener('cancel', (event) => {
// 入力中なら閉じない
if (input.value !== '') event.preventDefault();
});
document.getElementById('close-button').addEventListener('click', () => {
dialog.requestClose();
});
dialog.showModal();
</script>入力欄に文字があるうちは、閉じるを押してもダイアログは開いたままです。入力欄を空にしてから押すと閉じます。
HTMLDialogElement.requestClose
cancelイベントはrequestCloseメソッドの中で発火します。止めなければ、呼び出しから戻った時点でダイアログは閉じていて、closeイベントはその後に届きます。
<dialog>要素を開いた状態でEscapeキーを押したときも、requestCloseメソッドを呼んだときと同じくcancelイベントを経て閉じます。Invoker Commands APIのcommand="request-close"を付けたボタンからも呼べます。このボタンを押すとcancelイベントを経て閉じ、ボタンのvalue属性がreturnValueになります。
使用例
次のデモでは、名前の入力欄に文字があるあいだ、閉じるボタンでもEscapeキーでもダイアログを閉じられません。
<button type="button" id="open">ダイアログを開く</button>
<ul id="log"></ul>
<dialog id="dialog">
<form method="dialog">
<label>名前 <input id="name" /></label>
<button type="button" id="close">閉じる</button>
<button>送信</button>
</form>
</dialog>/* 開いたダイアログが収まる高さを取る */
body {
min-height: 10rem;
}const dialog = document.getElementById('dialog');
const input = document.getElementById('name');
const log = document.getElementById('log');
const addLog = (message) => {
const item = document.createElement('li');
item.textContent = message;
log.prepend(item);
};
dialog.addEventListener('cancel', (event) => {
addLog('cancel');
// 入力中なら閉じない
if (input.value !== '') event.preventDefault();
});
dialog.addEventListener('close', () => {
addLog('close');
input.value = '';
});
document.getElementById('open').addEventListener('click', () => {
dialog.showModal();
});
document.getElementById('close').addEventListener('click', () => {
dialog.requestClose();
});名前を入れたまま閉じるを押すと、ログにはcancelイベントの1行だけが増え、ダイアログは開いたままです。名前を消してから押すと、cancelイベントとcloseイベントの2行が増えて閉じます。
Escapeキーで閉じるときは、いつでも止められるわけではありません。Chromeでは、名前を入れたままEscapeキーを押すと、1回目は止まりますが、続けて押した2回目にはcancelableがfalseのcancelイベントが届いて閉じます。途中で文字を打ち足しても、2回目で閉じます。ページがEscapeキーで閉じるのを止め続けると、ユーザーがダイアログから抜け出せなくなるためです。閉じるボタンから呼んだrequestCloseメソッドのcancelイベントは、何度押しても止められます。
returnValue
closeメソッドと同じく、requestCloseメソッドにも文字列を渡せます。渡した文字列は、閉じたあとのreturnValueになります。
const requestClose = () => {
dialogElement.requestClose('some value');
};
dialogElement.addEventListener('cancel', () => {
// cancelの時点では、returnValueは前の値のまま
console.log('cancel:', dialogElement.returnValue);
});
dialogElement.addEventListener('close', () => {
// 閉じたあとは、requestCloseに渡した'some value'になる
console.log('close:', dialogElement.returnValue);
});cancelイベントの中のreturnValueは前の値(初めは空文字列)のままで、closeイベントでsome valueになります。cancelイベントでpreventDefaultメソッドを呼んで止めたときと、引数を渡さずに呼んだときは、returnValueは前の値のままです。
おわりに
requestCloseメソッドを使うと、閉じるボタンからもEscapeキーと同じくcancelイベントを経てダイアログを閉じられます。入力中なら閉じないといった確認を、cancelイベントの1か所にまとめられます。ただし、Escapeキーから来たcancelイベントは止められないことがある点に気をつけてください。