A platform for community discussion. Free, open, simple.
A11Y: improve sidebar and header landmarks, post controls role (#40079)
Kris912d40ff651a
diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex b91e5d96870..42b05e5da54 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -3708,6 +3708,7 @@ en:aria_label: filter by maximum viewshamburger_menu: "Navigation menu"+ header_panel: "Header"new_item: "new"go_back: "go back"not_logged_in_user: "user page with summary of current activity and preferences"@@ -4696,6 +4697,7 @@ en:few_likes_left: "Thanks for sharing the love! You only have a few likes left for today."controls:+ menu_label: "Post actions"reply: "begin composing a reply to this post"like_action: "Like"like: "like this post"diff --git a/frontend/discourse/app/components/header/contents.gjs b/frontend/discourse/app/components/header/contents.gjsindex 6b0d4f09f06..624a2ef3818 100644--- a/frontend/discourse/app/components/header/contents.gjs+++ b/frontend/discourse/app/components/header/contents.gjs@@ -4,6 +4,7 @@ import { ALL_PAGES_EXCLUDED_ROUTES } from "discourse/components/welcome-banner";import deprecatedOutletArgument from "discourse/helpers/deprecated-outlet-argument";import lazyHash from "discourse/helpers/lazy-hash";import { applyValueTransformer } from "discourse/lib/transformer";+import { i18n } from "discourse-i18n";import PluginOutlet from "../plugin-outlet";import HeaderSearch from "./header-search";import HomeLogo from "./home-logo";@@ -122,7 +123,11 @@ export default class Contents extends Component {}}/></div>- <div class="panel" role="navigation">{{yield}}</div>+ <div+ class="panel"+ role="navigation"+ aria-label={{i18n "header_panel"}}+ >{{yield}}</div><div class="after-header-panel-outlet"><PluginOutlet@name="after-header-panel"diff --git a/frontend/discourse/app/components/header/sidebar-toggle.gjs b/frontend/discourse/app/components/header/sidebar-toggle.gjsindex 4e5302fbc3d..f5a25840fa2 100644--- a/frontend/discourse/app/components/header/sidebar-toggle.gjs+++ b/frontend/discourse/app/components/header/sidebar-toggle.gjs@@ -1,6 +1,7 @@import Component from "@glimmer/component";import { on } from "@ember/modifier";import { action } from "@ember/object";+import { schedule } from "@ember/runloop";import { service } from "@ember/service";import dConcatClass from "discourse/ui-kit/helpers/d-concat-class";import dIcon from "discourse/ui-kit/helpers/d-icon";@@ -11,17 +12,20 @@ export default class SidebarToggle extends Component {@service navigationMenu;@action- toggleWithBlur(e) {+ toggle() {+ const wasHidden = !this.args.showSidebar;+if (this.navigationMenu.isDesktopDropdownMode) {this.args.toggleNavigationMenu("sidebar");} else {this.args.toggleNavigationMenu();}- // remove the focus of the header dropdown button after clicking- e.target.tagName.toLowerCase() === "button"- ? e.target.blur()- : e.target.closest("button").blur();+ if (wasHidden) {+ schedule("afterRender", () => {+ document.querySelector("#d-sidebar a, #d-sidebar button")?.focus();+ });+ }}<template>@@ -34,7 +38,7 @@ export default class SidebarToggle extends Component {}}aria-expanded={{if @showSidebar "true" "false"}}aria-controls="d-sidebar"- {{on "click" this.toggleWithBlur}}+ {{on "click" this.toggle}}>{{dIcon @icon}}</button>diff --git a/frontend/discourse/app/components/post.gjs b/frontend/discourse/app/components/post.gjsindex cfdde2bd62f..518ce9b98ce 100644--- a/frontend/discourse/app/components/post.gjs+++ b/frontend/discourse/app/components/post.gjs@@ -603,7 +603,11 @@ export default class Post extends Component {/>{{/if}}- <section class="post__menu-area post-menu-area clearfix">+ <section+ class="post__menu-area post-menu-area clearfix"+ role="group"+ aria-label={{i18n "post.controls.menu_label"}}+ ><PostMenu@post={{@post}}@prevPost={{@prevPost}}diff --git a/frontend/discourse/app/components/post/menu.gjs b/frontend/discourse/app/components/post/menu.gjsindex 87939a7cb15..913afd8638a 100644--- a/frontend/discourse/app/components/post/menu.gjs+++ b/frontend/discourse/app/components/post/menu.gjs@@ -636,6 +636,7 @@ export default class PostMenu extends Component {"replies-button-visible")}}+ role="none">{{! do not include PluginOutlets here, use the PostMenu DAG API instead }}{{#each this.extraControls key="key" as |extraControl|}}diff --git a/frontend/discourse/app/components/sidebar.gjs b/frontend/discourse/app/components/sidebar.gjsindex db3790c7a23..8d7c8490943 100644--- a/frontend/discourse/app/components/sidebar.gjs+++ b/frontend/discourse/app/components/sidebar.gjs@@ -7,6 +7,7 @@ import Sections from "discourse/components/sidebar/sections";import SwitchPanelButtons from "discourse/components/sidebar/switch-panel-buttons";import bodyClass from "discourse/helpers/body-class";import { bind } from "discourse/lib/decorators";+import { i18n } from "discourse-i18n";export default class Sidebar extends Component {@service site;@@ -71,7 +72,11 @@ export default class Sidebar extends Component {<template>{{bodyClass "has-sidebar-page"}}- <section id="d-sidebar" class="sidebar-container">+ <nav+ id="d-sidebar"+ class="sidebar-container"+ aria-label={{i18n "sidebar.title"}}+ >{{#if this.showSwitchPanelButtonsOnTop}}<SwitchPanelButtons @buttons={{this.switchPanelButtons}} />{{/if}}@@ -98,6 +103,6 @@ export default class Sidebar extends Component {{{/unless}}<Footer />- </section>+ </nav></template>}diff --git a/frontend/discourse/tests/acceptance/sidebar-user-test.js b/frontend/discourse/tests/acceptance/sidebar-user-test.jsindex cd8c9bdb63b..08187b0af76 100644--- a/frontend/discourse/tests/acceptance/sidebar-user-test.js+++ b/frontend/discourse/tests/acceptance/sidebar-user-test.js@@ -227,6 +227,14 @@ acceptance(test("accessibility of sidebar toggle", async function (assert) {await visit("/");+ assert+ .dom("nav#d-sidebar")+ .hasAttribute(+ "aria-label",+ i18n("sidebar.title"),+ "sidebar is exposed as a named navigation landmark"+ );+assert.dom(".btn-sidebar-toggle[aria-expanded='true'][aria-controls='d-sidebar']"@@ -260,6 +268,13 @@ acceptance(i18n("sidebar.title"),"has the right title attribute when sidebar is collapsed");++ await click(".btn-sidebar-toggle");++ assert.true(+ document.querySelector("#d-sidebar").contains(document.activeElement),+ "focus moves into the sidebar when it is opened via the toggle"+ );});});