An open source design system that's fully customizable and agent ready
TypeScript
fix(core): convey Slider required state to assistive tech (#4006)
Baraa Hamodibf5fcfc61ff3
diff --git a/.changeset/slider-required.md b/.changeset/slider-required.mdnew file mode 100644index 0000000000..23fc0323bf--- /dev/null+++ b/.changeset/slider-required.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[fix] Slider: required sliders now convey the required state to screen readers through the thumb's accessible description (aria-required is invalid on the slider role).++@bhamodidiff --git a/packages/core/src/Slider/Slider.test.tsx b/packages/core/src/Slider/Slider.test.tsxindex 7946c7fbd6..1e676340c8 100644--- a/packages/core/src/Slider/Slider.test.tsx+++ b/packages/core/src/Slider/Slider.test.tsx@@ -155,6 +155,60 @@ describe('Slider', () => {expect(ariaHidden.length).toBeGreaterThanOrEqual(2);});+ // --- Required state ---++ it('conveys required state through the accessible description', () => {+ render(<Slider label="Volume" value={50} isRequired />);+ const slider = screen.getByRole('slider');+ expect(slider).toHaveAccessibleDescription(/Required/);+ // aria-required is not a supported property of role="slider" in+ // WAI-ARIA 1.2, so it must never appear on the thumb.+ expect(slider).not.toHaveAttribute('aria-required');+ });++ it('conveys required state on both thumbs of a range slider', () => {+ render(+ <Slider+ label="Price range"+ value={[20, 80] as [number, number]}+ isRequired+ />,+ );+ const sliders = screen.getAllByRole('slider');+ expect(sliders).toHaveLength(2);+ for (const thumb of sliders) {+ expect(thumb).toHaveAccessibleDescription(/Required/);+ expect(thumb).not.toHaveAttribute('aria-required');+ }+ });++ it('combines required with other describedby parts in the description', () => {+ render(+ <Slider+ label="Volume"+ value={50}+ description="Adjust the volume level"+ isRequired+ />,+ );+ const slider = screen.getByRole('slider');+ expect(slider).toHaveAccessibleDescription(/Adjust the volume level/);+ expect(slider).toHaveAccessibleDescription(/Required/);+ });++ it('does not mention required without isRequired', () => {+ render(+ <Slider+ label="Volume"+ value={50}+ description="Adjust the volume level"+ />,+ );+ const slider = screen.getByRole('slider');+ expect(slider).not.toHaveAccessibleDescription(/Required/);+ expect(slider).not.toHaveAttribute('aria-required');+ });+// --- Disabled guards ---it('disables thumbs when isDisabled is true', () => {@@ -549,7 +603,11 @@ describe('Slider', () => {it('submits both range values under the same name', () => {const {container} = render(<form>- <Slider label="Price" htmlName="price" value={[20, 80] as [number, number]} />+ <Slider+ label="Price"+ htmlName="price"+ value={[20, 80] as [number, number]}+ /></form>,);const data = new FormData(container.querySelector('form')!);@@ -562,7 +620,9 @@ describe('Slider', () => {<Slider label="Volume" htmlName="volume" value={50} isDisabled /></form>,);- expect([...new FormData(container.querySelector('form')!).keys()]).toEqual([]);+ expect([+ ...new FormData(container.querySelector('form')!).keys(),+ ]).toEqual([]);});});});diff --git a/packages/core/src/Slider/Slider.tsx b/packages/core/src/Slider/Slider.tsxindex 6bc825b16b..1edb96b7a8 100644--- a/packages/core/src/Slider/Slider.tsx+++ b/packages/core/src/Slider/Slider.tsx@@ -4,7 +4,7 @@/*** @file Slider.tsx- * @input Uses React, useId, useRef, useCallback, Field, Tooltip, useTooltip+ * @input Uses React, useId, useRef, useCallback, Field, Tooltip, useTooltip, VisuallyHidden* @output Exports Slider component, SliderProps, SliderSingleProps, SliderRangeProps, SliderBaseProps* @position Core implementation; consumed by index.ts, tested by Slider.test.tsx*@@ -38,6 +38,7 @@ import {import {Field} from '../Field/Field';import {Tooltip} from '../Tooltip/Tooltip';import {useTooltip} from '../Tooltip';+import {VisuallyHidden} from '../VisuallyHidden';import type {InputStatus} from '../Field/types';import {mergeProps, mergeRefs} from '../utils';import type {BaseProps} from '../BaseProps';@@ -393,6 +394,7 @@ export function Slider({ref, ...props}: SliderProps) {const id = useId();const descriptionID = useId();const statusMessageID = useId();+ const requiredID = useId();const trackRef = useRef<HTMLDivElement>(null);const draggingThumbRef = useRef<number | null>(null);@@ -412,6 +414,12 @@ export function Slider({ref, ...props}: SliderProps) {isEnabled: showsDisabledMessage,});+ // Required state. `aria-required` is not a supported property of+ // role="slider" in WAI-ARIA 1.2, so the thumb instead points its+ // aria-describedby at a visually hidden "Required" span — mirroring the+ // Field label's visible indicator (where isOptional takes precedence).+ const conveysRequired = isRequired && !isOptional;+// Build aria-describedbyconst describedByParts: string[] = [];if (description) {@@ -420,6 +428,9 @@ export function Slider({ref, ...props}: SliderProps) {if (status?.message) {describedByParts.push(statusMessageID);}+ if (conveysRequired) {+ describedByParts.push(requiredID);+ }if (showsDisabledMessage) {describedByParts.push(disabledMessageTooltip.describedBy);}@@ -921,6 +932,9 @@ export function Slider({ref, ...props}: SliderProps) {{textDisplay}</div>+ {conveysRequired && (+ <VisuallyHidden id={requiredID}>Required</VisuallyHidden>+ )}{showsDisabledMessage &&disabledMessageTooltip.renderTooltip(disabledMessage)}</Field>