An open source design system that's fully customizable and agent ready
TypeScript
fix(core)!: apply pass-through props on four non-field BaseProps components (#7331)
Cindy Zhang43635fa9d54f
diff --git a/.changeset/baseprops-passthrough-nonfield.md b/.changeset/baseprops-passthrough-nonfield.mdnew file mode 100644index 0000000000..7b48993060--- /dev/null+++ b/.changeset/baseprops-passthrough-nonfield.md@@ -0,0 +1,11 @@+---+'@astryxdesign/core': minor+---++[breaking] Layout, MetadataList, NavHeadingMenuItem and TopNavMegaMenuItem now apply the BaseProps they accept (id, role, aria-\*, data-\*, hidden, inert, dir, event handlers; TopNavMegaMenuItem also xstyle/className/style) instead of silently dropping them; NavHeadingMenu keeps arrow navigation when an item handler cancels.++Migration: remove any of those props you passed that you relied on being ignored; a TopNavMegaMenuItem styled through xstyle/className/style now shows that styling.++From #5656 by @harjothkhara.++@harjothkharadiff --git a/packages/core/src/Layout/Layout.test.tsx b/packages/core/src/Layout/Layout.test.tsxindex 94401f4821..6516d2f3ed 100644--- a/packages/core/src/Layout/Layout.test.tsx+++ b/packages/core/src/Layout/Layout.test.tsx@@ -346,4 +346,30 @@ describe('Layout', () => {expect(root(container).style.outline).toBe('1px solid red');});});++ describe('pass-through props', () => {+ it('forwards pass-through props to the root element', () => {+ const {container} = render(+ <Layout+ aria-label="Records workspace"+ id="records-layout"+ data-testid="layout-root"+ data-zone="admin"+ content={<div>c</div>}+ />,+ );+ const el = root(container);+ expect(el).toHaveAttribute('aria-label', 'Records workspace');+ expect(el).toHaveAttribute('id', 'records-layout');+ expect(el).toHaveAttribute('data-testid', 'layout-root');+ expect(el).toHaveAttribute('data-zone', 'admin');+ });++ it('keeps component-owned theme metadata over a colliding pass-through', () => {+ const {container} = render(+ <Layout height="fill" data-height="auto" content={<div>c</div>} />,+ );+ expect(root(container)).toHaveAttribute('data-height', 'fill');+ });+ });});diff --git a/packages/core/src/Layout/Layout.tsx b/packages/core/src/Layout/Layout.tsxindex 5c15a43b3c..c30c23f30e 100644--- a/packages/core/src/Layout/Layout.tsx+++ b/packages/core/src/Layout/Layout.tsx@@ -336,6 +336,7 @@ export function Layout({xstyle,className,style,+ ...restProps}: LayoutProps) {const isFill = height === 'fill';// Children are a shorthand for the content slot; an explicit `content` prop@@ -364,6 +365,7 @@ export function Layout({const tree = (<LayoutSlotsContext value={slotsValue}><div+ {...restProps}ref={ref}{...mergeProps(themeProps('layout', {height}),diff --git a/packages/core/src/MetadataList/MetadataList.test.tsx b/packages/core/src/MetadataList/MetadataList.test.tsxindex 4b3f66fe92..ea8e373eb0 100644--- a/packages/core/src/MetadataList/MetadataList.test.tsx+++ b/packages/core/src/MetadataList/MetadataList.test.tsx@@ -298,3 +298,48 @@ describe('MetadataListItem pass-through target', () => {expect(handleClick).toHaveBeenCalledOnce();});});++describe('MetadataList pass-through props', () => {+ it('forwards pass-through props to the root element', () => {+ render(+ <MetadataList+ aria-label="Record details"+ id="record-meta"+ data-source="crm"+ data-testid="list">+ <MetadataListItem label="Owner">Alice</MetadataListItem>+ </MetadataList>,+ );+ const rootEl = screen.getByTestId('list');+ expect(rootEl).toHaveAttribute('aria-label', 'Record details');+ expect(rootEl).toHaveAttribute('id', 'record-meta');+ expect(rootEl).toHaveAttribute('data-source', 'crm');+ });++ it('forwards event handlers to the root element', () => {+ const handleClick = vi.fn();+ render(+ <MetadataList onClick={handleClick} data-testid="list">+ <MetadataListItem label="Owner">Alice</MetadataListItem>+ </MetadataList>,+ );+ fireEvent.click(screen.getByTestId('list'));+ expect(handleClick).toHaveBeenCalledOnce();+ });++ it('keeps component-owned theme metadata over colliding pass-throughs', () => {+ render(+ <MetadataList+ columns={2}+ orientation="horizontal"+ data-columns="99"+ data-orientation="vertical"+ data-testid="list">+ <MetadataListItem label="Owner">Alice</MetadataListItem>+ </MetadataList>,+ );+ const rootEl = screen.getByTestId('list');+ expect(rootEl).toHaveAttribute('data-columns', '2');+ expect(rootEl).toHaveAttribute('data-orientation', 'horizontal');+ });+});diff --git a/packages/core/src/MetadataList/MetadataList.tsx b/packages/core/src/MetadataList/MetadataList.tsxindex 61e24fdc81..1f8cef1cb7 100644--- a/packages/core/src/MetadataList/MetadataList.tsx+++ b/packages/core/src/MetadataList/MetadataList.tsx@@ -200,6 +200,7 @@ export function MetadataList({style,'data-testid': testId,ref,+ ...restProps}: MetadataListProps) {const isMultiColumn =columns === 'multi' || (typeof columns === 'number' && columns > 1);@@ -281,6 +282,7 @@ export function MetadataList({return (<MetadataListContext value={contextValue}><div+ {...restProps}ref={ref}data-testid={testId}{...mergeProps(diff --git a/packages/core/src/NavMenu/NavHeadingMenu.test.tsx b/packages/core/src/NavMenu/NavHeadingMenu.test.tsxindex 37704cf802..4c9eac2238 100644--- a/packages/core/src/NavMenu/NavHeadingMenu.test.tsx+++ b/packages/core/src/NavMenu/NavHeadingMenu.test.tsx@@ -1,6 +1,7 @@// Copyright (c) Meta Platforms, Inc. and affiliates.import {describe, it, expect, vi} from 'vitest';+import type {KeyboardEvent} from 'react';import {render, screen, fireEvent} from '@testing-library/react';import userEvent from '@testing-library/user-event';import {NavHeadingMenu} from './NavHeadingMenu';@@ -147,6 +148,39 @@ describe('NavHeadingMenuItem', () => {});describe('keyboard navigation', () => {+ it('keeps arrow navigation when an item handler cancels', () => {+ const onKeyDown = vi.fn((event: KeyboardEvent) => event.preventDefault());+ render(+ <NavHeadingMenu>+ <NavHeadingMenuItem label="First" onKeyDown={onKeyDown} />+ <NavHeadingMenuItem label="Second" />+ </NavHeadingMenu>,+ );+ const [first, second] = screen.getAllByRole('menuitem');+ first.focus();+ fireEvent.keyDown(first, {key: 'ArrowDown'});+ expect(onKeyDown).toHaveBeenCalledOnce();+ expect(second).toHaveFocus();+ });++ it.each(['onKeyDown', 'onKeyDownCapture'] as const)(+ 'preserves menu-level cancellation through %s',+ handler => {+ const cancel = vi.fn((event: KeyboardEvent) => event.preventDefault());+ render(+ <NavHeadingMenu {...{[handler]: cancel}}>+ <NavHeadingMenuItem label="First" />+ <NavHeadingMenuItem label="Second" />+ </NavHeadingMenu>,+ );+ const first = screen.getAllByRole('menuitem')[0];+ first.focus();+ fireEvent.keyDown(first, {key: 'ArrowDown'});+ expect(cancel).toHaveBeenCalledOnce();+ expect(first).toHaveFocus();+ },+ );+it('moves focus with arrow keys', async () => {const user = userEvent.setup();render(@@ -351,3 +385,56 @@ describe('NavHeadingMenu pass-through props', () => {expect(items[1]).toHaveFocus();});});++describe('NavHeadingMenuItem pass-through props', () => {+ it('forwards pass-through props to the item element', () => {+ render(+ <NavHeadingMenu>+ <NavHeadingMenuItem+ label="Dashboard"+ aria-label="Open dashboard"+ id="nav-dashboard"+ data-tracking="nav-item"+ data-testid="item"+ />+ </NavHeadingMenu>,+ );+ const item = screen.getByTestId('item');+ expect(item).toHaveAttribute('aria-label', 'Open dashboard');+ expect(item).toHaveAttribute('id', 'nav-dashboard');+ expect(item).toHaveAttribute('data-tracking', 'nav-item');+ });++ it('forwards event handlers to the item element', () => {+ const handleMouseEnter = vi.fn();+ render(+ <NavHeadingMenu>+ <NavHeadingMenuItem+ label="Dashboard"+ onMouseEnter={handleMouseEnter}+ data-testid="item"+ />+ </NavHeadingMenu>,+ );+ fireEvent.mouseEnter(screen.getByTestId('item'));+ expect(handleMouseEnter).toHaveBeenCalledOnce();+ });++ it('keeps the menuitem contract over colliding pass-throughs', () => {+ render(+ <NavHeadingMenu>+ <NavHeadingMenuItem+ label="Dashboard"+ data-testid="item"+ role="button"+ aria-disabled="false"+ isDisabled+ />+ </NavHeadingMenu>,+ );+ // Owned role and aria-disabled win over the colliding pass-throughs.+ const item = screen.getByTestId('item');+ expect(item).toHaveAttribute('role', 'menuitem');+ expect(item).toHaveAttribute('aria-disabled', 'true');+ });+});diff --git a/packages/core/src/NavMenu/NavHeadingMenu.tsx b/packages/core/src/NavMenu/NavHeadingMenu.tsxindex 4bd5751e83..d70cc7ba25 100644--- a/packages/core/src/NavMenu/NavHeadingMenu.tsx+++ b/packages/core/src/NavMenu/NavHeadingMenu.tsx@@ -4,7 +4,7 @@/*** @file NavHeadingMenu.tsx- * @input Uses React, StyleX, useListFocus, NavMenuContext+ * @input Uses React, StyleX, useListFocus, NavMenuContext, and capture-phase cancellation tracking* @output Exports NavHeadingMenu component and NavHeadingMenuProps type* @position Core implementation; consumed by index.ts*@@ -12,10 +12,10 @@* - /packages/core/src/NavMenu/index.ts*/-import React, {useCallback, useMemo, type ReactNode} from 'react';+import React, {useCallback, useMemo, useRef, type ReactNode} from 'react';import * as stylex from '@stylexjs/stylex';import {spacingVars} from '../theme/tokens.stylex';-import {composeEventHandlers, mergeProps} from '../utils';+import {mergeProps} from '../utils';import type {BaseProps} from '../BaseProps';import {useListFocus} from '../hooks/useListFocus';import {useTypeahead} from '../hooks/useTypeahead';@@ -97,6 +97,7 @@ export function NavHeadingMenu({style: styleProp,'data-testid': testId,onKeyDown: onKeyDownProp,+ onKeyDownCapture: onKeyDownCaptureProp,...rest}: NavHeadingMenuProps) {const closeCtx = useNavHeadingCloseContext();@@ -162,6 +163,25 @@ export function NavHeadingMenu({const inlineStyle = minWidth != null ? {...styleProp, minWidth} : styleProp;+ const preventedBeforeDescendantsRef = useRef(new WeakSet<Event>());+ const handleMenuKeyDownCapture = (+ event: React.KeyboardEvent<HTMLDivElement>,+ ) => {+ onKeyDownCaptureProp?.(event);+ if (event.defaultPrevented) {+ preventedBeforeDescendantsRef.current.add(event.nativeEvent);+ }+ };+ const handleMenuKeyDown = (event: React.KeyboardEvent<HTMLDivElement>) => {+ const wasPreventedByDescendant =+ event.defaultPrevented &&+ !preventedBeforeDescendantsRef.current.has(event.nativeEvent);+ onKeyDownProp?.(event);+ if (wasPreventedByDescendant || !event.defaultPrevented) {+ listKeyDown(event);+ }+ };+return (<NavHeadingMenuContext value={ctx}><div@@ -175,7 +195,8 @@ export function NavHeadingMenu({)}{...rest}role="menu"- onKeyDown={composeEventHandlers(onKeyDownProp, listKeyDown)}>+ onKeyDownCapture={handleMenuKeyDownCapture}+ onKeyDown={handleMenuKeyDown}>{children}</div></NavHeadingMenuContext>diff --git a/packages/core/src/NavMenu/NavHeadingMenuItem.tsx b/packages/core/src/NavMenu/NavHeadingMenuItem.tsxindex 22bbcc043e..d3e253bbe8 100644--- a/packages/core/src/NavMenu/NavHeadingMenuItem.tsx+++ b/packages/core/src/NavMenu/NavHeadingMenuItem.tsx@@ -130,6 +130,7 @@ export function NavHeadingMenuItem({className,style,'data-testid': testId,+ ...restProps}: NavHeadingMenuItemProps) {const ctx = useNavHeadingMenuContext();const size = ctx?.size ?? 'md';@@ -147,6 +148,7 @@ export function NavHeadingMenuItem({return (<Element+ {...restProps}ref={ref}role="menuitem"tabIndex={isDisabled ? undefined : -1}diff --git a/packages/core/src/TopNav/TopNavMegaMenu.test.tsx b/packages/core/src/TopNav/TopNavMegaMenu.test.tsxindex 584f015e60..a4961743c4 100644--- a/packages/core/src/TopNav/TopNavMegaMenu.test.tsx+++ b/packages/core/src/TopNav/TopNavMegaMenu.test.tsx@@ -964,3 +964,122 @@ describe('TopNavMegaMenu — owned handlers on the trigger', () => {expect(trigger).toHaveAttribute('aria-expanded', 'true');});});++describe('TopNavMegaMenuItem pass-through props', () => {+ it('forwards pass-through props in default mode', () => {+ render(+ <TopNavMegaMenuItem+ title="Analytics"+ aria-label="Open analytics"+ id="mega-analytics"+ data-tracking="mega-item"+ data-testid="item"+ />,+ );+ const item = screen.getByTestId('item');+ expect(item).toHaveAttribute('aria-label', 'Open analytics');+ expect(item).toHaveAttribute('id', 'mega-analytics');+ expect(item).toHaveAttribute('data-tracking', 'mega-item');+ });++ it('forwards event handlers in default mode', () => {+ const handleMouseEnter = vi.fn();+ render(+ <TopNavMegaMenuItem+ title="Analytics"+ onMouseEnter={handleMouseEnter}+ data-testid="item"+ />,+ );+ fireEvent.mouseEnter(screen.getByTestId('item'));+ expect(handleMouseEnter).toHaveBeenCalledOnce();+ });++ it('forwards pass-through props in drawer mode', () => {+ render(+ <TopNavRenderContext value="drawer">+ <TopNavMegaMenuItem+ title="Analytics"+ data-tracking="mega-item"+ data-testid="item"+ />+ </TopNavRenderContext>,+ );+ expect(screen.getByTestId('item')).toHaveAttribute(+ 'data-tracking',+ 'mega-item',+ );+ });++ it('composes consumer styling and forwards tabIndex in drawer mode', () => {+ render(+ <TopNavRenderContext value="drawer">+ <TopNavMegaMenuItem+ title="Analytics"+ className="consumer-item"+ style={{outlineColor: 'red'}}+ tabIndex={-1}+ data-testid="item"+ />+ </TopNavRenderContext>,+ );+ const item = screen.getByTestId('item');+ expect(item).toHaveClass('consumer-item');+ expect(item.style.outlineColor).toBe('red');+ expect(item).toHaveAttribute('tabindex', '-1');+ });++ it('composes consumer styling in default mode', () => {+ render(+ <TopNavMegaMenuItem+ title="Analytics"+ className="consumer-item"+ style={{outlineColor: 'red'}}+ data-testid="item"+ />,+ );+ const item = screen.getByTestId('item');+ expect(item).toHaveClass('consumer-item');+ // The internal classes are still applied alongside the consumer's.+ expect(item.className.split(' ').length).toBeGreaterThan(1);+ expect(item.style.outlineColor).toBe('red');+ });++ it('applies xstyle as extra classes in both modes', () => {+ const xstyleTestStyles = stylex.create({+ custom: {marginInlineEnd: '7px'},+ });+ const renderBoth = (xstyle?: (typeof xstyleTestStyles)['custom']) => (+ <>+ <TopNavMegaMenuItem+ title="Analytics"+ xstyle={xstyle}+ data-testid="default-item"+ />+ <TopNavRenderContext value="drawer">+ <TopNavMegaMenuItem+ title="Analytics"+ xstyle={xstyle}+ data-testid="drawer-item"+ />+ </TopNavRenderContext>+ </>+ );+ const {rerender} = render(renderBoth());+ const defaultWithout = screen+ .getByTestId('default-item')+ .getAttribute('class');+ const drawerWithout = screen+ .getByTestId('drawer-item')+ .getAttribute('class');++ // xstyle values are compiled StyleX styles; passing one adds classes.+ rerender(renderBoth(xstyleTestStyles.custom));+ expect(+ screen.getByTestId('default-item').getAttribute('class'),+ ).not.toEqual(defaultWithout);+ expect(screen.getByTestId('drawer-item').getAttribute('class')).not.toEqual(+ drawerWithout,+ );+ });+});diff --git a/packages/core/src/TopNav/TopNavMegaMenuItem.tsx b/packages/core/src/TopNav/TopNavMegaMenuItem.tsxindex c38cde52ae..4037264b2f 100644--- a/packages/core/src/TopNav/TopNavMegaMenuItem.tsx+++ b/packages/core/src/TopNav/TopNavMegaMenuItem.tsx@@ -191,6 +191,10 @@ export function TopNavMegaMenuItem({onClick,as,tabIndex,+ xstyle,+ className,+ style,+ ...restProps}: TopNavMegaMenuItemProps) {const pressable = usePressFeedback();const renderMode = useTopNavRenderMode();@@ -209,10 +213,12 @@ export function TopNavMegaMenuItem({};return (<Element+ {...restProps}ref={ref}href={href}{...pressable}onClick={handleDrawerClick}+ tabIndex={tabIndex}{...elementProps}{...mergeProps(themeProps('top-nav-mega-menu-item', {mode: 'drawer'}),@@ -220,7 +226,10 @@ export function TopNavMegaMenuItem({navItemStyles.item,interactionOverlayStyles.backgroundColor,styles.drawerItem,+ xstyle,),+ className,+ style,)}>{icon && <div {...stylex.props(styles.drawerItemIcon)}>{icon}</div>}<div {...stylex.props(styles.drawerItemContent)}>@@ -241,6 +250,7 @@ export function TopNavMegaMenuItem({const Element = href ? LinkComponent : 'div';return (<Element+ {...restProps}ref={ref}href={href}{...pressable}@@ -251,7 +261,10 @@ export function TopNavMegaMenuItem({focusOutlineProps.focusVisible(styles.desktop,interactionOverlayStyles.backgroundColor,+ xstyle,),+ className,+ style,)}>{icon && <div {...stylex.props(styles.desktopIcon)}>{icon}</div>}<div {...stylex.props(styles.desktopContent)}>diff --git a/packages/core/src/hooks/useAnnounce.test.tsx b/packages/core/src/hooks/useAnnounce.test.tsxindex bf10ad8603..9a3248aafa 100644--- a/packages/core/src/hooks/useAnnounce.test.tsx+++ b/packages/core/src/hooks/useAnnounce.test.tsx@@ -25,6 +25,65 @@ function assertiveRegion(): HTMLElement | null {}describe('useAnnounce', () => {+ it.each(['polite', 'assertive'] as const)(+ 'cancels every queued %s write when cleared',+ politeness => {+ vi.useFakeTimers();+ try {+ const {result} = renderHook(() => useAnnounce());+ result.current('First', politeness);+ result.current('Second', politeness);+ const region =+ politeness === 'polite' ? politeRegion()! : assertiveRegion()!;+ const write = vi.spyOn(region, 'textContent', 'set');+ result.current('', politeness);+ act(() => {+ vi.advanceTimersByTime(50);+ });+ expect(write.mock.calls).toEqual([['']]);+ write.mockRestore();+ } finally {+ vi.useRealTimers();+ }+ },+ );++ it('preserves multiple same-frame announcements until explicitly cleared', () => {+ vi.useFakeTimers();+ try {+ const {result} = renderHook(() => useAnnounce());+ result.current('First');+ result.current('Second');+ const write = vi.spyOn(politeRegion()!, 'textContent', 'set');+ act(() => {+ vi.advanceTimersByTime(50);+ });+ expect(write.mock.calls).toEqual([['First'], ['Second']]);+ write.mockRestore();+ } finally {+ vi.useRealTimers();+ }+ });++ it('cancels queued writes on reset', () => {+ vi.useFakeTimers();+ try {+ const {result} = renderHook(() => useAnnounce());+ result.current('Saved');+ result.current('Failed', 'assertive');+ const polite = politeRegion()!;+ const assertive = assertiveRegion()!;+ __resetLiveRegionsForTest();+ act(() => {+ vi.advanceTimersByTime(50);+ });+ expect(polite.textContent).toBe('');+ expect(assertive.textContent).toBe('');+ } finally {+ vi.useRealTimers();+ }+ });+it('mounts empty polite and assertive live regions on first announce', async () => {const {result} = renderHook(() => useAnnounce());// Regions do not exist until first use.diff --git a/packages/core/src/hooks/useAnnounce.ts b/packages/core/src/hooks/useAnnounce.tsindex 8529396056..c5ea98ad71 100644--- a/packages/core/src/hooks/useAnnounce.ts+++ b/packages/core/src/hooks/useAnnounce.ts@@ -4,7 +4,7 @@/*** @file useAnnounce.ts- * @input Uses React useCallback; DOM APIs for a singleton live-region pair+ * @input Uses React useCallback; DOM APIs and cancellable animation frames for a singleton live-region pair* @output Exports useAnnounce hook and AnnouncePoliteness type* @position Core a11y hook; provides imperative screen-reader announcements* via persistently-mounted polite/assertive live regions; regions are@@ -72,6 +72,18 @@ function cancelScheduledClear(politeness: AnnouncePoliteness): void {}}+const pendingFrames: Record<AnnouncePoliteness, Set<number>> = {+ polite: new Set(),+ assertive: new Set(),+};++function cancelPendingFrames(politeness: AnnouncePoliteness): void {+ for (const frame of pendingFrames[politeness]) {+ cancelAnimationFrame(frame);+ }+ pendingFrames[politeness].clear();+}+function scheduleClear(politeness: AnnouncePoliteness,target: HTMLElement,@@ -136,9 +148,11 @@ function announceMessage(target.textContent = '';// A microtask/rAF-free re-set in the next frame is more reliable across AT// than an immediate re-set, which can be coalesced with the clear.- requestAnimationFrame(() => {+ const frame = requestAnimationFrame(() => {+ pendingFrames[politeness].delete(frame);target.textContent = message;});+ pendingFrames[politeness].add(frame);// Auto-clear so the last message does not linger in the accessibility tree// indefinitely. Scheduled per announce, so a newer announcement always// resets the countdown (the delay comfortably outlasts the rAF re-set).@@ -151,6 +165,7 @@ function announceMessage(* so stale status text does not linger in the accessibility tree.*/function clearRegion(politeness: AnnouncePoliteness): void {+ cancelPendingFrames(politeness);cancelScheduledClear(politeness);if (!regions) {return;@@ -204,6 +219,8 @@ export function useAnnounce(): AnnounceFn {* @internal*/export function __resetLiveRegionsForTest(): void {+ cancelPendingFrames('polite');+ cancelPendingFrames('assertive');cancelScheduledClear('polite');cancelScheduledClear('assertive');if (regions) {