Skip to content

[WC-3114] CheckboxRadio: Validation alert addition #1922

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[WC-3114] CheckboxRadio: Validation alert addition #1922

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
2c21753
fix: update changelog
yordan-st Oct 1, 2025
4c40b40
fix: add validation error ID to CheckboxSelection and RadioSelection
yordan-st Oct 2, 2025
e229a45
chore: apply fix to radioSelection as well
yordan-st Oct 3, 2025
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
4 changes: 4 additions & 0 deletions packages/pluggableWidgets/checkbox-radio-selection-web/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Added

- We added a missing validation alert.

## [1.0.0] - 2025-08-25

### Added
Expand Down
8 changes: 8 additions & 0 deletions ...dgets/checkbox-radio-selection-web/src/components/CheckboxSelection/CheckboxSelection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import classNames from "classnames";
import { createElement, MouseEvent, ReactElement } from "react";
import { MultiSelector, SelectionBaseProps } from "../../helpers/types";
import { getValidationErrorId } from "../../helpers/utils";
import { CaptionContent } from "../CaptionContent";
import { ValidationAlert } from "@mendix/widget-plugin-component-kit/Alert";
import { Placeholder } from "../Placeholder";

export function CheckboxSelection({
Expand All @@ -18,6 +20,9 @@ export function CheckboxSelection({
const isReadOnly = selector.readOnly;
const name = groupName?.value ?? inputId;

const validation = selector.validation;
const errorId = getValidationErrorId(inputId);

const handleChange = (optionId: string, checked: boolean): void => {
if (!isReadOnly) {
const newSelection = checked ? [...currentIds, optionId] : currentIds.filter(id => id !== optionId);
Expand Down Expand Up @@ -55,6 +60,8 @@ export function CheckboxSelection({
disabled={isReadOnly}
tabIndex={tabIndex}
onChange={e => handleChange(optionId, e.target.checked)}
aria-describedby={selector.validation ? errorId : undefined}
Copy link
Collaborator

Choose a reason for hiding this comment

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

difference with combobox,
i think aria-describeby and aria-invalid should be on the component with radiogroup role. not on each input.
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/radiogroup_role

@HedwigAR please confirm.

aria-invalid={selector.validation ? true : undefined}
/>
<CaptionContent
onClick={(e: MouseEvent<HTMLDivElement>) => {
Expand All @@ -71,6 +78,7 @@ export function CheckboxSelection({
);
})}
{options.length === 0 && <Placeholder noOptionsText={noOptionsText} />}
{validation && <ValidationAlert id={errorId}>{validation}</ValidationAlert>}
</div>
);
}
8 changes: 8 additions & 0 deletions ...ableWidgets/checkbox-radio-selection-web/src/components/RadioSelection/RadioSelection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import classNames from "classnames";
import { ChangeEvent, createElement, MouseEvent, ReactElement } from "react";
import { SelectionBaseProps, SingleSelector } from "../../helpers/types";
import { getValidationErrorId } from "../../helpers/utils";
import { CaptionContent } from "../CaptionContent";
import { ValidationAlert } from "@mendix/widget-plugin-component-kit/Alert";
import { Placeholder } from "../Placeholder";
import { If } from "@mendix/widget-plugin-component-kit/If";

Expand All @@ -24,6 +26,9 @@ export function RadioSelection({
const isReadOnly = selector.readOnly;
const name = groupName?.value ?? inputId;

const validation = selector.validation;
const errorId = getValidationErrorId(inputId);

const handleChange = (e: ChangeEvent<HTMLInputElement>): void => {
if (isReadOnly) {
return;
Expand Down Expand Up @@ -70,6 +75,8 @@ export function RadioSelection({
disabled={isReadOnly}
tabIndex={tabIndex}
onChange={handleChange}
aria-describedby={selector.validation ? errorId : undefined}
aria-invalid={selector.validation ? true : undefined}
/>
</If>
<CaptionContent
Expand All @@ -89,6 +96,7 @@ export function RadioSelection({
);
})}
{options.length === 0 && <Placeholder noOptionsText={noOptionsText} />}
{validation && <ValidationAlert id={errorId}>{validation}</ValidationAlert>}
</div>
);
}
4 changes: 4 additions & 0 deletions packages/pluggableWidgets/checkbox-radio-selection-web/src/helpers/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,7 @@ export function getCustomCaption(values: CheckboxRadioSelectionPreviewProps): st
}
return emptyStringFormat;
}

export function getValidationErrorId(inputId?: string): string | undefined {
return inputId ? inputId + "-validation-message" : undefined;
}
Loading