Skip to content

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

UX: Skip keyboard shortcuts, chat drawer while on wizard (#42745)

Penar Musaraj7f60c555b2ba
diff --git a/frontend/discourse/app/routes/wizard.js b/frontend/discourse/app/routes/wizard.js
index 4134a80bece..4538ea61f31 100644
--- a/frontend/discourse/app/routes/wizard.js
+++ b/frontend/discourse/app/routes/wizard.js
@@ -4,6 +4,7 @@ import Wizard from "discourse/static/wizard/models/wizard";
export default class WizardRoute extends Route {
@service a11y;
+ @service keyboardShortcuts;
model() {
return Wizard.load();
@@ -20,6 +21,7 @@ export default class WizardRoute extends Route {
});
this.a11y.showSkipLinks = false;
+ this.keyboardShortcuts.pause();
}
deactivate() {
@@ -33,5 +35,6 @@ export default class WizardRoute extends Route {
});
this.a11y.showSkipLinks = true;
+ this.keyboardShortcuts.unpause();
}
}
diff --git a/frontend/discourse/tests/acceptance/wizard-test.js b/frontend/discourse/tests/acceptance/wizard-test.js
index e27f71edecb..c7c86d70e67 100644
--- a/frontend/discourse/tests/acceptance/wizard-test.js
+++ b/frontend/discourse/tests/acceptance/wizard-test.js
@@ -1,5 +1,6 @@
-import { currentRouteName, visit } from "@ember/test-helpers";
+import { currentRouteName, triggerKeyEvent, visit } from "@ember/test-helpers";
import { test } from "qunit";
+import { withPluginApi } from "discourse/lib/plugin-api";
import { acceptance } from "discourse/tests/helpers/qunit-helpers";
acceptance("Wizard", function (needs) {
@@ -13,4 +14,24 @@ acceptance("Wizard", function (needs) {
.doesNotExist("header is not rendered on wizard pages");
assert.strictEqual(currentRouteName(), "wizard.step");
});
+
+ test("custom keyboard shortcuts are disabled while the wizard is active", async function (assert) {
+ let shortcutTriggered = false;
+ withPluginApi((api) => {
+ api.addKeyboardShortcut("]", () => (shortcutTriggered = true));
+ });
+
+ await visit("/wizard");
+ await triggerKeyEvent(document, "keypress", "]".charCodeAt(0));
+
+ assert.false(shortcutTriggered, "the custom shortcut does not run");
+
+ await visit("/");
+ await triggerKeyEvent(document, "keypress", "]".charCodeAt(0));
+
+ assert.true(
+ shortcutTriggered,
+ "the custom shortcut runs outside the wizard"
+ );
+ });
});
diff --git a/plugins/chat/assets/javascripts/discourse/connectors/below-footer/chat-drawer-outlet.gjs b/plugins/chat/assets/javascripts/discourse/connectors/below-footer/chat-drawer-outlet.gjs
index df9d881e14e..0a14ff34fe0 100644
--- a/plugins/chat/assets/javascripts/discourse/connectors/below-footer/chat-drawer-outlet.gjs
+++ b/plugins/chat/assets/javascripts/discourse/connectors/below-footer/chat-drawer-outlet.gjs
@@ -1,11 +1,19 @@
+import Component from "@glimmer/component";
+import { service } from "@ember/service";
import ChatDrawer from "../../components/chat-drawer";
-const ChatDrawerOutlet = <template>
- <div class="below-footer-outlet chat-drawer-outlet">
- <div class="chat-drawer-outlet-container">
- <ChatDrawer />
- </div>
- </div>
-</template>;
+class ChatDrawerOutlet extends Component {
+ @service chatStateManager;
+
+ <template>
+ {{#if this.chatStateManager.canInteract}}
+ <div class="below-footer-outlet chat-drawer-outlet">
+ <div class="chat-drawer-outlet-container">
+ <ChatDrawer />
+ </div>
+ </div>
+ {{/if}}
+ </template>
+}
export default ChatDrawerOutlet;
diff --git a/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js b/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js
index bc4c669adda..cc8e4386103 100644
--- a/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js
+++ b/plugins/chat/assets/javascripts/discourse/services/chat-state-manager.js
@@ -166,6 +166,11 @@ export default class ChatStateManager extends Service {
return this.isFullPageActive || this.isDrawerActive;
}
+ get canInteract() {
+ const routeName = this.router.currentRouteName;
+ return routeName !== "wizard" && !routeName?.startsWith("wizard.");
+ }
+
get isDrawerCollapsed() {
return this.isDrawerActive && !this.isDrawerExpanded;
}
diff --git a/plugins/chat/test/javascripts/acceptance/chat-wizard-test.js b/plugins/chat/test/javascripts/acceptance/chat-wizard-test.js
new file mode 100644
index 00000000000..8dec22db2b1
--- /dev/null
+++ b/plugins/chat/test/javascripts/acceptance/chat-wizard-test.js
@@ -0,0 +1,43 @@
+import { getOwner } from "@ember/owner";
+import { settled, triggerKeyEvent, visit } from "@ember/test-helpers";
+import { test } from "qunit";
+import {
+ acceptance,
+ metaModifier,
+} from "discourse/tests/helpers/qunit-helpers";
+
+acceptance("Chat | Wizard", function (needs) {
+ needs.user({ has_chat_enabled: true });
+ needs.settings({ chat_enabled: true });
+ needs.pretender((server, helper) => {
+ server.get("/chat/api/me/channels", () =>
+ helper.response({
+ direct_message_channels: [],
+ public_channels: [],
+ meta: { message_bus_last_ids: {} },
+ tracking: {},
+ })
+ );
+ });
+
+ test("chat cannot be interacted with", async function (assert) {
+ await visit("/wizard");
+
+ const chatStateManager = getOwner(this).lookup(
+ "service:chat-state-manager"
+ );
+ chatStateManager.isDrawerActive = true;
+ chatStateManager.isDrawerExpanded = true;
+ await settled();
+
+ assert
+ .dom(".chat-drawer-outlet")
+ .doesNotExist("an active chat drawer is not rendered");
+
+ await triggerKeyEvent(document, "keydown", "K", metaModifier);
+
+ assert
+ .dom(".chat-modal-new-message")
+ .doesNotExist("the quick channel selector cannot be opened");
+ });
+});