Skip to content

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

TypeScript

fix(core): prevent consumer rest props from clobbering contract props (#3978)

Cindy Zhang768d686435b2
diff --git a/.changeset/fix-rest-prop-clobber.md b/.changeset/fix-rest-prop-clobber.md
new file mode 100644
index 0000000000..d10a200e83
--- /dev/null
+++ b/.changeset/fix-rest-prop-clobber.md
@@ -0,0 +1,8 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] Fix consumer rest props clobbering component contract props in ButtonGroup, Calendar, and Carousel
+
+Components that set `role`, `aria-roledescription`, or `onKeyDown` on their root element now spread `{...rest}` before those props so a consumer cannot accidentally override the component's semantic contract. `onKeyDown` is composed via `composeEventHandlers` so both the consumer's and the component's handlers fire.
+@cixzhang
diff --git a/packages/core/src/ButtonGroup/ButtonGroup.tsx b/packages/core/src/ButtonGroup/ButtonGroup.tsx
index 24298463ce..380bb27ed3 100644
--- a/packages/core/src/ButtonGroup/ButtonGroup.tsx
+++ b/packages/core/src/ButtonGroup/ButtonGroup.tsx
@@ -25,7 +25,7 @@ import * as stylex from '@stylexjs/stylex';
import type {ButtonSize} from '../Button';
import {SizeProvider, useSize} from '../SizeContext/SizeContext';
import {useListFocus} from '../hooks/useListFocus';
-import {mergeProps, mergeRefs} from '../utils';
+import {mergeProps, mergeRefs, composeEventHandlers} from '../utils';
import type {BaseProps} from '../BaseProps';
import {ButtonGroupContext} from './ButtonGroupContext';
import type {ButtonGroupOrientation} from './ButtonGroupContext';
@@ -119,6 +119,7 @@ export function ButtonGroup({
style,
ref,
'data-testid': testId,
+ onKeyDown,
...props
}: ButtonGroupProps): ReactNode {
const size = useSize(sizeProp, 'md');
@@ -138,11 +139,7 @@ export function ButtonGroup({
<SizeProvider value={size}>
<div
ref={mergeRefs(ref, listRef)}
- role="group"
- aria-label={label}
- onKeyDown={handleKeyDown}
- aria-disabled={isDisabled || undefined}
- data-testid={testId}
+ {...props}
{...mergeProps(
themeProps('button-group', {size, orientation}),
stylex.props(
@@ -153,7 +150,11 @@ export function ButtonGroup({
className,
style,
)}
- {...props}>
+ role="group"
+ aria-label={label}
+ onKeyDown={composeEventHandlers(onKeyDown, handleKeyDown)}
+ aria-disabled={isDisabled || undefined}
+ data-testid={testId}>
{children}
</div>
</SizeProvider>
diff --git a/packages/core/src/Calendar/Calendar.tsx b/packages/core/src/Calendar/Calendar.tsx
index 1cbeea1448..54b9479ada 100644
--- a/packages/core/src/Calendar/Calendar.tsx
+++ b/packages/core/src/Calendar/Calendar.tsx
@@ -56,7 +56,7 @@ import {
DATE_FORMAT_WITH_WEEKDAY,
DATE_FORMAT_MONTH_YEAR,
} from '../utils/plainDate';
-import {mergeProps} from '../utils';
+import {mergeProps, composeEventHandlers} from '../utils';
import {
computeDayCellState,
computeRangeRounding,
@@ -218,6 +218,7 @@ export function Calendar({ref, ...props}: CalendarProps) {
xstyle,
className,
style,
+ onKeyDown,
...rest
} = props;
@@ -420,14 +421,14 @@ export function Calendar({ref, ...props}: CalendarProps) {
return (
<div
ref={ref}
+ {...rest}
{...mergeProps(
themeProps('calendar', {mode}),
stylex.props(calendarStyles.calendar, xstyle),
className,
style,
)}
- onKeyDown={handleCalendarKeyDown}
- {...rest}>
+ onKeyDown={composeEventHandlers(onKeyDown, handleCalendarKeyDown)}>
{/* Header with navigation */}
<div {...stylex.props(calendarStyles.header)}>
<Button
diff --git a/packages/core/src/Carousel/Carousel.tsx b/packages/core/src/Carousel/Carousel.tsx
index 69d38da525..4796e11018 100644
--- a/packages/core/src/Carousel/Carousel.tsx
+++ b/packages/core/src/Carousel/Carousel.tsx
@@ -333,16 +333,16 @@ export function Carousel({
<div
ref={mergeRefs(ref, layer.ref as React.Ref<HTMLDivElement>)}
data-testid={testId}
- role="region"
- aria-label={ariaLabel}
- aria-roledescription="carousel"
+ {...htmlProps}
{...mergeProps(
themeProps('carousel'),
stylex.props(styles.root, xstyle),
className,
style,
)}
- {...htmlProps}>
+ role="region"
+ aria-label={ariaLabel}
+ aria-roledescription="carousel">
<div
ref={composedRef}
tabIndex={0}