HTMLDialogElement: close() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2022.

The close() method of the HTMLDialogElement interface closes the

. An optional string may be passed as an argument, updating the returnValue of the dialog.

Syntax

js
close()
close(returnValue)

Parameters

returnValue Optional

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

Return value

None (undefined).

Examples

The following example shows a simple button that, when clicked, opens a

containing a form via the showModal() method. From there you can click the X button to close the dialog (via the HTMLDialogElement.close() method), or submit the form via the submit button.

html

If the "X" button was of type="submit", the dialog would have closed without requiring JavaScript. A form submission closes the

it is nested within if the form's method is dialog, so no "close" button is required.

Result

Specifications

Specification
HTML
# dom-dialog-close-dev

Browser compatibility

See also

  • The HTML element implementing this interface: .