Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow passing custom aria-describedby values to form components #1813

Merged
merged 3 commits into from
Oct 26, 2022
Merged

Allow passing custom aria-describedby values to form components #1813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca48798
Allow passing a custom aria-describedby value to the Checkbox component
Oct 25, 2022
42e7ac0
Allow passing custom aria-describedby attributes to remaining form co…
Oct 26, 2022
e619bee
Add changeset
Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dirty-camels-boil.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sumup/circuit-ui': patch
---

Allowed passing a custom `aria-describedby` value to form components. The custom value (an element `id`, or list of `id`s separated by a space) will be combined with the generated `id` of the `validationHint` element.
48 changes: 48 additions & 0 deletions packages/circuit-ui/components/Checkbox/Checkbox.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,54 @@ describe('Checkbox', () => {

expect(inputEl).toHaveAccessibleDescription(description);
});

it('should accept a custom description via aria-describedby', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const { getByRole } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<Checkbox
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByRole('checkbox');

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(customDescription);
});

it('should accept a custom description in addition to a validationHint', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const description = 'Description';
const { getByRole } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<Checkbox
validationHint={description}
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByRole('checkbox');

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(
`${customDescription} ${description}`,
);
});
});

describe('Status messages', () => {
Expand Down
8 changes: 6 additions & 2 deletions packages/circuit-ui/components/Checkbox/Checkbox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,20 +175,24 @@ export const Checkbox = forwardRef(
onChange,
children,
value,
id: customId,
'id': customId,
name,
disabled,
validationHint,
className,
style,
invalid,
tracking,
'aria-describedby': descriptionId,
...props
}: CheckboxProps,
ref: CheckboxProps['ref'],
) => {
const id = customId || uniqueId('checkbox_');
const validationHintId = uniqueId('validation_hint-');
const descriptionIds = `${
descriptionId ? `${descriptionId} ` : ''
}${validationHintId}`;
Comment on lines +193 to +195
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't think of anything cleaner here. But in the end I think it's pretty clear, and tests also document the reasoning behind this. Feedback welcome.

const handleChange = useClickEvent(onChange, tracking, 'checkbox');

return (
Expand All @@ -202,7 +206,7 @@ export const Checkbox = forwardRef(
disabled={disabled}
invalid={invalid}
ref={ref}
aria-describedby={validationHintId}
aria-describedby={descriptionIds}
onChange={handleChange}
/>
<CheckboxLabel htmlFor={id}>
Expand Down
48 changes: 48 additions & 0 deletions packages/circuit-ui/components/ImageInput/ImageInput.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,54 @@ describe('ImageInput', () => {

expect(inputEl).toHaveAccessibleDescription(description);
});

it('should accept a custom description via aria-describedby', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const { getByLabelText } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<ImageInput
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByLabelText(defaultProps.label);

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(customDescription);
});

it('should accept a custom description in addition to a validationHint', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const description = 'Description';
const { getByLabelText } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<ImageInput
validationHint={description}
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByLabelText(defaultProps.label);

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(
`${customDescription} ${description}`,
);
});
});

