From 3b1353b00dbf22f8cdd608f04e40374c2cf11e98 Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Mon, 11 Aug 2025 15:31:43 +0200 Subject: [PATCH 1/7] fix: fixed header mobile menu accessibility risk: low JIRA: DP-3218 --- assets/scss/header.scss | 4 ++++ static/js/menu.js | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) diff --git a/assets/scss/header.scss b/assets/scss/header.scss index 0bd9eb9..26e71d2 100644 --- a/assets/scss/header.scss +++ b/assets/scss/header.scss @@ -39,6 +39,10 @@ align-items: center; padding: 0 20px; + &__menu { + overflow-y: auto; + } + &__first { top: 0; min-height: $header-first-nav-height; diff --git a/static/js/menu.js b/static/js/menu.js index 33417b6..adc0763 100644 --- a/static/js/menu.js +++ b/static/js/menu.js @@ -1,6 +1,7 @@ // (C) 2023 GoodData Corporation $(document).ready(function () { + // Side menu var menu = $(".gd-docs-menu"), menuActive = $(".gd-docs-menu-page.active"); @@ -36,4 +37,40 @@ $(document).ready(function () { $button.attr("aria-expanded", !isExpanded); }); + // Mobile header menu + var $mobileMenuTrigger = $("#gd-header-mobile-menu-trigger-input"); + var scrollPosition = 0; // Store scroll position + + $mobileMenuTrigger.on("change", function() { + var isChecked = $(this).is(":checked"); + + // Update aria-expanded for accessibility + $(this).attr("aria-expanded", isChecked); + + // Prevent body scrolling when menu is open + if (isChecked) { + // Save current scroll position + scrollPosition = window.pageYOffset || document.documentElement.scrollTop; + + // Menu is open - disable body scroll and maintain position + $("body").css({ + "overflow": "hidden", + "position": "fixed", + "top": -scrollPosition + "px", + "width": "100%" + }); + } else { + // Menu is closed - enable body scroll and restore position + $("body").css({ + "overflow": "", + "position": "", + "top": "", + "width": "" + }); + + // Restore scroll position + window.scrollTo(0, scrollPosition); + } + }); + }); \ No newline at end of file From 0d010ad4bda28a7fb91d0bf2a6baa7f6b6dedd1b Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Tue, 12 Aug 2025 10:57:57 +0200 Subject: [PATCH 2/7] feat: added tab navigation and more accessibility options risk: low JIRA: DP-3219 --- assets/scss/header.scss | 1 + layouts/partials/header-menu.html | 12 ++++++------ static/js/menu.js | 20 ++++++++++++++++---- 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/assets/scss/header.scss b/assets/scss/header.scss index 26e71d2..6f6b383 100644 --- a/assets/scss/header.scss +++ b/assets/scss/header.scss @@ -216,6 +216,7 @@ .gd-header-mobile-menu-trigger { margin-bottom: 0; + border: none; } .search-result-close-button { diff --git a/layouts/partials/header-menu.html b/layouts/partials/header-menu.html index 6988874..6b92fad 100644 --- a/layouts/partials/header-menu.html +++ b/layouts/partials/header-menu.html @@ -9,14 +9,14 @@
{{ if $mainMenu }} - - -
    + + + diff --git a/static/js/menu.js b/static/js/menu.js index adc0763..70c9661 100644 --- a/static/js/menu.js +++ b/static/js/menu.js @@ -39,13 +39,15 @@ $(document).ready(function () { }); // Mobile header menu var $mobileMenuTrigger = $("#gd-header-mobile-menu-trigger-input"); + var $mobileMenuLabel = $("label[for='gd-header-mobile-menu-trigger-input']"); var scrollPosition = 0; // Store scroll position - $mobileMenuTrigger.on("change", function() { - var isChecked = $(this).is(":checked"); + // Function to toggle menu state + function toggleMobileMenu() { + var isChecked = $mobileMenuTrigger.is(":checked"); // Update aria-expanded for accessibility - $(this).attr("aria-expanded", isChecked); + $mobileMenuTrigger.attr("aria-expanded", isChecked); // Prevent body scrolling when menu is open if (isChecked) { @@ -59,6 +61,7 @@ $(document).ready(function () { "top": -scrollPosition + "px", "width": "100%" }); + $mobileMenuTrigger.attr("aria-label", "Close navigation menu"); } else { // Menu is closed - enable body scroll and restore position $("body").css({ @@ -67,10 +70,19 @@ $(document).ready(function () { "top": "", "width": "" }); - + $mobileMenuTrigger.attr("aria-label", "Open navigation menu"); // Restore scroll position window.scrollTo(0, scrollPosition); } + } + + $mobileMenuTrigger.on("change", toggleMobileMenu); + $mobileMenuLabel.on("keydown", function(e) { + if (e.key === "Enter") { + e.preventDefault(); + $mobileMenuTrigger.prop("checked", !$mobileMenuTrigger.prop("checked")); + $mobileMenuTrigger.trigger("change"); + } }); }); \ No newline at end of file From 266a23cf77e2f90c7a198a28c3be732f2488d629 Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Tue, 12 Aug 2025 14:08:30 +0200 Subject: [PATCH 3/7] fix: fixed wrong list structure risk: low JIRA: DP-3215 --- layouts/partials/sidebar.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/layouts/partials/sidebar.html b/layouts/partials/sidebar.html index fcd852a..0d5204a 100644 --- a/layouts/partials/sidebar.html +++ b/layouts/partials/sidebar.html @@ -87,7 +87,9 @@ {{ if and $page.Params.navigationLabel $page.Pages }} - {{ template "section-tree-nav-sections" (dict "root" $page.Pages "currentPage" $currentPage "activeSection" $activeSection "site" $site) }} +
  • + {{ template "section-tree-nav-sections" (dict "root" $page.Pages "currentPage" $currentPage "activeSection" $activeSection "site" $site) }} +
    • {{ end }} {{ end }} {{ end }} From 364544bca3153025ac4b4cb800fec86678ee274c Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Tue, 12 Aug 2025 15:38:25 +0200 Subject: [PATCH 4/7] feat: added aria-labels to header, footer and some nav elements risk: low JIRA: DP-3086 --- layouts/_default/baseof.html | 4 ++-- layouts/api-reference/baseof.html | 4 ++-- layouts/docs/baseof.html | 4 ++-- layouts/partials/footer.html | 2 +- layouts/swagger/baseof.html | 4 ++-- static/js/menu.js | 4 +++- 6 files changed, 12 insertions(+), 10 deletions(-) diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 022a12f..6f225d0 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -13,7 +13,7 @@ {{ partial "gtm-body.html" }} {{ partial "skip-links.html" . }} -
    +
    {{ partial "navbar.html" . }}
    @@ -26,7 +26,7 @@
    {{ partial "toc.html" . }}
    -
    +
    {{ partial "version-banner.html" . }} {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }} {{ if .Draft }} diff --git a/layouts/api-reference/baseof.html b/layouts/api-reference/baseof.html index a2983ea..9f1bbb5 100644 --- a/layouts/api-reference/baseof.html +++ b/layouts/api-reference/baseof.html @@ -10,11 +10,11 @@ {{ partial "gtm-body.html" }} {{ partial "skip-links.html" . }} -
    +
    {{ partial "navbar.html" . }}
    -
    +
    {{ block "main" . }}{{ end }}
    {{ partialCached "footer.html" . }} diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 022a12f..6f225d0 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -13,7 +13,7 @@ {{ partial "gtm-body.html" }} {{ partial "skip-links.html" . }} -
    +
    {{ partial "navbar.html" . }}
    @@ -26,7 +26,7 @@
    {{ partial "toc.html" . }}
    -
    +
    {{ partial "version-banner.html" . }} {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }} {{ if .Draft }} diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index a88a525..abc4e52 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -2,7 +2,7 @@ {{ $footer := getJSON "https://www.gooddata.com/learn-assets/js/footer-definition.json" }} {{ if not .Site.Params.whitelabeled }} -
    +
    {{ if $footer.footer.bannerLinks }} diff --git a/layouts/swagger/baseof.html b/layouts/swagger/baseof.html index efc3c67..2f96812 100644 --- a/layouts/swagger/baseof.html +++ b/layouts/swagger/baseof.html @@ -10,7 +10,7 @@ {{ partial "gtm-body.html" }} {{ partial "skip-links.html" . }} -
    +
    {{ partial "navbar.html" . }}
    @@ -22,7 +22,7 @@
    {{ partial "toc.html" . }}
    -
    +
    {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }} diff --git a/static/js/menu.js b/static/js/menu.js index 70c9661..056bf61 100644 --- a/static/js/menu.js +++ b/static/js/menu.js @@ -84,5 +84,7 @@ $(document).ready(function () { $mobileMenuTrigger.trigger("change"); } }); - + // TOC menu + var $tocMenu = $("#TableOfContents"); + $tocMenu.attr("aria-label", "Table of contents"); }); \ No newline at end of file From 153127a1f9eb88c948d23c3190345048f1c5bfd4 Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Wed, 13 Aug 2025 10:20:56 +0200 Subject: [PATCH 5/7] fix: changed some nav landmarks to div and div to nav for better accessibility risk: low JIRA: DP-3086 --- layouts/partials/header-menu.html | 4 ++-- layouts/partials/navbar-breadcrumb.html | 14 ++++++++------ layouts/partials/navbar.html | 24 +++++++++++------------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/layouts/partials/header-menu.html b/layouts/partials/header-menu.html index 6b92fad..74f1dc7 100644 --- a/layouts/partials/header-menu.html +++ b/layouts/partials/header-menu.html @@ -7,7 +7,7 @@ {{ end }} {{ end }} -
    +
{{ end }} -
\ No newline at end of file + \ No newline at end of file diff --git a/layouts/partials/navbar-breadcrumb.html b/layouts/partials/navbar-breadcrumb.html index 7fff612..4462b25 100644 --- a/layouts/partials/navbar-breadcrumb.html +++ b/layouts/partials/navbar-breadcrumb.html @@ -1,8 +1,10 @@ {{/* (C) 2023 GoodData Corporation */}} {{/* This is overriden in docs (tiger/bear) */}} - + \ No newline at end of file diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index 6698ac3..53d0691 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -5,20 +5,18 @@ {{ $cover := .HasShortcode "blocks/cover" }} {{ if not $whitelabeled }} - {{ partial "header-menu.html" . }} {{ partial "header-right.html" . }} - - + {{ else }} - - + {{ end }} \ No newline at end of file From 03372aeaa8306090f73302dfcfa6c91fd6966d6e Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Wed, 13 Aug 2025 10:34:06 +0200 Subject: [PATCH 6/7] fix: added aria label to aritcles navigation risk: low JIRA: DP-3086 --- layouts/partials/sidebar.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/partials/sidebar.html b/layouts/partials/sidebar.html index 0d5204a..45b92fa 100644 --- a/layouts/partials/sidebar.html +++ b/layouts/partials/sidebar.html @@ -3,7 +3,7 @@
-