diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx index 54ccf8c0..18242a7d 100644 --- a/.storybook/preview.tsx +++ b/.storybook/preview.tsx @@ -76,6 +76,7 @@ const preview: Preview = { "Helpers", "Theme", "Theme/Logos", + "Accessibility", "MUI", "Components", ], diff --git a/src/storybook/accessibility/00-overview.mdx b/src/storybook/accessibility/00-overview.mdx new file mode 100644 index 00000000..b34f93bf --- /dev/null +++ b/src/storybook/accessibility/00-overview.mdx @@ -0,0 +1,189 @@ +import { Meta } from "@storybook/addon-docs/blocks"; + + + +
+ +# Accessibility (a11y) + +Our goal is to make interfaces that are understandable, predictable, and +usable across a wide range of abilities, environments, and levels of fatigue. + +## Standards and approach + +We follow WCAG 2.2 as the compliance baseline, and use APCA (Advanced +Perceptual Contrast Algorithm) to keep text readable and comfortable in +real-world conditions. See [Colour contrast and +vision](?path=/docs/accessibility-colour-contrast-and-vision--docs) for +details. + +## Core principles + + + +## ✅ Do + +### Interactive elements + + + +### Keyboard navigation + + + +For overlays such as menus and dialogs, manage focus intentionally: + + + +### Icons and icon-only actions + + + +For interactive icons, ensure both an accessible name and a visible affordance +such as a tooltip or label. + +In MUI, use aria-label on IconButton. Tooltips (e.g. <Tooltip />) should be used in addition to, not instead of, +accessible labelling. + +### Forms and inputs + + + +### Content and layout + + + +## ❌ Don’t + + + +## Storybook guidance + + + +## Quick sense check + + + +## Learn more: + + + +
diff --git a/src/storybook/accessibility/01-colour-contrast.mdx b/src/storybook/accessibility/01-colour-contrast.mdx new file mode 100644 index 00000000..bf6d929f --- /dev/null +++ b/src/storybook/accessibility/01-colour-contrast.mdx @@ -0,0 +1,108 @@ +import { Meta } from "@storybook/addon-docs/blocks"; + + + +
+ +# Colour contrast and vision + +Poor contrast slows decisions and raises error rates, especially in dense, +data-heavy interfaces. Colour choices also need to work for people with colour +vision deficiency (CVD). + +## How we judge contrast + + + +## Do + + + +## Watch out for + + + +Learn more: + + + +
diff --git a/src/storybook/accessibility/02-cognitive-a11y.mdx b/src/storybook/accessibility/02-cognitive-a11y.mdx new file mode 100644 index 00000000..f10cba6d --- /dev/null +++ b/src/storybook/accessibility/02-cognitive-a11y.mdx @@ -0,0 +1,72 @@ +import { Meta } from "@storybook/addon-docs/blocks"; + + + +
+ +# Cognitive accessibility and usability + +People differ in how they process information, maintain focus, and recover from +errors. In scientific software, users may work for long periods or run live +experiments where mistakes are costly. The goal is not to simplify the science, +but to remove cognitive load the interface adds. + +## Design objectives + + + +## Quick sense check + + + +Learn more: + + + +