Skip to content

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

FIX: Do not close modal when DMenu closes (#43035)

Martin Brennan54e3c2a56376
diff --git a/frontend/discourse/float-kit/lib/d-menu-instance.ts b/frontend/discourse/float-kit/lib/d-menu-instance.ts
index 2f71652eb04..ab8b6b898bf 100644
--- a/frontend/discourse/float-kit/lib/d-menu-instance.ts
+++ b/frontend/discourse/float-kit/lib/d-menu-instance.ts
@@ -13,18 +13,15 @@ import {
import FloatKitInstance from "discourse/float-kit/lib/float-kit-instance";
import type MenuService from "discourse/float-kit/services/menu";
import { animateClosing } from "discourse/lib/animation-utils";
-import type ModalService from "discourse/services/modal";
/**
* The concrete float instance backing a menu. It holds the menu's options,
* open/close state, and portal outlet, and implements the trigger and lifecycle
* hooks that `FloatKitInstance` orchestrates. A menu refocuses its trigger when
- * it closes and, on mobile, closes through the modal service when it was shown
- * as a modal.
+ * it closes.
*/
export default class DMenuInstance extends FloatKitInstance {
@service declare menu: MenuService;
- @service declare modal: ModalService;
/** Whether the menu is currently open. */
@tracked expanded = false;
@@ -116,10 +113,6 @@ export default class DMenuInstance extends FloatKitInstance {
await animateClosing(this.content);
- if (this.renderInModal && this.expanded) {
- await this.modal.close();
- }
-
await this.menu.close(this);
// A caller that closes without asking for the trigger to be refocused (a click outside,
diff --git a/frontend/discourse/tests/integration/components/float-kit/d-menu-test.gjs b/frontend/discourse/tests/integration/components/float-kit/d-menu-test.gjs
index 21564659afd..e5911a804f6 100644
--- a/frontend/discourse/tests/integration/components/float-kit/d-menu-test.gjs
+++ b/frontend/discourse/tests/integration/components/float-kit/d-menu-test.gjs
@@ -21,12 +21,25 @@ import DMenu from "discourse/float-kit/components/d-menu";
import DMenus from "discourse/float-kit/components/d-menus";
import DTooltips from "discourse/float-kit/components/d-tooltips";
import DMenuInstance from "discourse/float-kit/lib/d-menu-instance";
+import { getLockState } from "discourse/lib/body-scroll-lock";
import { forceMobile } from "discourse/lib/mobile";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import { eq } from "discourse/truth-helpers";
import DButton from "discourse/ui-kit/d-button";
+import DModal from "discourse/ui-kit/d-modal";
import dElement from "discourse/ui-kit/helpers/d-element";
+const ModalWithMenu = <template>
+ <DModal @closeModal={{@closeModal}} @inline={{true}}>
+ <span class="outer-modal-content">Outer modal</span>
+ <DMenu @inline={{true}} @modalForMobile={{true}} @label="Permission">
+ <:content as |menu|>
+ <DButton class="close-menu" @action={{menu.close}}>Viewer</DButton>
+ </:content>
+ </DMenu>
+ </DModal>
+</template>;
+
module("Integration | Component | FloatKit | DMenu", function (hooks) {
setupRenderingTest(hooks);
@@ -96,6 +109,57 @@ module("Integration | Component | FloatKit | DMenu", function (hooks) {
assert.dom(".fk-d-menu-modal[data-identifier='foo']").hasText("content");
});
+ test("closing a standalone mobile menu cleans up its modal", async function (assert) {
+ forceMobile();
+
+ const initialLockCount = getLockState().lockedNum;
+
+ await render(
+ <template>
+ <DMenu @inline={{true}} @modalForMobile={{true}} @label="Permission">
+ <:content as |menu|>
+ <DButton class="close-menu" @action={{menu.close}}>Viewer</DButton>
+ </:content>
+ </DMenu>
+ </template>
+ );
+
+ await open();
+
+ assert.strictEqual(
+ getLockState().lockedNum,
+ initialLockCount + 1,
+ "opening the menu locks body scrolling"
+ );
+
+ await click(".close-menu");
+
+ assert.dom(".fk-d-menu-modal").doesNotExist("the menu modal closes");
+ assert.strictEqual(
+ getLockState().lockedNum,
+ initialLockCount,
+ "closing the menu releases its body scroll lock"
+ );
+ });
+
+ test("closing a mobile menu preserves its containing modal", async function (assert) {
+ forceMobile();
+
+ await render(<template><ModalContainer /></template>);
+
+ const modal = getOwner(this).lookup("service:modal");
+ modal.show(ModalWithMenu);
+ await settled();
+
+ await open();
+ await click(".close-menu");
+
+ assert
+ .dom(".outer-modal-content")
+ .exists("the containing modal remains open");
+ assert.dom(".fk-d-menu-modal").doesNotExist("the menu modal closes");
+ });
+
test("DMenu uses a modal while DTooltip stays inline on mobile", async function (assert) {
forceMobile();
diff --git a/spec/system/page_objects/components/d_menu.rb b/spec/system/page_objects/components/d_menu.rb
index a425eef6a81..17a3832024b 100644
--- a/spec/system/page_objects/components/d_menu.rb
+++ b/spec/system/page_objects/components/d_menu.rb
@@ -37,7 +37,7 @@ module PageObjects
if @identifier.nil?
"#d-menu-portals"
else
- "#d-menu-portals [data-identifier=\"#{@identifier}\"]"
+ "[data-content][data-identifier=\"#{@identifier}\"]"
end
end