Skip to content

🎨 Palette: Improved documentation tabs accessibility and keyboard navigation #39

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

Open
MilakyS wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🎨 Palette: Improved documentation tabs accessibility and keyboard navigation #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .jules/palette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,7 @@
## 2026-05-12 - Centralized Overlay State Management
**Learning:** Managing side effects like background scroll locking (`overflow: hidden` on body) and keyboard dismissal (Escape key) across multiple triggers (burger, backdrop, links, Esc key) is prone to state desync.
**Action:** Centralize all overlay transitions into a single `toggle[Component](open)` function that handles both visual classes and global side effects consistently.

## 2026-05-15 - Accessible Tabbed Interfaces
**Learning:** Documentation tabs were using buttons without ARIA roles or keyboard navigation beyond basic clicking. Implementing the WAI-ARIA Tabs pattern (tablist, tab, tabpanel roles with Arrow/Home/End key support) significantly improves accessibility for keyboard and screen reader users while maintaining the existing design.
**Action:** Use the `tablist` ARIA pattern for all tabbed components, ensuring roving tabindex and linking attributes (`aria-controls`, `aria-labelledby`) are present for assistive technology.
45 changes: 38 additions & 7 deletions assets/js/docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,20 +149,31 @@

const tabs = document.createElement('div');
tabs.className = 'tabs';
tabs.setAttribute('role', 'tablist');

const panes = document.createDocumentFragment();
section.tabs.forEach((tab, index) => {
const tabId = `tab-${section.id}-${tab.id}`;
const panelId = `panel-${section.id}-${tab.id}`;

const button = document.createElement('button');
button.className = index === 0 ? 'tab active' : 'tab';
button.type = 'button';
button.role = 'tab';
button.id = tabId;
button.dataset.tab = tab.id;
button.setAttribute('aria-selected', index === 0 ? 'true' : 'false');
button.setAttribute('aria-controls', panelId);
button.tabIndex = index === 0 ? 0 : -1;
button.textContent = tab.label;
tabs.append(button);

const pane = document.createElement('div');
pane.className = index === 0 ? 'tab-pane active' : 'tab-pane';
pane.id = panelId;
pane.role = 'tabpanel';
pane.dataset.tabPane = tab.id;
pane.setAttribute('aria-labelledby', tabId);
pane.hidden = index !== 0;
const codeBlock = makeCodeBlock(tab.code);
codeBlock.dataset.lang = tab.label || tab.id || 'code';
Expand Down Expand Up @@ -251,11 +262,13 @@
const panes = Array.from(panel.querySelectorAll('.tab-pane'));
if (!panes.length) return;

function activate(name) {
function activate(name, shouldFocus = false) {
tabs.forEach((tab) => {
const isActive = tab.dataset.tab === name;
tab.classList.toggle('active', isActive);
tab.setAttribute('aria-selected', String(isActive));
tab.tabIndex = isActive ? 0 : -1;
if (isActive && shouldFocus) tab.focus();
});

panes.forEach((pane) => {
Expand All @@ -268,8 +281,26 @@
const initial = tabset.querySelector('.tab.active')?.dataset.tab || tabs[0]?.dataset.tab;
if (initial) activate(initial);

tabs.forEach((tab) => {
tabs.forEach((tab, index) => {
tab.addEventListener('click', () => activate(tab.dataset.tab));

tab.addEventListener('keydown', (e) => {
let nextIndex = null;
if (e.key === 'ArrowRight' || e.key === 'ArrowDown') {
nextIndex = (index + 1) % tabs.length;
} else if (e.key === 'ArrowLeft' || e.key === 'ArrowUp') {
nextIndex = (index - 1 + tabs.length) % tabs.length;
} else if (e.key === 'Home') {
nextIndex = 0;
} else if (e.key === 'End') {
nextIndex = tabs.length - 1;
}

if (nextIndex !== null) {
e.preventDefault();
activate(tabs[nextIndex].dataset.tab, true);
}
});
});
});
}
Expand Down Expand Up @@ -359,10 +390,10 @@

function escapeHtml(str) {
return String(str ?? '')
.replaceAll('&', '&')
.replaceAll('<', '&lt;')
.replaceAll('>', '&gt;')
.replaceAll('"', '&quot;')
.replaceAll("'", '&#39;');
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;')
.replace(/'/g, '&#39;');
}
})();
6 changes: 3 additions & 3 deletions assets/js/home.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ function formatLine(text, withCursor = false) {

function escapeHtml(str) {
return str
.replaceAll('&', '&amp;')
.replaceAll('<', '&lt;')
.replaceAll('>', '&gt;');
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;');
}
Loading