describe('Status messages', () => {
Expand Down
10 changes: 7 additions & 3 deletions packages/circuit-ui/components/ImageInput/ImageInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,17 +290,18 @@ export const ImageInput = ({
src,
alt,
size = 'yotta',
id: customId,
'id': customId,
clearButtonLabel,
onChange,
onClear,
disabled,
validationHint,
invalid = false,
loadingLabel,
component: Component,
'component': Component,
className,
style,
'aria-describedby': descriptionId,
...props
}: ImageInputProps): JSX.Element => {
if (
Expand Down Expand Up @@ -330,6 +331,9 @@ export const ImageInput = ({
const inputRef = useRef<HTMLInputElement>(null);
const id = customId || uniqueId('image-input_');
const validationHintId = uniqueId('validation-hint_');
const descriptionIds = `${
descriptionId ? `${descriptionId} ` : ''
}${validationHintId}`;
const [isLoading, setIsLoading] = useState<boolean>(false);
const [isDragging, setDragging] = useState<boolean>(false);
const [previewImage, setPreviewImage] = useState<string>('');
Expand Down Expand Up @@ -429,7 +433,7 @@ export const ImageInput = ({
onClick={handleClick}
disabled={disabled || isLoading}
aria-invalid={invalid && 'true'}
aria-describedby={validationHintId}
aria-describedby={descriptionIds}
{...props}
/>
<Label
Expand Down
44 changes: 44 additions & 0 deletions packages/circuit-ui/components/Input/Input.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,50 @@ describe('Input', () => {

expect(inputEl).toHaveAccessibleDescription(description);
});

it('should accept a custom description via aria-describedby', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const { getByRole } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<Input aria-describedby={customDescriptionId} {...defaultProps} />,
</>,
);
const inputEl = getByRole('textbox');

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(customDescription);
});

it('should accept a custom description in addition to a validationHint', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const description = 'Description';
const { getByRole } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<Input
validationHint={description}
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByRole('textbox');

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(
`${customDescription} ${description}`,
);
});
});

describe('Status messages', () => {
Expand Down
12 changes: 8 additions & 4 deletions packages/circuit-ui/components/Input/Input.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,8 @@ export const Input = forwardRef(
(
{
value,
renderPrefix: RenderPrefix,
renderSuffix: RenderSuffix,
'renderPrefix': RenderPrefix,
'renderSuffix': RenderSuffix,
validationHint,
optionalLabel,
required,
Expand All @@ -253,9 +253,10 @@ export const Input = forwardRef(
as,
label,
hideLabel,
id: customId,
'id': customId,
className,
style,
'aria-describedby': descriptionId,
...props
}: InputProps,
ref: InputProps['ref'],
Expand All @@ -274,6 +275,9 @@ export const Input = forwardRef(

const id = customId || uniqueId('input_');
const validationHintId = uniqueId('validation-hint_');
const descriptionIds = `${
descriptionId ? `${descriptionId} ` : ''
}${validationHintId}`;

const prefix = RenderPrefix && <RenderPrefix css={prefixStyles} />;
const suffix = RenderSuffix && <RenderSuffix css={suffixStyles} />;
Expand All @@ -298,7 +302,7 @@ export const Input = forwardRef(
id={id}
value={value}
ref={ref}
aria-describedby={validationHintId}
aria-describedby={descriptionIds}
invalid={invalid}
aria-invalid={invalid && 'true'}
required={required}
Expand Down
48 changes: 48 additions & 0 deletions packages/circuit-ui/components/RadioButtonGroup/RadioButtonGroup.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,54 @@ describe('RadioButtonGroup', () => {

expect(inputEl).toHaveAccessibleDescription(description);
});

it('should accept a custom description via aria-describedby', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const { getByRole } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<RadioButtonGroup
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByRole('radiogroup');

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(customDescription);
});

it('should accept a custom description in addition to a validationHint', () => {
const customDescription = 'Custom description';
const customDescriptionId = 'customDescriptionId';
const description = 'Description';
const { getByRole } = render(
<>
<span id={customDescriptionId}>{customDescription}</span>
<RadioButtonGroup
validationHint={description}
aria-describedby={customDescriptionId}
{...defaultProps}
/>
,
</>,
);
const inputEl = getByRole('radiogroup');

expect(inputEl).toHaveAttribute(
'aria-describedby',
expect.stringContaining(customDescriptionId),
);
expect(inputEl).toHaveAccessibleDescription(
`${customDescription} ${description}`,
);
});
});

describe('Status messages', () => {
Expand Down
11 changes: 8 additions & 3 deletions packages/circuit-ui/components/RadioButtonGroup/RadioButtonGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ export const RadioButtonGroup = forwardRef(
{
options,
onChange,
value: activeValue,
name: customName,
'value': activeValue,
'name': customName,
label,
invalid,
validationHint,
Expand All @@ -109,6 +109,7 @@ export const RadioButtonGroup = forwardRef(
hideLabel,
optionalLabel,
required,
'aria-describedby': descriptionId,
...props
}: RadioButtonGroupProps,
ref: RadioButtonGroupProps['ref'],
Expand All @@ -125,11 +126,15 @@ export const RadioButtonGroup = forwardRef(
}
const name = customName || uniqueId('radio-button-group_');
const validationHintId = uniqueId('validation-hint_');
const descriptionIds = `${
descriptionId ? `${descriptionId} ` : ''
}${validationHintId}`;

return (
<FieldWrapper
as="fieldset"
role="radiogroup"
aria-describedby={validationHintId}
aria-describedby={descriptionIds}
aria-orientation="vertical"
name={name}
// @ts-expect-error TypeScript isn't smart enough to recognize the `as` prop.
Expand Down
Loading