Merge pull request 'Admin: themawissel met Auto en themagebonden Checkbox/Radio' (#19) from feature/admin-form-controls into master
Continuous Integration / config-asf (push) Successful in 6s
Continuous Integration / config-sls (push) Successful in 7s
Continuous Integration / changes (push) Successful in 11s
Continuous Integration / backend-build (push) Skipped
Continuous Integration / compile-sites (push) Skipped
Continuous Integration / backend-test (push) Skipped
Continuous Integration / vulnerability-scan (push) Skipped
Continuous Integration / frontend-prepare (push) Successful in 26s
Continuous Integration / frontend-build (push) Successful in 1m25s
Continuous Integration / frontend-test (push) Successful in 2m28s
Continuous Integration / frontend-lint (push) Successful in 2m32s
Continuous Integration / publish-sls-production (push) Skipped
Continuous Integration / deploy-sls-production (push) Skipped
Continuous Integration / publish-asf-test (push) Successful in 2m8s
Continuous Integration / publish-sls-test (push) Successful in 2m10s
Continuous Integration / deploy-asf-test (push) Successful in 48s
Continuous Integration / deploy-sls-test (push) Successful in 49s
Continuous Integration / smoke-asf-test (push) Successful in 13s
Continuous Integration / smoke-sls-test (push) Successful in 16s
Deploy (SCP) / deploy (push) Successful in 48s
Continuous Integration / config-asf (push) Successful in 6s
Continuous Integration / config-sls (push) Successful in 7s
Continuous Integration / changes (push) Successful in 11s
Continuous Integration / backend-build (push) Skipped
Continuous Integration / compile-sites (push) Skipped
Continuous Integration / backend-test (push) Skipped
Continuous Integration / vulnerability-scan (push) Skipped
Continuous Integration / frontend-prepare (push) Successful in 26s
Continuous Integration / frontend-build (push) Successful in 1m25s
Continuous Integration / frontend-test (push) Successful in 2m28s
Continuous Integration / frontend-lint (push) Successful in 2m32s
Continuous Integration / publish-sls-production (push) Skipped
Continuous Integration / deploy-sls-production (push) Skipped
Continuous Integration / publish-asf-test (push) Successful in 2m8s
Continuous Integration / publish-sls-test (push) Successful in 2m10s
Continuous Integration / deploy-asf-test (push) Successful in 48s
Continuous Integration / deploy-sls-test (push) Successful in 49s
Continuous Integration / smoke-asf-test (push) Successful in 13s
Continuous Integration / smoke-sls-test (push) Successful in 16s
Deploy (SCP) / deploy (push) Successful in 48s
This commit was merged in pull request #19.
This commit is contained in:
@@ -0,0 +1,82 @@
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { render, screen } from '@testing-library/react';
|
||||
import userEvent from '@testing-library/user-event';
|
||||
import i18n from '@/i18n/config';
|
||||
import { ThemeToggle } from './ThemeToggle';
|
||||
|
||||
const media = (dark: boolean) =>
|
||||
vi.spyOn(window, 'matchMedia').mockImplementation(
|
||||
() => ({ matches: dark, addEventListener: () => undefined, removeEventListener: () => undefined }) as unknown as MediaQueryList,
|
||||
);
|
||||
|
||||
beforeEach(async () => {
|
||||
localStorage.clear();
|
||||
document.documentElement.className = '';
|
||||
vi.restoreAllMocks();
|
||||
await i18n.changeLanguage('nl');
|
||||
});
|
||||
|
||||
describe('ThemeToggle', () => {
|
||||
it.each([
|
||||
['light', 'Thema: licht'],
|
||||
['dark', 'Thema: donker'],
|
||||
])('shows the CURRENT %s theme in its name (not the action)', (mode, name) => {
|
||||
localStorage.setItem('cms-theme', mode);
|
||||
media(false);
|
||||
|
||||
render(<ThemeToggle />);
|
||||
|
||||
const button = screen.getByTestId('theme-toggle');
|
||||
expect(button).toHaveAccessibleName(name);
|
||||
expect(button).toHaveAttribute('data-mode', mode);
|
||||
expect(button).toHaveAttribute('title', name);
|
||||
});
|
||||
|
||||
it('says in words what automatic currently is', () => {
|
||||
media(true);
|
||||
|
||||
render(<ThemeToggle />);
|
||||
|
||||
expect(screen.getByTestId('theme-toggle')).toHaveAccessibleName('Thema: automatisch (nu donker)');
|
||||
expect(screen.getByTestId('theme-toggle')).toHaveAttribute('data-mode', 'auto');
|
||||
});
|
||||
|
||||
it('opens a menu with three options, the current one marked, and chooses with the keyboard', async () => {
|
||||
media(false);
|
||||
localStorage.setItem('cms-theme', 'light');
|
||||
render(<ThemeToggle />);
|
||||
|
||||
screen.getByTestId('theme-toggle').focus();
|
||||
await userEvent.keyboard('{Enter}');
|
||||
|
||||
expect(await screen.findByTestId('theme-option-light')).toHaveAttribute('aria-current', 'true');
|
||||
expect(screen.getByTestId('theme-option-dark')).not.toHaveAttribute('aria-current');
|
||||
expect(screen.getByTestId('theme-option-auto')).toHaveTextContent('Automatisch');
|
||||
|
||||
await userEvent.click(screen.getByTestId('theme-option-dark'));
|
||||
|
||||
expect(localStorage.getItem('cms-theme')).toBe('dark');
|
||||
expect(document.documentElement.classList.contains('dark')).toBe(true);
|
||||
expect(screen.getByTestId('theme-toggle')).toHaveAccessibleName('Thema: donker');
|
||||
});
|
||||
|
||||
it('works on the first click: automatic to dark flips what is shown at once', async () => {
|
||||
media(false);
|
||||
render(<ThemeToggle />);
|
||||
|
||||
await userEvent.click(screen.getByTestId('theme-toggle'));
|
||||
await userEvent.click(await screen.findByTestId('theme-option-dark'));
|
||||
|
||||
expect(document.documentElement.classList.contains('dark')).toBe(true);
|
||||
expect(document.documentElement.classList.contains('light')).toBe(false);
|
||||
});
|
||||
|
||||
it('has English texts too', async () => {
|
||||
await i18n.changeLanguage('en');
|
||||
media(true);
|
||||
|
||||
render(<ThemeToggle />);
|
||||
|
||||
expect(screen.getByTestId('theme-toggle')).toHaveAccessibleName('Theme: automatic (now dark)');
|
||||
});
|
||||
});
|
||||
@@ -1,20 +1,66 @@
|
||||
import { Sun, Moon } from 'lucide-react';
|
||||
import { Monitor, Moon, Sun } from 'lucide-react';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { useTheme } from '@/hooks/useTheme';
|
||||
import {
|
||||
DropdownMenu,
|
||||
DropdownMenuCheck,
|
||||
DropdownMenuContent,
|
||||
DropdownMenuItem,
|
||||
DropdownMenuLabel,
|
||||
DropdownMenuSeparator,
|
||||
DropdownMenuTrigger,
|
||||
} from '@/components/ui/dropdown-menu';
|
||||
import { useTheme, type ThemeMode } from '@/hooks/useTheme';
|
||||
|
||||
const MODES: { mode: ThemeMode; icon: typeof Sun }[] = [
|
||||
{ mode: 'light', icon: Sun },
|
||||
{ mode: 'dark', icon: Moon },
|
||||
{ mode: 'auto', icon: Monitor },
|
||||
];
|
||||
|
||||
/**
|
||||
* Three states: light, dark, automatic (follow the system). The button shows the CURRENT choice (sun = light, moon =
|
||||
* dark, monitor = automatic), its name says it in words ("Theme: automatic (now dark)"), and a small menu with the three
|
||||
* options (the current one marked) changes it.
|
||||
*/
|
||||
export function ThemeToggle() {
|
||||
const { t } = useTranslation();
|
||||
const { isDark, toggleTheme } = useTheme();
|
||||
const { mode, theme, setMode } = useTheme();
|
||||
const Icon = MODES.find((m) => m.mode === mode)!.icon;
|
||||
const label =
|
||||
mode === 'auto'
|
||||
? t('theme.labelAuto', { now: t(`theme.mode.${theme}`).toLowerCase() })
|
||||
: t('theme.label', { mode: t(`theme.mode.${mode}`).toLowerCase() });
|
||||
|
||||
return (
|
||||
<button
|
||||
type="button"
|
||||
onClick={toggleTheme}
|
||||
aria-label={isDark ? t('theme.switchToLight') : t('theme.switchToDark')}
|
||||
data-testid="theme-toggle"
|
||||
className="flex items-center justify-center rounded-md p-2 text-muted-foreground hover:bg-accent hover:text-accent-foreground"
|
||||
>
|
||||
{isDark ? <Sun className="size-4" /> : <Moon className="size-4" />}
|
||||
</button>
|
||||
<DropdownMenu>
|
||||
<DropdownMenuTrigger asChild>
|
||||
<button
|
||||
type="button"
|
||||
aria-label={label}
|
||||
title={label}
|
||||
data-testid="theme-toggle"
|
||||
data-mode={mode}
|
||||
className="flex items-center justify-center rounded-md p-2 text-muted-foreground hover:bg-accent hover:text-accent-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
|
||||
>
|
||||
<Icon className="size-4" />
|
||||
</button>
|
||||
</DropdownMenuTrigger>
|
||||
<DropdownMenuContent align="start">
|
||||
<DropdownMenuLabel>{t('theme.title')}</DropdownMenuLabel>
|
||||
<DropdownMenuSeparator />
|
||||
{MODES.map(({ mode: option, icon: OptionIcon }) => (
|
||||
<DropdownMenuItem
|
||||
key={option}
|
||||
onSelect={() => setMode(option)}
|
||||
aria-current={mode === option ? 'true' : undefined}
|
||||
data-testid={`theme-option-${option}`}
|
||||
>
|
||||
<OptionIcon className="size-4" />
|
||||
{t(`theme.mode.${option}`)}
|
||||
<DropdownMenuCheck checked={mode === option} />
|
||||
</DropdownMenuItem>
|
||||
))}
|
||||
</DropdownMenuContent>
|
||||
</DropdownMenu>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,105 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { render, screen } from '@testing-library/react';
|
||||
import userEvent from '@testing-library/user-event';
|
||||
import { useForm } from 'react-hook-form';
|
||||
import { Checkbox, CheckboxField } from './checkbox';
|
||||
import { Radio, RadioField, RadioGroup } from './radio';
|
||||
|
||||
describe('Checkbox', () => {
|
||||
it('is a real checkbox: Space toggles it and the label is clickable', async () => {
|
||||
render(<CheckboxField label="Uitgelicht" data-testid="box" />);
|
||||
const box = screen.getByRole('checkbox', { name: 'Uitgelicht' });
|
||||
|
||||
box.focus();
|
||||
await userEvent.keyboard(' ');
|
||||
expect(box).toBeChecked();
|
||||
|
||||
await userEvent.click(screen.getByText('Uitgelicht'));
|
||||
expect(box).not.toBeChecked();
|
||||
});
|
||||
|
||||
it('shows the in-between state and does not change its value', () => {
|
||||
render(<Checkbox aria-label="alles" indeterminate />);
|
||||
const box = screen.getByRole('checkbox', { name: 'alles' }) as HTMLInputElement;
|
||||
|
||||
expect(box.indeterminate).toBe(true);
|
||||
expect(box).not.toBeChecked();
|
||||
});
|
||||
|
||||
it('can be disabled and marked invalid', async () => {
|
||||
render(<Checkbox aria-label="x" disabled invalid />);
|
||||
const box = screen.getByRole('checkbox', { name: 'x' });
|
||||
|
||||
expect(box).toBeDisabled();
|
||||
expect(box).toHaveAttribute('aria-invalid', 'true');
|
||||
await userEvent.click(box);
|
||||
expect(box).not.toBeChecked();
|
||||
});
|
||||
|
||||
it('draws with the colours of the theme (accent when checked, a visible border, a focus ring)', () => {
|
||||
render(<Checkbox aria-label="x" />);
|
||||
const cls = screen.getByRole('checkbox').className;
|
||||
|
||||
expect(cls).toContain('checked:bg-primary');
|
||||
expect(cls).toContain('border-muted-foreground');
|
||||
expect(cls).toContain('focus-visible:ring-ring');
|
||||
expect(cls).toContain('forced-colors:checked:bg-[Highlight]');
|
||||
});
|
||||
|
||||
it('works with react-hook-form register, like the native input it replaces', async () => {
|
||||
function Form({ onSubmit }: { onSubmit: (v: { on: boolean }) => void }) {
|
||||
const { register, handleSubmit } = useForm<{ on: boolean }>({ defaultValues: { on: false } });
|
||||
return (
|
||||
<form onSubmit={handleSubmit(onSubmit)}>
|
||||
<CheckboxField label="Aan" {...register('on')} />
|
||||
<button type="submit">go</button>
|
||||
</form>
|
||||
);
|
||||
}
|
||||
let saved: { on: boolean } | null = null;
|
||||
render(
|
||||
<Form
|
||||
onSubmit={(v) => {
|
||||
saved = v;
|
||||
}}
|
||||
/>,
|
||||
);
|
||||
|
||||
await userEvent.click(screen.getByLabelText('Aan'));
|
||||
await userEvent.click(screen.getByText('go'));
|
||||
|
||||
await screen.findByText('go');
|
||||
expect(saved).toEqual({ on: true });
|
||||
});
|
||||
});
|
||||
|
||||
describe('Radio', () => {
|
||||
it('is a real radio group: the arrow keys move and select, with a name for the group', async () => {
|
||||
render(
|
||||
<RadioGroup label="Weergave">
|
||||
<RadioField name="d" value="single" label="Enkel" defaultChecked />
|
||||
<RadioField name="d" value="slideshow" label="Diavoorstelling" />
|
||||
</RadioGroup>,
|
||||
);
|
||||
expect(screen.getByRole('radiogroup', { name: 'Weergave' })).toBeInTheDocument();
|
||||
const first = screen.getByRole('radio', { name: 'Enkel' });
|
||||
const second = screen.getByRole('radio', { name: 'Diavoorstelling' });
|
||||
|
||||
first.focus();
|
||||
await userEvent.keyboard('{ArrowDown}');
|
||||
|
||||
expect(second).toBeChecked();
|
||||
expect(first).not.toBeChecked();
|
||||
expect(second).toHaveFocus();
|
||||
});
|
||||
|
||||
it('can be disabled and marked invalid, and uses theme colours', () => {
|
||||
render(<Radio aria-label="r" name="g" value="a" disabled invalid />);
|
||||
const radio = screen.getByRole('radio');
|
||||
|
||||
expect(radio).toBeDisabled();
|
||||
expect(radio).toHaveAttribute('aria-invalid', 'true');
|
||||
expect(radio.className).toContain('checked:border-primary');
|
||||
expect(radio.className).toContain('forced-colors:checked:border-[Highlight]');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,77 @@
|
||||
import * as React from 'react';
|
||||
import { Check, Minus } from 'lucide-react';
|
||||
import { cn } from '@/lib/utils';
|
||||
|
||||
export interface CheckboxProps extends Omit<React.ComponentProps<'input'>, 'type' | 'size'> {
|
||||
/** The "some of them" state of a parent checkbox. It is shown with a minus; the value of the box itself does not change. */
|
||||
indeterminate?: boolean;
|
||||
/** The field has an error: a red border (and aria-invalid for screen readers). */
|
||||
invalid?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* A real checkbox (a native input: Space toggles it, it works with a label, with react-hook-form's register and in forms),
|
||||
* drawn in the colours of the theme: a clear border, the accent colour with a check mark when checked, a minus for the
|
||||
* in-between state, hover, a focus ring, disabled and error states. The check mark is an icon over the input in the
|
||||
* "primary foreground" colour; in forced-colors (high contrast) mode the system colours take over.
|
||||
*/
|
||||
export const Checkbox = React.forwardRef<HTMLInputElement, CheckboxProps>(
|
||||
({ className, indeterminate = false, invalid = false, ...props }, forwardedRef) => {
|
||||
const inner = React.useRef<HTMLInputElement | null>(null);
|
||||
const setRef = (element: HTMLInputElement | null) => {
|
||||
inner.current = element;
|
||||
if (typeof forwardedRef === 'function') forwardedRef(element);
|
||||
else if (forwardedRef) forwardedRef.current = element;
|
||||
};
|
||||
React.useEffect(() => {
|
||||
if (inner.current) inner.current.indeterminate = indeterminate;
|
||||
}, [indeterminate]);
|
||||
|
||||
return (
|
||||
<span className="relative inline-flex size-5 shrink-0 items-center justify-center">
|
||||
<input
|
||||
ref={setRef}
|
||||
type="checkbox"
|
||||
aria-invalid={invalid || undefined}
|
||||
className={cn(
|
||||
'peer size-5 shrink-0 cursor-pointer appearance-none rounded border-2 border-muted-foreground bg-background transition-colors',
|
||||
'hover:border-primary checked:border-primary checked:bg-primary indeterminate:border-primary indeterminate:bg-primary',
|
||||
'focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 ring-offset-background',
|
||||
'disabled:cursor-not-allowed disabled:opacity-50 aria-[invalid=true]:border-destructive',
|
||||
'forced-colors:checked:bg-[Highlight] forced-colors:checked:border-[Highlight]',
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
<Check
|
||||
className="pointer-events-none absolute size-3.5 text-primary-foreground opacity-0 peer-checked:opacity-100 peer-indeterminate:opacity-0 peer-disabled:opacity-50 forced-colors:text-[HighlightText]"
|
||||
strokeWidth={3}
|
||||
aria-hidden="true"
|
||||
/>
|
||||
<Minus
|
||||
className="pointer-events-none absolute size-3.5 text-primary-foreground opacity-0 peer-indeterminate:opacity-100 peer-disabled:opacity-50 forced-colors:text-[HighlightText]"
|
||||
strokeWidth={3}
|
||||
aria-hidden="true"
|
||||
/>
|
||||
</span>
|
||||
);
|
||||
},
|
||||
);
|
||||
Checkbox.displayName = 'Checkbox';
|
||||
|
||||
interface CheckboxFieldProps extends CheckboxProps {
|
||||
label: React.ReactNode;
|
||||
}
|
||||
|
||||
/** A checkbox with its label: the whole line is clickable and at least 24 px high. */
|
||||
export const CheckboxField = React.forwardRef<HTMLInputElement, CheckboxFieldProps>(({ label, id, disabled, ...props }, ref) => {
|
||||
const generated = React.useId();
|
||||
const inputId = id ?? generated;
|
||||
return (
|
||||
<label htmlFor={inputId} className={cn('inline-flex min-h-6 cursor-pointer items-center gap-2 py-0.5 text-sm', disabled && 'cursor-not-allowed opacity-70')}>
|
||||
<Checkbox ref={ref} id={inputId} disabled={disabled} {...props} />
|
||||
<span>{label}</span>
|
||||
</label>
|
||||
);
|
||||
});
|
||||
CheckboxField.displayName = 'CheckboxField';
|
||||
@@ -0,0 +1,61 @@
|
||||
import * as React from 'react';
|
||||
import { cn } from '@/lib/utils';
|
||||
|
||||
export interface RadioProps extends Omit<React.ComponentProps<'input'>, 'type' | 'size'> {
|
||||
invalid?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* A real radio button (a native input: with the same name the arrow keys move and select inside the group, Space selects),
|
||||
* drawn in the colours of the theme: a clear round border, the accent colour with a dot when selected, hover, a focus
|
||||
* ring, disabled and error states, and system colours in forced-colors (high contrast) mode.
|
||||
*/
|
||||
export const Radio = React.forwardRef<HTMLInputElement, RadioProps>(({ className, invalid = false, ...props }, ref) => (
|
||||
<span className="relative inline-flex size-5 shrink-0 items-center justify-center">
|
||||
<input
|
||||
ref={ref}
|
||||
type="radio"
|
||||
aria-invalid={invalid || undefined}
|
||||
className={cn(
|
||||
'peer size-5 shrink-0 cursor-pointer appearance-none rounded-full border-2 border-muted-foreground bg-background transition-colors',
|
||||
'hover:border-primary checked:border-primary',
|
||||
'focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 ring-offset-background',
|
||||
'disabled:cursor-not-allowed disabled:opacity-50 aria-[invalid=true]:border-destructive',
|
||||
'forced-colors:checked:border-[Highlight]',
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
<span
|
||||
className="pointer-events-none absolute size-2.5 rounded-full bg-primary opacity-0 peer-checked:opacity-100 peer-disabled:opacity-50 forced-colors:bg-[Highlight]"
|
||||
aria-hidden="true"
|
||||
/>
|
||||
</span>
|
||||
));
|
||||
Radio.displayName = 'Radio';
|
||||
|
||||
interface RadioFieldProps extends RadioProps {
|
||||
label: React.ReactNode;
|
||||
}
|
||||
|
||||
/** A radio button with its label: the whole line is clickable and at least 24 px high. */
|
||||
export const RadioField = React.forwardRef<HTMLInputElement, RadioFieldProps>(({ label, id, disabled, ...props }, ref) => {
|
||||
const generated = React.useId();
|
||||
const inputId = id ?? generated;
|
||||
return (
|
||||
<label htmlFor={inputId} className={cn('inline-flex min-h-6 cursor-pointer items-center gap-2 py-0.5 text-sm', disabled && 'cursor-not-allowed opacity-70')}>
|
||||
<Radio ref={ref} id={inputId} disabled={disabled} {...props} />
|
||||
<span>{label}</span>
|
||||
</label>
|
||||
);
|
||||
});
|
||||
RadioField.displayName = 'RadioField';
|
||||
|
||||
/** The group around related radio buttons: role radiogroup with a name, so a screen reader announces what is chosen. */
|
||||
export function RadioGroup({ label, className, children, ...props }: { label: string } & Omit<React.ComponentProps<'div'>, 'aria-label'>) {
|
||||
return (
|
||||
<div role="radiogroup" aria-label={label} className={cn('flex flex-wrap gap-x-6 gap-y-1', className)} {...props}>
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user