mirror of
https://github.com/openclaw/openclaw.git
synced 2026-06-23 11:38:07 +00:00
* docs: UX-013 — shared design system documentation * docs: align design system docs with source tokens
5.3 KiB
5.3 KiB
Accessibility
OpenClaw targets WCAG 2.1 AA. This checklist applies to every UI component — use it when building new components and during PR review.
Contrast Minimums
| Context | Minimum Ratio | Notes |
|---|---|---|
| Normal body text (< 18px / < 14px bold) | 4.5:1 | Use --text (#d4d4d8) or stronger on --bg |
| Large text (≥ 18px regular / ≥ 14px bold) | 3:1 | Headings in chat thread |
| UI component boundaries (inputs, buttons) | 3:1 | Border colours against adjacent background |
| Focus indicators | 3:1 (AA) | --focus-ring / --focus-glow already compliant |
| Placeholder text | Best-effort ≥3:1 | --muted (#838387) is ~5:1 on --bg — acceptable |
Verify with WebAIM Contrast Checker or browser DevTools accessibility panel.
Checklist
1. Focus Visible
- All interactive elements have a visible
:focus-visiblestyle - Use
--focus-ringbox-shadow pattern frombase.css— do not remove the outline without replacing it - Never use
outline: nonealone; replace withbox-shadow: var(--focus-ring)andoutline: none
/* Correct pattern */
.my-button:focus-visible {
outline: none;
box-shadow: var(--focus-ring);
}
2. Minimum Tap / Click Target Size
- All interactive controls are ≥ 44×44px on mobile / touch targets
- Icon-only buttons add invisible padding to reach 44px (
min-width: 44px; min-height: 44px) - Verify on the mobile breakpoint (
@media (max-width: 768px))
3. Skip Link
- A visually-hidden skip link (
#skip-to-main) is present in the document root - The link becomes visible on focus
- Target element has
tabindex="-1"to accept programmatic focus
<a id="skip-to-main" href="#main-content" class="skip-link">Skip to main content</a>
.skip-link {
position: absolute;
left: -9999px;
top: 0;
z-index: 9999;
}
.skip-link:focus {
left: 1rem;
top: 1rem;
/* ... visible styles */
}
4. Focus Trap
- Modal dialogs trap focus inside while open (Tab/Shift+Tab cycle within the modal)
- Closing the modal returns focus to the trigger element
- Escape key closes the modal
5. ARIA Labels
- Icon-only buttons have
aria-labeldescribing the action (not the icon name) - Progress bars use
role="progressbar"witharia-valuenow,aria-valuemin,aria-valuemax - Live regions updating async content use
aria-live="polite"(or"assertive"for critical alerts) - Decorative SVG icons have
aria-hidden="true"
<!-- Correct: icon button -->
<button aria-label="Send message">
<svg aria-hidden="true"><!-- ... --></svg>
</button>
<!-- Correct: progress bar -->
<div
role="progressbar"
aria-valuenow="42"
aria-valuemin="0"
aria-valuemax="100"
aria-label="Context window usage"
>
<div style="width: 42%"></div>
</div>
6. Tab Role Pattern
When building a tab interface:
- Tab container:
role="tablist" - Each tab:
role="tab",aria-selected="true|false",aria-controls="panel-id" - Each panel:
role="tabpanel",idmatchingaria-controls,aria-labelledbypointing to its tab - Keyboard: Arrow keys move between tabs; Tab moves into the panel; Shift+Tab exits
<div role="tablist" aria-label="Main navigation">
<button role="tab" aria-selected="true" aria-controls="chat-panel" id="chat-tab">Chat</button>
<button role="tab" aria-selected="false" aria-controls="settings-panel" id="settings-tab">
Settings
</button>
</div>
<div role="tabpanel" id="chat-panel" aria-labelledby="chat-tab"><!-- ... --></div>
<div role="tabpanel" id="settings-panel" aria-labelledby="settings-tab" hidden><!-- ... --></div>
7. Reduced Motion
- No animation plays without being suppressible via
prefers-reduced-motion - The global reset in
base.csscovers transitions — test with "Reduce motion" enabled in OS settings - Infinite loaders (
shimmer, spinners) have explicitanimation: nonein reduced-motion context
8. Semantic HTML
- Use native elements (
<button>,<a>,<input>) before adding ARIA to<div>/<span> - Headings (
<h1>–<h6>) reflect document hierarchy — do not skip levels - Lists of items use
<ul>/<ol>+<li>, not chains of<div>
Testing Tools
| Tool | Purpose |
|---|---|
| Chrome DevTools → Accessibility tab | Inspect ARIA tree, contrast |
| axe DevTools (browser extension) | Automated WCAG audit |
macOS VoiceOver (Cmd+F5) |
Screen reader smoke test |
prefers-reduced-motion: reduce (DevTools → Rendering) |
Verify animation suppression |
| Keyboard-only navigation | Tab through entire UI without mouse |