Skip to content

Improve a11y for TOC navigation #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ritorhymes wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Improve a11y for TOC navigation #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
431e329
enable h1-3 wrapdown to prevent long function strings from breaking p…
ritorhymes Dec 26, 2025
5044f7b
Add space under .highlight on mobile so it isn't directly touching co…
ritorhymes Dec 26, 2025
dabe45e
Improve a11y for TOC navigation
ritorhymes Dec 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions source/javascripts/app/_toc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
var closeToc = function() {
$(".toc-wrapper").removeClass('open');
$("#nav-button").removeClass('open');
// Ensure ARIA state is synced
$("#nav-button").attr("aria-expanded", "false");
};

function loadToc($toc, tocLinkSelector, tocListSelector, scrollOffset) {
Expand Down Expand Up @@ -70,9 +72,9 @@
if (!$best.hasClass("active")) {
// .active is applied to the ToC link we're currently on, and its parent <ul>s selected by tocListSelector
// .active-expanded is applied to the ToC links that are parents of this one
$toc.find(".active").removeClass("active");
$toc.find(".active").removeClass("active").removeAttr("aria-current");
$toc.find(".active-parent").removeClass("active-parent");
$best.addClass("active");
$best.addClass("active").attr("aria-current", "location");
$best.parents(tocListSelector).addClass("active").siblings(tocLinkSelector).addClass('active-parent');
$best.siblings(tocListSelector).addClass("active");
$toc.find(tocListSelector).filter(":not(.active)").slideUp(150);
Expand All @@ -96,8 +98,22 @@
$("#nav-button").click(function() {
$(".toc-wrapper").toggleClass('open');
$("#nav-button").toggleClass('open');

// Update ARIA state
var isOpen = $("#nav-button").hasClass('open');
$("#nav-button").attr("aria-expanded", isOpen ? "true" : "false");

return false;
});

$(document).keyup(function(e) {
// Escape key closes the ToC (mobile/tablet only)
// Only trigger if nav-button is visible (mobile/tablet)
if (e.key === "Escape" && $("#nav-button").is(":visible")) {
closeToc();
}
});

$(".page-wrapper").click(closeToc);
$(".toc-link").click(closeToc);

Expand Down
6 changes: 3 additions & 3 deletions source/layouts/layout.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ under the License.
</head>

<body class="<%= page_classes %>" data-languages="<%=h language_tabs.map{ |lang| lang.is_a?(Hash) ? lang.keys.first : lang }.to_json %>">
<a href="#" id="nav-button">
<a href="#" id="nav-button" role="button" aria-label="Toggle Navigation" aria-expanded="false" aria-controls="toc-wrapper">
<span>
NAV
<%= image_tag('navbar.png') %>
</span>
</a>
<div class="toc-wrapper">
<nav class="toc-wrapper" id="toc-wrapper" aria-label="Table of Contents">
<%= link_to(image_tag("logo.png", :title => "Click here to return to ZAP home page"), "/") %>
<% if language_tabs.any? %>
<div class="lang-selector">
Expand Down Expand Up @@ -94,7 +94,7 @@ under the License.
<% end %>
</ul>
<% end %>
</div>
</nav>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
Expand Down
8 changes: 8 additions & 0 deletions source/stylesheets/screen.css.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,10 @@ html, body {
margin-bottom: 0.8em;
}

// Ensure long operation names wrap on small screens
h1, h2, h3 {
overflow-wrap: anywhere;
}

h4, h5, h6 {
font-size: 15px;
Expand Down Expand Up @@ -609,6 +613,10 @@ html, body {
%right-col + %left-col {
margin-top: $main-padding;
}

.highlight {
margin-bottom: 1em;
}
}

.highlight .c, .highlight .cm, .highlight .c1, .highlight .cs {
Expand Down