feat(a11y): add Skip Link component and main content IDs
- Add `SkipLink` component that appears on focus and jumps to main content.
- Update `en.ts` and `de.ts` with "Skip to content" translation.
- Add `id="main-content"`, `tabIndex={-1}`, and `outline: 'none'` to `Home`, `About`, and `Contact` pages to ensure proper focus management.
- Add tests for `SkipLink`.
- Document Skip Link pattern in `.Jules/palette.md`.
This improves accessibility for keyboard and screen reader users by allowing them to bypass navigation.
Co-authored-by: ragusa-it <196988693+ragusa-it@users.noreply.github.com>
This commit is contained in:
@@ -9,3 +9,7 @@
|
|||||||
## 2024-05-24 - Enhancing Inputs Safely
|
## 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).
|
**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.
|
**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.
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import { BrowserRouter, Routes, Route } from 'react-router-dom';
|
|||||||
import { LanguageProvider } from './i18n';
|
import { LanguageProvider } from './i18n';
|
||||||
import { Navbar, Footer, FancyCursor, ScrollToTop } from './components/layout';
|
import { Navbar, Footer, FancyCursor, ScrollToTop } from './components/layout';
|
||||||
import { Home } from './pages/Home';
|
import { Home } from './pages/Home';
|
||||||
import { PageLoader } from './components/ui';
|
import { PageLoader, SkipLink } from './components/ui';
|
||||||
import './styles/global.css';
|
import './styles/global.css';
|
||||||
|
|
||||||
// Lazy load pages to reduce initial bundle size.
|
// Lazy load pages to reduce initial bundle size.
|
||||||
@@ -15,6 +15,7 @@ export function App() {
|
|||||||
return (
|
return (
|
||||||
<LanguageProvider>
|
<LanguageProvider>
|
||||||
<BrowserRouter>
|
<BrowserRouter>
|
||||||
|
<SkipLink />
|
||||||
<ScrollToTop />
|
<ScrollToTop />
|
||||||
<FancyCursor />
|
<FancyCursor />
|
||||||
<Navbar />
|
<Navbar />
|
||||||
|
|||||||
22
src/components/ui/SkipLink.module.css
Normal file
22
src/components/ui/SkipLink.module.css
Normal 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;
|
||||||
|
}
|
||||||
12
src/components/ui/SkipLink.tsx
Normal file
12
src/components/ui/SkipLink.tsx
Normal 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>
|
||||||
|
);
|
||||||
|
}
|
||||||
36
src/components/ui/__tests__/SkipLink.test.tsx
Normal file
36
src/components/ui/__tests__/SkipLink.test.tsx
Normal 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_');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -2,3 +2,4 @@ export { Button } from './Button';
|
|||||||
export { Card } from './Card';
|
export { Card } from './Card';
|
||||||
export { Input, Textarea } from './Input';
|
export { Input, Textarea } from './Input';
|
||||||
export { PageLoader } from './PageLoader';
|
export { PageLoader } from './PageLoader';
|
||||||
|
export { SkipLink } from './SkipLink';
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ export const de = {
|
|||||||
home: 'Startseite',
|
home: 'Startseite',
|
||||||
about: 'Über uns',
|
about: 'Über uns',
|
||||||
contact: 'Kontakt',
|
contact: 'Kontakt',
|
||||||
|
skipToContent: 'Zum Inhalt springen',
|
||||||
},
|
},
|
||||||
|
|
||||||
// Hero Section
|
// Hero Section
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ export const en: Translations = {
|
|||||||
home: 'Home',
|
home: 'Home',
|
||||||
about: 'About',
|
about: 'About',
|
||||||
contact: 'Contact',
|
contact: 'Contact',
|
||||||
|
skipToContent: 'Skip to content',
|
||||||
},
|
},
|
||||||
|
|
||||||
// Hero Section
|
// Hero Section
|
||||||
|
|||||||
@@ -46,7 +46,13 @@ export function About() {
|
|||||||
const location = useLocation();
|
const location = useLocation();
|
||||||
|
|
||||||
return (
|
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 */}
|
{/* Hero Section */}
|
||||||
<section className={styles.hero}>
|
<section className={styles.hero}>
|
||||||
<div className="container">
|
<div className="container">
|
||||||
|
|||||||
@@ -133,7 +133,12 @@ export function Contact() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<main className={styles.contact}>
|
<main
|
||||||
|
className={styles.contact}
|
||||||
|
id="main-content"
|
||||||
|
tabIndex={-1}
|
||||||
|
style={{ outline: 'none' }}
|
||||||
|
>
|
||||||
{/* Hero */}
|
{/* Hero */}
|
||||||
<section className={styles.hero}>
|
<section className={styles.hero}>
|
||||||
<div className="container">
|
<div className="container">
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import { Hero, Services } from '../components/sections';
|
|||||||
|
|
||||||
export function Home() {
|
export function Home() {
|
||||||
return (
|
return (
|
||||||
<main>
|
<main id="main-content" tabIndex={-1} style={{ outline: 'none' }}>
|
||||||
<Hero />
|
<Hero />
|
||||||
<Services />
|
<Services />
|
||||||
</main>
|
</main>
|
||||||
|
|||||||
Reference in New Issue
Block a user