Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(SegmentedControl): keep a caller aria-describedby on the radiogroup (#8784)

홍규진f3c78b28d659
diff --git a/.changeset/segmentedcontrol-caller-describedby.md b/.changeset/segmentedcontrol-caller-describedby.md
new file mode 100644
index 0000000000..5b2d213231
--- /dev/null
+++ b/.changeset/segmentedcontrol-caller-describedby.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] SegmentedControl keeps a caller's `aria-describedby`. The radiogroup always replaced it with the disabled-reason tooltip id, or removed it when no reason showed, so the caller's ids never reached the accessible description. The group is now described by the caller's ids and then the disabled reason, the same order RadioList uses.
+
+@kyu-rong
diff --git a/packages/core/src/SegmentedControl/SegmentedControl.test.tsx b/packages/core/src/SegmentedControl/SegmentedControl.test.tsx
index 1241c8a3ab..4b74bdf1d2 100644
--- a/packages/core/src/SegmentedControl/SegmentedControl.test.tsx
+++ b/packages/core/src/SegmentedControl/SegmentedControl.test.tsx
@@ -849,3 +849,49 @@ describe('pressed state', () => {
);
});
});
+
+describe("SegmentedControl keeps a caller's aria-describedby", () => {
+ it('describes the radiogroup by the caller ids', () => {
+ render(
+ <>
+ <span id="caller-help">Applies to every board</span>
+ <SegmentedControl
+ value="grid"
+ onChange={() => {}}
+ label="View mode"
+ aria-describedby="caller-help">
+ <SegmentedControlItem value="grid" label="Grid" />
+ </SegmentedControl>
+ </>,
+ );
+ expect(screen.getByRole('radiogroup')).toHaveAccessibleDescription(
+ 'Applies to every board',
+ );
+ });
+
+ it('describes the disabled radiogroup by the caller ids and then the reason', () => {
+ render(
+ <>
+ <span id="caller-help">Applies to every board</span>
+ <SegmentedControl
+ value="grid"
+ onChange={() => {}}
+ label="View mode"
+ isDisabled
+ disabledMessage="Choose a project to switch views"
+ aria-describedby="caller-help">
+ <SegmentedControlItem value="grid" label="Grid" />
+ </SegmentedControl>
+ </>,
+ );
+ const ids = screen
+ .getByRole('radiogroup')
+ .getAttribute('aria-describedby')
+ ?.split(' ');
+ expect(ids).toHaveLength(2);
+ expect(ids?.[0]).toBe('caller-help');
+ expect(document.getElementById(ids?.[1] ?? '')).toHaveTextContent(
+ 'Choose a project to switch views',
+ );
+ });
+});
diff --git a/packages/core/src/SegmentedControl/SegmentedControl.tsx b/packages/core/src/SegmentedControl/SegmentedControl.tsx
index 11aca10d3d..f74825d32a 100644
--- a/packages/core/src/SegmentedControl/SegmentedControl.tsx
+++ b/packages/core/src/SegmentedControl/SegmentedControl.tsx
@@ -27,6 +27,7 @@ import type {
SegmentedControlLayout,
} from './SegmentedControlContext';
import {mergeProps, composeEventHandlers} from '../utils';
+import {joinAriaIDs} from '../utils/inputAria';
import {useSize} from '../SizeContext/SizeContext';
import type {BaseProps} from '../BaseProps';
import {themeProps} from '../utils/themeProps';
@@ -173,6 +174,7 @@ export function SegmentedControl({
onKeyDown: onKeyDownProp,
onFocus: onFocusProp,
onBlur: onBlurProp,
+ 'aria-describedby': ariaDescribedByProp,
...rest
}: SegmentedControlProps) {
const size = useSize(sizeProp, 'md');
@@ -281,9 +283,11 @@ export function SegmentedControl({
role="radiogroup"
aria-label={label}
aria-disabled={isDisabled || undefined}
- aria-describedby={
- showsDisabledMessage ? disabledMessageTooltip.describedBy : undefined
- }
+ // A caller aria-describedby comes before the disabled reason.
+ aria-describedby={joinAriaIDs(
+ ariaDescribedByProp,
+ showsDisabledMessage ? disabledMessageTooltip.describedBy : undefined,
+ )}
onKeyDown={handleContainerKeyDown}
onFocus={handleContainerFocus}
onBlur={composeEventHandlers(onBlurProp, hint.onBlur)}