Skip to content

feat(overlay): add ESC key to dismiss overlay #5598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(overlay): add ESC key to dismiss overlay #5598

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f19839f
feat(overlay): add ESC key to dismiss overlay
saurabh007007 Oct 22, 2025
a7506a5
test(overlay): tests for ESC key dismiss feature also types in client…
saurabh007007 Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion client-src/overlay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,11 +644,29 @@ const createOverlay = (options) => {
}, trustedTypesPolicyName);
}

let handleEscapeKey;

const hideOverlayWithEscCleanup = () => {
window.removeEventListener("keydown", handleEscapeKey);
hide();
};

const overlayService = createOverlayMachine({
showOverlay: ({ level = "error", messages, messageSource }) =>
show(level, messages, options.trustedTypesPolicyName, messageSource),
hideOverlay: hide,
hideOverlay: hideOverlayWithEscCleanup,
});
/**
* ESC key press to dismiss the overlay.
* @param {KeyboardEvent} event Keydown event
*/
handleEscapeKey = (event) => {
if (event.key === "Escape" || event.key === "Esc" || event.keyCode === 27) {
overlayService.send({ type: "DISMISS" });
}
};

window.addEventListener("keydown", handleEscapeKey);

if (options.catchRuntimeError) {
/**
Expand Down