Form primitives, keyboard-operable comboboxes, dialog focus, route states
Accessibility work on the UI layer, all of it rooted in one structural gap: there were no form primitives, so every field was hand-assembled and every field got the same details wrong. Form primitives - components/ui/Field.tsx (Field/TextField/SelectField/TextareaField) and Button.tsx. Field generates the control id with useId and derives htmlFor from it, which is what makes the association impossible to omit rather than merely conventional. - 92 labels existed, 4 used htmlFor, and no input carried an id at all: a screen reader announced an unnamed edit box and clicking a label focused nothing. Now every label resolves to its control (0 unassociated), and the input class chain that appeared verbatim 85 times appears zero times. - Field also takes a render prop, so Lookup, CountryPicker and Picklist get the same wiring instead of a second, partial solution. - SearchInput replaces three hand-rolled copies of the icon-in-a-box search whose input had only a placeholder — not a label — and killed its own focus ring with outline-none and nothing in its place. - Toggle groups (workdays, reorg change type) became fieldsets with aria-pressed; colour alone was carrying the selected state. Comboboxes - Lookup and CountryPicker were text inputs with a div of clickable buttons underneath: typeable, but no keyboard path to a result and nothing telling a screen reader a list had appeared. Both now carry role=combobox, aria-expanded/controls/activedescendant and listbox semantics, with arrow keys, Enter and Escape. Escape stops propagation, or it would close the surrounding dialog along with the dropdown. Dialogs - useDialogFocus centralises what Modal and SlideOver each owed the keyboard and neither provided beyond Escape: focus into the dialog on open, Tab and Shift+Tab cycling within it, focus restored to the trigger on close. - SlideOver stays mounted for its transition, and aria-hidden does not remove anything from the tab order — so every closed panel was leaving invisible tab stops at the end of the page. `inert` fixes that. Route states - loading.tsx, error.tsx, not-found.tsx and global-error.tsx. Every page in the (app) group is server-rendered per request, so without loading.tsx a navigation showed nothing at all until the server answered, and a render error dropped the user on Next's own screen with no way back. Tests - 22 component tests (vitest jsdom project). Two of them found limits of the environment rather than of the code: jsdom implements neither `inert` nor scrollIntoView, so the inert test asserts the attribute and the missing scrollIntoView — which was taking the whole render down from inside an effect — is stubbed in the setup file.
This commit is contained in:
182
components/ui/Field.tsx
Normal file
182
components/ui/Field.tsx
Normal file
@@ -0,0 +1,182 @@
|
||||
"use client";
|
||||
|
||||
import { useId, type ReactNode, type SelectHTMLAttributes, type InputHTMLAttributes, type TextareaHTMLAttributes } from "react";
|
||||
|
||||
// Form primitives.
|
||||
//
|
||||
// Before these existed the same class chain was written out by hand at 85
|
||||
// call sites, each with a bare `<label>` next to a bare `<input>` and no
|
||||
// connection between them — 92 labels, 4 of which used htmlFor, and not a
|
||||
// single input carried an id. Screen readers announced an unnamed edit box
|
||||
// and clicking a label focused nothing. Generating the id here makes that
|
||||
// impossible to get wrong, and gives every field one place to fix focus
|
||||
// styling, error display and sizing.
|
||||
|
||||
export const CONTROL_CLASS =
|
||||
"w-full rounded border border-border bg-white px-3 py-2 text-sm text-ink " +
|
||||
"focus-visible:outline-2 focus-visible:outline-offset-1 focus-visible:outline-brand-500 " +
|
||||
"disabled:cursor-not-allowed disabled:bg-surface disabled:text-ink-muted";
|
||||
|
||||
const INVALID_CLASS = "border-danger-solid";
|
||||
|
||||
/** Auto-width select for filter bars, where the label is an aria-label. */
|
||||
export const FILTER_SELECT_CLASS =
|
||||
"rounded border border-border bg-white px-3 py-2 text-sm text-ink " +
|
||||
"focus-visible:outline-2 focus-visible:outline-offset-1 focus-visible:outline-brand-500";
|
||||
|
||||
type FieldChildProps = {
|
||||
id: string;
|
||||
"aria-describedby": string | undefined;
|
||||
"aria-invalid": true | undefined;
|
||||
};
|
||||
|
||||
type FieldShellProps = {
|
||||
label: string;
|
||||
/** Marks the label and sets required on the control. */
|
||||
required?: boolean;
|
||||
/** Helper text below the control; announced with the field. */
|
||||
hint?: string;
|
||||
/** Replaces the hint when set and marks the control invalid. */
|
||||
error?: string | null;
|
||||
/** Smaller label, used inside dense side panels. */
|
||||
dense?: boolean;
|
||||
className?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Escape hatch for controls this module does not wrap (Lookup, CountryPicker,
|
||||
* Picklist). Hands the wiring to the caller instead of guessing at it:
|
||||
*
|
||||
* <Field label="Land">{(p) => <CountryPicker {...p} … />}</Field>
|
||||
*/
|
||||
export function Field({
|
||||
label,
|
||||
required,
|
||||
hint,
|
||||
error,
|
||||
dense,
|
||||
className,
|
||||
children,
|
||||
}: FieldShellProps & { children: (props: FieldChildProps) => ReactNode }) {
|
||||
const id = useId();
|
||||
const messageId = `${id}-message`;
|
||||
const message = error ?? hint;
|
||||
|
||||
return (
|
||||
<div className={className}>
|
||||
<label htmlFor={id} className={dense ? "mb-1 block text-xs font-semibold text-ink-muted" : "mb-1 block text-sm font-semibold text-ink"}>
|
||||
{label}
|
||||
{required && <span aria-hidden> *</span>}
|
||||
{required && <span className="sr-only"> (Pflichtfeld)</span>}
|
||||
</label>
|
||||
{children({
|
||||
id,
|
||||
"aria-describedby": message ? messageId : undefined,
|
||||
"aria-invalid": error ? true : undefined,
|
||||
})}
|
||||
{message && (
|
||||
<p id={messageId} className={`mt-1 text-xs ${error ? "font-semibold text-danger-text" : "text-ink-muted"}`}>
|
||||
{message}
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
type TextFieldProps = FieldShellProps &
|
||||
Omit<InputHTMLAttributes<HTMLInputElement>, "onChange" | "id" | "className"> & {
|
||||
value: string;
|
||||
/** Receives the value directly — every call site wanted e.target.value. */
|
||||
onChange: (value: string) => void;
|
||||
};
|
||||
|
||||
export function TextField({ label, required, hint, error, dense, className, value, onChange, ...rest }: TextFieldProps) {
|
||||
return (
|
||||
<Field label={label} required={required} hint={hint} error={error} dense={dense} className={className}>
|
||||
{(p) => (
|
||||
<input
|
||||
{...p}
|
||||
{...rest}
|
||||
required={required}
|
||||
value={value}
|
||||
onChange={(e) => onChange(e.target.value)}
|
||||
className={`${CONTROL_CLASS} ${error ? INVALID_CLASS : ""}`}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
);
|
||||
}
|
||||
|
||||
type Option = { value: string; label: string; disabled?: boolean };
|
||||
|
||||
type SelectFieldProps = FieldShellProps &
|
||||
Omit<SelectHTMLAttributes<HTMLSelectElement>, "onChange" | "id" | "className" | "children"> & {
|
||||
value: string;
|
||||
onChange: (value: string) => void;
|
||||
options: readonly Option[];
|
||||
/** Prepends a disabled placeholder, for "Bitte wählen…" selects. */
|
||||
placeholder?: string;
|
||||
};
|
||||
|
||||
export function SelectField({
|
||||
label,
|
||||
required,
|
||||
hint,
|
||||
error,
|
||||
dense,
|
||||
className,
|
||||
value,
|
||||
onChange,
|
||||
options,
|
||||
placeholder,
|
||||
...rest
|
||||
}: SelectFieldProps) {
|
||||
return (
|
||||
<Field label={label} required={required} hint={hint} error={error} dense={dense} className={className}>
|
||||
{(p) => (
|
||||
<select
|
||||
{...p}
|
||||
{...rest}
|
||||
required={required}
|
||||
value={value}
|
||||
onChange={(e) => onChange(e.target.value)}
|
||||
className={`${CONTROL_CLASS} ${error ? INVALID_CLASS : ""}`}
|
||||
>
|
||||
{placeholder && (
|
||||
<option value="" disabled>
|
||||
{placeholder}
|
||||
</option>
|
||||
)}
|
||||
{options.map((o) => (
|
||||
<option key={o.value} value={o.value} disabled={o.disabled}>
|
||||
{o.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
)}
|
||||
</Field>
|
||||
);
|
||||
}
|
||||
|
||||
type TextareaFieldProps = FieldShellProps &
|
||||
Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, "onChange" | "id" | "className"> & {
|
||||
value: string;
|
||||
onChange: (value: string) => void;
|
||||
};
|
||||
|
||||
export function TextareaField({ label, required, hint, error, dense, className, value, onChange, ...rest }: TextareaFieldProps) {
|
||||
return (
|
||||
<Field label={label} required={required} hint={hint} error={error} dense={dense} className={className}>
|
||||
{(p) => (
|
||||
<textarea
|
||||
{...p}
|
||||
{...rest}
|
||||
required={required}
|
||||
value={value}
|
||||
onChange={(e) => onChange(e.target.value)}
|
||||
className={`${CONTROL_CLASS} ${error ? INVALID_CLASS : ""}`}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user