Add accessible Skip to Content link #58

Closed
ragusa-it wants to merge 1 commits from palette/skip-link-8940126652676719915 into main
11 changed files with 93 additions and 4 deletions

View File

@@ -9,3 +9,7 @@
## 2024-05-24 - Enhancing Inputs Safely
**Learning:** Adding features like character counters to generic input components must handle both controlled and uncontrolled states. Assuming a component is controlled (using `props.value`) can break uncontrolled usage by showing stale data (e.g., sticking at 0/100).
**Action:** When enhancing generic components, detect uncontrolled state (e.g., `props.value === undefined`) and either implement internal state tracking or gracefully degrade (hide the feature) to avoid misleading UX.
## 2025-05-24 - Skip Link Focus Management
**Learning:** For a "Skip to content" link to effectively move focus in an SPA, the target container (e.g., `<main>`) must be programmatically focusable. Simply having an ID is not enough; `tabIndex={-1}` is required. Additionally, standard browser behavior might show a focus ring on the container, which is often undesirable for non-interactive wrappers, so `outline: 'none'` should be applied inline or via CSS.
**Action:** Always add `tabIndex={-1}` and `outline: 'none'` to the target of a Skip Link (`#main-content`) to ensure correct focus behavior without visual clutter.

View File

@@ -3,7 +3,7 @@ import { BrowserRouter, Routes, Route } from 'react-router-dom';
import { LanguageProvider } from './i18n';
import { Navbar, Footer, FancyCursor, ScrollToTop } from './components/layout';
import { Home } from './pages/Home';
import { PageLoader } from './components/ui';
import { PageLoader, SkipLink } from './components/ui';
import './styles/global.css';
// Lazy load pages to reduce initial bundle size.
@@ -15,6 +15,7 @@ export function App() {
return (
<LanguageProvider>
<BrowserRouter>
<SkipLink />
<ScrollToTop />
<FancyCursor />
<Navbar />

View File

@@ -0,0 +1,22 @@
.skipLink {
position: fixed;
top: 0;
left: 0;
width: 100%;
padding: 1rem;
background-color: var(--md-sys-color-background);
color: var(--md-sys-color-primary);
text-align: center;
font-weight: 600;
z-index: 10000;
transform: translateY(-100%);
transition: transform 0.2s ease-in-out;
text-decoration: none;
box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
}
.skipLink:focus {
transform: translateY(0);
outline: 2px solid var(--md-sys-color-primary);
outline-offset: -2px;
}

View File

@@ -0,0 +1,12 @@
import { useTranslation } from '../../i18n';
import styles from './SkipLink.module.css';
export function SkipLink() {
const { t } = useTranslation();
return (
<a href="#main-content" className={styles.skipLink}>
{t.nav.skipToContent}
</a>
);
}

View File

@@ -0,0 +1,36 @@
// @vitest-environment jsdom
import { render, screen, cleanup } from '@testing-library/react';
import { vi, describe, it, expect, afterEach } from 'vitest';
import { SkipLink } from '../SkipLink';
// Mock translation
vi.mock('../../../i18n', () => ({
useTranslation: () => ({
t: {
nav: {
skipToContent: 'Skip to content',
},
},
}),
}));
describe('SkipLink', () => {
afterEach(() => {
cleanup();
});
it('renders correctly', () => {
render(<SkipLink />);
const link = screen.getByText('Skip to content');
expect(link).toBeDefined();
expect(link.getAttribute('href')).toBe('#main-content');
});
it('is initially hidden (via CSS class)', () => {
render(<SkipLink />);
const link = screen.getByText('Skip to content');
// We can't test CSS module class values easily in jsdom without setup,
// but we can check the class name exists
expect(link.className).toContain('_skipLink_');
});
});

View File

@@ -2,3 +2,4 @@ export { Button } from './Button';
export { Card } from './Card';
export { Input, Textarea } from './Input';
export { PageLoader } from './PageLoader';
export { SkipLink } from './SkipLink';

View File

@@ -4,6 +4,7 @@ export const de = {
home: 'Startseite',
about: 'Über uns',
contact: 'Kontakt',
skipToContent: 'Zum Inhalt springen',
},
// Hero Section

View File

@@ -6,6 +6,7 @@ export const en: Translations = {
home: 'Home',
about: 'About',
contact: 'Contact',
skipToContent: 'Skip to content',
},
// Hero Section

View File

@@ -46,7 +46,13 @@ export function About() {
const location = useLocation();
return (
<main className={styles.about} key={location.key}>
<main
className={styles.about}
key={location.key}
id="main-content"
tabIndex={-1}
style={{ outline: 'none' }}
>
{/* Hero Section */}
<section className={styles.hero}>
<div className="container">

View File

@@ -133,7 +133,12 @@ export function Contact() {
};
return (
<main className={styles.contact}>
<main
className={styles.contact}
id="main-content"
tabIndex={-1}
style={{ outline: 'none' }}
>
{/* Hero */}
<section className={styles.hero}>
<div className="container">

View File

@@ -2,7 +2,7 @@ import { Hero, Services } from '../components/sections';
export function Home() {
return (
<main>
<main id="main-content" tabIndex={-1} style={{ outline: 'none' }}>
<Hero />
<Services />
</main>