Skip to content

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

UX: Add shortcut to add details block in RTE (#42496)

Martin Brennanba49af106e53
diff --git a/plugins/discourse-details/assets/javascripts/initializers/apply-details.js b/plugins/discourse-details/assets/javascripts/initializers/apply-details.js
index a20c463b6de..4e117d5d9dd 100644
--- a/plugins/discourse-details/assets/javascripts/initializers/apply-details.js
+++ b/plugins/discourse-details/assets/javascripts/initializers/apply-details.js
@@ -14,6 +14,8 @@ function initializeDetails(api) {
},
icon: "angle-right",
label: "details.title",
+ name: "details",
+ shortcut: "Shift+D",
});
api.registerRichEditorExtension(richEditorExtension);
diff --git a/plugins/discourse-details/spec/system/details_spec.rb b/plugins/discourse-details/spec/system/details_spec.rb
index 6b799c73a06..1353415a0af 100644
--- a/plugins/discourse-details/spec/system/details_spec.rb
+++ b/plugins/discourse-details/spec/system/details_spec.rb
@@ -13,7 +13,7 @@ describe "Details button" do
visit("/new-topic")
composer.fill_content("test :+1:").toggle_rich_editor.select_all
find(".toolbar-menu__options-trigger").click
- find("button[title='Hide details']").click
+ find("button[data-name='details']").click
expect(rich).to have_css(
"details img.emoji[src=\"/images/emoji/twitter/+1.png?v=#{Emoji::EMOJI_VERSION}\"]",
diff --git a/plugins/discourse-details/test/javascripts/acceptance/details-button-test.js b/plugins/discourse-details/test/javascripts/acceptance/details-button-test.js
index d3843711591..0ac8273a560 100644
--- a/plugins/discourse-details/test/javascripts/acceptance/details-button-test.js
+++ b/plugins/discourse-details/test/javascripts/acceptance/details-button-test.js
@@ -1,6 +1,17 @@
-import { click, fillIn, find, visit } from "@ember/test-helpers";
+import {
+ click,
+ fillIn,
+ find,
+ triggerKeyEvent,
+ visit,
+} from "@ember/test-helpers";
import { test } from "qunit";
-import { acceptance } from "discourse/tests/helpers/qunit-helpers";
+import { translateModKey } from "discourse/lib/utilities";
+import { PLATFORM_KEY_MODIFIER } from "discourse/services/keyboard-shortcuts";
+import {
+ acceptance,
+ metaModifier,
+} from "discourse/tests/helpers/qunit-helpers";
import selectKit from "discourse/tests/helpers/select-kit-helper";
import { i18n } from "discourse-i18n";
@@ -15,7 +26,7 @@ acceptance("Details Button", function (needs) {
await categoryChooser.selectRowByValue(2);
await click(".toolbar-menu__options-trigger");
- await click(`button[title="${i18n("details.title")}"]`);
+ await click("[data-name='details']");
assert
.dom(".d-editor-input")
@@ -33,7 +44,7 @@ acceptance("Details Button", function (needs) {
textarea.selectionEnd = textarea.value.length;
await click(".toolbar-menu__options-trigger");
- await click(`button[title="${i18n("details.title")}"]`);
+ await click("[data-name='details']");
assert
.dom(".d-editor-input")
@@ -61,7 +72,7 @@ acceptance("Details Button", function (needs) {
textarea.selectionEnd = 28;
await click(".toolbar-menu__options-trigger");
- await click(`button[title="${i18n("details.title")}"]`);
+ await click("[data-name='details']");
assert
.dom(".d-editor-input")
@@ -89,7 +100,7 @@ acceptance("Details Button", function (needs) {
textarea.selectionEnd = 29;
await click(".toolbar-menu__options-trigger");
- await click(`button[title="${i18n("details.title")}"]`);
+ await click("[data-name='details']");
assert
.dom(".d-editor-input")
@@ -127,7 +138,7 @@ acceptance("Details Button", function (needs) {
textarea.selectionEnd = textarea.value.length;
await click(".toolbar-menu__options-trigger");
- await click(`button[title="${i18n("details.title")}"]`);
+ await click("[data-name='details']");
assert
.dom(".d-editor-input")
@@ -138,4 +149,41 @@ acceptance("Details Button", function (needs) {
"contains the right output"
);
});
+
+ test("details button displays its keyboard shortcut", async function (assert) {
+ await visit("/");
+ await click("#create-topic");
+
+ await click(".toolbar-menu__options-trigger");
+
+ const separator = PLATFORM_KEY_MODIFIER === "meta" ? "" : " ";
+ assert
+ .dom("[data-name='details'] kbd")
+ .hasText(
+ translateModKey(`${PLATFORM_KEY_MODIFIER}+Shift+D`, separator),
+ "shows the platform-specific shortcut"
+ );
+ });
+
+ test("keyboard shortcut inserts a details block in the rich text editor", async function (assert) {
+ await visit("/");
+ await click("#create-topic");
+ const categoryChooser = selectKit(".category-chooser");
+ await categoryChooser.expand();
+ await categoryChooser.selectRowByValue(2);
+ await click(".composer-toggle-switch");
+
+ await triggerKeyEvent(".ProseMirror", "keydown", "D", {
+ ...metaModifier,
+ shiftKey: true,
+ });
+
+ assert.dom(".d-editor-input details").exists("inserts a details block");
+ assert
+ .dom(".d-editor-input details summary")
+ .hasText(i18n("composer.details_title"), "inserts the default summary");
+ assert
+ .dom(".d-editor-input details p")
+ .hasText(i18n("composer.details_text"), "inserts the default body");
+ });
});