Skip to content

fix(modal): stop Escape propagation by default #2319

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

Merged
asblanco merged 3 commits into from
Jul 8, 2026
Merged

fix(modal): stop Escape propagation by default #2319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cad6bb
fix(modal): stop Escape propagation by default
asblanco Jul 8, 2026
732aef2
Remove prop
asblanco Jul 8, 2026
7e44969
Cleanup unneeded preventDefault
asblanco Jul 8, 2026
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
6 changes: 4 additions & 2 deletions packages/stacks-svelte/src/components/Modal/Modal.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,10 @@
}
};

const keyPress = (e: KeyboardEvent) => {
if (e.key === "Escape") {
const keyPress = (event: KeyboardEvent) => {
if (event.key === "Escape" && visible) {
event.stopImmediatePropagation();

close();
}
};
Expand Down
30 changes: 30 additions & 0 deletions packages/stacks-svelte/src/components/Modal/Modal.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,36 @@ describe("Modal", () => {
expectModalVisible(false);
});

it("should stop esc press propagation when closing a visible modal", async () => {
const laterWindowListener = sinon.spy();
render(Modal, { id: "test-modal", visible: true });
window.addEventListener("keydown", laterWindowListener);

try {
await userEvent.keyboard("{Escape}");

expectModalVisible(false);
expect(laterWindowListener).not.to.have.been.called;
} finally {
window.removeEventListener("keydown", laterWindowListener);
}
});

it("should not stop esc press propagation when modal is not visible", async () => {
const laterWindowListener = sinon.spy();
render(Modal, { id: "test-modal", visible: false });
window.addEventListener("keydown", laterWindowListener);

try {
await userEvent.keyboard("{Escape}");

expectModalVisible(false);
expect(laterWindowListener).to.have.been.calledOnce;
} finally {
window.removeEventListener("keydown", laterWindowListener);
}
});

it("should emit close event on close when modal is visible", async () => {
const onClose = sinon.spy();
render(Modal, {
Expand Down
Loading