Skip to content

A platform for community discussion. Free, open, simple.

DEV: capture modal trigger element before async operations (#38630)

Isaac Janzen40b694fed4ed
diff --git a/frontend/discourse/app/services/modal.js b/frontend/discourse/app/services/modal.js
index b2eb9d9b5db..1d4ac38534b 100644
--- a/frontend/discourse/app/services/modal.js
+++ b/frontend/discourse/app/services/modal.js
@@ -61,6 +61,8 @@ export default class ModalService extends Service {
return;
}
+ const trigger = document.activeElement;
+
this.close({ initiatedBy: CLOSE_INITIATED_BY_MODAL_SHOW });
await waitForClosedKeyboard(this.site, this.capabilities);
@@ -72,7 +74,7 @@ export default class ModalService extends Service {
this.opts = opts ??= {};
this.activeModal = { component: modal, opts, resolveShowPromise };
- this.triggerElement = document.activeElement;
+ this.triggerElement = trigger;
const unsupportedOpts = Object.keys(opts).filter((key) =>
LEGACY_OPTS.has(key)
@@ -92,9 +94,9 @@ export default class ModalService extends Service {
this.activeModal?.resolveShowPromise?.(data);
this.activeModal = null;
this.opts = {};
- if (this.triggerElement) {
+ if (this.triggerElement?.isConnected) {
this.triggerElement.focus();
- this.triggerElement = null;
}
+ this.triggerElement = null;
}
}
diff --git a/frontend/discourse/tests/acceptance/modal-service-test.gjs b/frontend/discourse/tests/acceptance/modal-service-test.gjs
index aaefd680d35..c8081e2dd3b 100644
--- a/frontend/discourse/tests/acceptance/modal-service-test.gjs
+++ b/frontend/discourse/tests/acceptance/modal-service-test.gjs
@@ -203,5 +203,46 @@ acceptance("Modal service: component-based API", function () {
assert.dom(".d-modal").doesNotExist("all modals closed");
});
+ test("refocuses trigger element on close", async function (assert) {
+ await visit("/");
+
+ const modalService = getOwner(this).lookup("service:modal");
+
+ await click(".header-sidebar-toggle button");
+ const triggerElement = document.activeElement;
+
+ modalService.show(MyModalClass, { model: { text: "working" } });
+ await settled();
+ assert.dom(".d-modal").exists();
+
+ await click(".d-modal .modal-close");
+ assert.dom(".d-modal").doesNotExist();
+ assert.strictEqual(
+ document.activeElement,
+ triggerElement,
+ "focus returns to trigger element"
+ );
+ });
+
+ test("does not error when trigger element is removed from DOM", async function (assert) {
+ await visit("/");
+
+ const modalService = getOwner(this).lookup("service:modal");
+
+ const button = document.createElement("button");
+ button.className = "temporary-trigger";
+ document.body.appendChild(button);
+ button.focus();
+
+ modalService.show(MyModalClass, { model: { text: "working" } });
+ await settled();
+ assert.dom(".d-modal").exists();
+
+ button.remove();
+
+ await click(".d-modal .modal-close");
+ assert.dom(".d-modal").doesNotExist();
+ });
+
// (See also, `tests/integration/component/d-modal-test.js`)
});