Skip to content

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

UX: Add Boards link to sidebar when boards_enabled (#45483)

Martin Brennan146e2e4c050f
diff --git a/plugins/boards/assets/javascripts/discourse/initializers/add-boards-to-community-section.js b/plugins/boards/assets/javascripts/discourse/initializers/add-boards-to-community-section.js
new file mode 100644
index 00000000000..08ab00dee92
--- /dev/null
+++ b/plugins/boards/assets/javascripts/discourse/initializers/add-boards-to-community-section.js
@@ -0,0 +1,23 @@
+import { withPluginApi } from "discourse/lib/plugin-api";
+import { i18n } from "discourse-i18n";
+
+export default {
+ name: "add-boards-to-community-section",
+
+ initialize(container) {
+ const siteSettings = container.lookup("service:site-settings");
+ if (!siteSettings.boards_enabled) {
+ return;
+ }
+
+ withPluginApi((api) => {
+ api.addCommunitySectionLink({
+ name: "boards",
+ route: "boards",
+ icon: "boards",
+ text: i18n("boards.manage.title"),
+ title: i18n("boards.manage.title"),
+ });
+ });
+ },
+};
diff --git a/plugins/boards/config/locales/server.en.yml b/plugins/boards/config/locales/server.en.yml
index 658ff75591a..ff32915354e 100644
--- a/plugins/boards/config/locales/server.en.yml
+++ b/plugins/boards/config/locales/server.en.yml
@@ -12,7 +12,7 @@ en:
acl_failed: "Could not create the board's access permissions. Check the selected groups and permissions."
failed: "Could not create the board."
site_settings:
- boards_enabled: "Organize topics, and lightweight standalone “floater” cards, into configurable, drag-and-drop kanban-style boards and columns, all with a purpose built management UI and per-board access control"
+ boards_enabled: "Organize topics, and lightweight standalone “floater” cards, into configurable, drag-and-drop kanban-style boards and columns, all with a purpose built management UI and per-board access control. Visit <a href='%{base_path}/boards'>/boards</a> to get started."
boards_manage_board_allowed_groups: "Groups allowed to create and configure boards."
access_control_list:
errors:
diff --git a/plugins/boards/test/javascripts/acceptance/boards-sidebar-test.js b/plugins/boards/test/javascripts/acceptance/boards-sidebar-test.js
new file mode 100644
index 00000000000..f96bb81a5ad
--- /dev/null
+++ b/plugins/boards/test/javascripts/acceptance/boards-sidebar-test.js
@@ -0,0 +1,60 @@
+import { click, currentURL, visit } from "@ember/test-helpers";
+import { test } from "qunit";
+import { acceptance } from "discourse/tests/helpers/qunit-helpers";
+import { i18n } from "discourse-i18n";
+
+const BOARDS_LINK =
+ '.sidebar-section[data-section-name="community"] .sidebar-section-link[data-link-name="boards"]';
+
+acceptance("Boards sidebar - enabled", function (needs) {
+ needs.user({ can_manage_boards: false });
+ needs.settings({ boards_enabled: true, navigation_menu: "sidebar" });
+ needs.pretender((server, helper) => {
+ server.get("/boards/api/boards.json", () =>
+ helper.response({ boards: [] })
+ );
+ });
+
+ test("links to boards for users without management permissions", async function (assert) {
+ await visit("/");
+
+ assert
+ .dom(BOARDS_LINK)
+ .hasText(i18n("boards.manage.title"), "displays the Boards label")
+ .hasAttribute("href", "/boards", "links to the boards index");
+ assert
+ .dom(`${BOARDS_LINK} .d-icon-boards`)
+ .exists("displays the Boards icon");
+
+ await click(BOARDS_LINK);
+
+ assert.strictEqual(currentURL(), "/boards", "opens the boards index");
+ });
+});
+
+acceptance("Boards sidebar - anonymous", function (needs) {
+ needs.settings({ boards_enabled: true, navigation_menu: "sidebar" });
+
+ test("shows the link to anonymous visitors", async function (assert) {
+ await visit("/");
+
+ assert
+ .dom(BOARDS_LINK)
+ .hasAttribute(
+ "href",
+ "/boards",
+ "anonymous visitors can discover boards"
+ );
+ });
+});
+
+acceptance("Boards sidebar - disabled", function (needs) {
+ needs.user();
+ needs.settings({ boards_enabled: false, navigation_menu: "sidebar" });
+
+ test("hides the link when boards are disabled", async function (assert) {
+ await visit("/");
+
+ assert.dom(BOARDS_LINK).doesNotExist("the Boards link is hidden");
+ });
+});