Skip to content

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

TypeScript

fix(core): disabled SideNavItem rows and collapsed leaves no longer run a caller's handlers (#10037)

Parinith1aeaf6e1e08e
diff --git a/.changeset/sidenavitem-disabled-caller-handlers.md b/.changeset/sidenavitem-disabled-caller-handlers.md
new file mode 100644
index 0000000000..a55752b4fe
--- /dev/null
+++ b/.changeset/sidenavitem-disabled-caller-handlers.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] A disabled `SideNavItem` no longer runs a caller's `onKeyDown`, `onKeyUp`, `onPointerDown`, `onMouseDown` or any other `on*` prop except `onFocus` and `onBlur`. Before, a key other than Enter or Space on a disabled item still reached `onKeyDown`, every key reached `onKeyUp`, and pointer or mouse input that bypasses `pointer-events: none` (programmatic or assistive-technology input) reached `onPointerDown` and `onMouseDown`. This covers the plain, link, collapsed leaf and split-row forms; the flyout trigger of a collapsed parent item is not covered. Now a disabled `SideNavItem` runs no caller handler other than `onFocus` and `onBlur`, as a disabled `Slider`, `TextInput` and `TextArea` do (`spec:AST-085` FR2). An enabled `SideNavItem` is unchanged. No API changes.
+
+@parinith-web
diff --git a/packages/core/src/SideNav/SideNav.test.tsx b/packages/core/src/SideNav/SideNav.test.tsx
index 7ba5905e84..47e3694612 100644
--- a/packages/core/src/SideNav/SideNav.test.tsx
+++ b/packages/core/src/SideNav/SideNav.test.tsx
@@ -1005,6 +1005,66 @@ describe('SideNavItem', () => {
expect(handleClick).not.toHaveBeenCalled();
});
+ it.each([
+ ['button item', {}],
+ ['item with href', {href: '/dashboard'}],
+ ])(
+ 'does not run a caller’s handlers other than focus and blur on a disabled %s',
+ (_name, extraProps) => {
+ const onKeyDown = vi.fn();
+ const onKeyUp = vi.fn();
+ const onPointerDown = vi.fn();
+ const onMouseDown = vi.fn();
+ const onFocus = vi.fn();
+ const onBlur = vi.fn();
+ render(
+ <SideNavItem
+ label="Dashboard"
+ isDisabled
+ onKeyDown={onKeyDown}
+ onKeyUp={onKeyUp}
+ onPointerDown={onPointerDown}
+ onMouseDown={onMouseDown}
+ onFocus={onFocus}
+ onBlur={onBlur}
+ {...extraProps}
+ />,
+ );
+ const button = screen.getByRole('button', {name: 'Dashboard'});
+ // fireEvent bypasses `pointer-events: none`, as programmatic input does.
+ fireEvent.pointerDown(button);
+ fireEvent.mouseDown(button);
+ fireEvent.keyDown(button, {key: 'x'});
+ fireEvent.keyUp(button, {key: 'x'});
+ expect(onPointerDown).not.toHaveBeenCalled();
+ expect(onMouseDown).not.toHaveBeenCalled();
+ expect(onKeyDown).not.toHaveBeenCalled();
+ expect(onKeyUp).not.toHaveBeenCalled();
+ fireEvent.focus(button);
+ fireEvent.blur(button);
+ expect(onFocus).toHaveBeenCalledTimes(1);
+ expect(onBlur).toHaveBeenCalledTimes(1);
+ },
+ );
+
+ it('still runs an enabled item’s caller handlers', () => {
+ const onKeyDown = vi.fn();
+ const onPointerDown = vi.fn();
+ render(
+ <SideNavItem
+ label="Dashboard"
+ onClick={() => {}}
+ onKeyDown={onKeyDown}
+ onPointerDown={onPointerDown}
+ />,
+ );
+ const button = screen.getByRole('button', {name: 'Dashboard'});
+ fireEvent.pointerDown(button);
+ fireEvent.keyDown(button, {key: 'x'});
+ expect(onPointerDown).toHaveBeenCalledTimes(1);
+ expect(onKeyDown).toHaveBeenCalledTimes(1);
+ });
+
it('renders a disabled item with href as a focusable button that does not navigate', () => {
const handleClick = vi.fn();
render(
@@ -1024,6 +1084,39 @@ describe('SideNavItem', () => {
expect(handleClick).not.toHaveBeenCalled();
});
+ it('does not run a caller’s handlers other than focus and blur on a disabled split row', () => {
+ const onKeyDown = vi.fn();
+ const onKeyUp = vi.fn();
+ const onPointerDown = vi.fn();
+ const onFocus = vi.fn();
+ const onBlur = vi.fn();
+ render(
+ <SideNavItem
+ label="Settings"
+ href="/settings"
+ collapsible
+ isDisabled
+ onKeyDown={onKeyDown}
+ onKeyUp={onKeyUp}
+ onPointerDown={onPointerDown}
+ onFocus={onFocus}
+ onBlur={onBlur}>
+ <SideNavItem label="General" href="/settings/general" />
+ </SideNavItem>,
+ );
+ const primary = screen.getByRole('button', {name: 'Settings'});
+ fireEvent.pointerDown(primary);
+ fireEvent.keyDown(primary, {key: 'x'});
+ fireEvent.keyUp(primary, {key: 'x'});
+ expect(onPointerDown).not.toHaveBeenCalled();
+ expect(onKeyDown).not.toHaveBeenCalled();
+ expect(onKeyUp).not.toHaveBeenCalled();
+ fireEvent.focus(primary);
+ fireEvent.blur(primary);
+ expect(onFocus).toHaveBeenCalledTimes(1);
+ expect(onBlur).toHaveBeenCalledTimes(1);
+ });
+
it('exposes aria-disabled on the primary of a disabled split row', () => {
render(
<SideNavItem label="Settings" href="/settings" collapsible isDisabled>
@@ -1599,6 +1692,37 @@ function renderExpanded(ui: React.ReactElement) {
// =============================================================================
describe('SideNavItem (collapsed)', () => {
+ it('does not run a caller’s handlers other than focus and blur on a disabled collapsed leaf', () => {
+ const onKeyDown = vi.fn();
+ const onKeyUp = vi.fn();
+ const onPointerDown = vi.fn();
+ const onFocus = vi.fn();
+ const onBlur = vi.fn();
+ renderCollapsed(
+ <SideNavItem
+ label="Dashboard"
+ icon={<StubIcon />}
+ isDisabled
+ onKeyDown={onKeyDown}
+ onKeyUp={onKeyUp}
+ onPointerDown={onPointerDown}
+ onFocus={onFocus}
+ onBlur={onBlur}
+ />,
+ );
+ const leaf = screen.getByRole('button', {name: 'Dashboard'});
+ fireEvent.pointerDown(leaf);
+ fireEvent.keyDown(leaf, {key: 'x'});
+ fireEvent.keyUp(leaf, {key: 'x'});
+ expect(onPointerDown).not.toHaveBeenCalled();
+ expect(onKeyDown).not.toHaveBeenCalled();
+ expect(onKeyUp).not.toHaveBeenCalled();
+ fireEvent.focus(leaf);
+ fireEvent.blur(leaf);
+ expect(onFocus).toHaveBeenCalledTimes(1);
+ expect(onBlur).toHaveBeenCalledTimes(1);
+ });
+
it('hides items without icons when collapsed', () => {
const {container} = renderCollapsed(<SideNavItem label="No Icon Item" />);
expect(screen.queryByText('No Icon Item')).not.toBeInTheDocument();
diff --git a/packages/core/src/SideNav/SideNavItem.tsx b/packages/core/src/SideNav/SideNavItem.tsx
index caec17ef76..00b36b020c 100644
--- a/packages/core/src/SideNav/SideNavItem.tsx
+++ b/packages/core/src/SideNav/SideNavItem.tsx
@@ -74,7 +74,10 @@ import {
import {useSideNavRenderMode} from './SideNavRenderContext';
import {useCloseMobileDrawerOnActivate} from '../AppShell/useCloseMobileDrawerOnActivate';
import {themeProps} from '../utils/themeProps';
-import {disabledInteractionProps} from '../utils/disabledInteraction';
+import {
+ disabledInteractionProps,
+ withholdCallerHandlers,
+} from '../utils/disabledInteraction';
import {useMergedRefs} from '../hooks/useMergedRefs';
import {SideNavFocusTargetsContext} from './SideNavFocusTargetsContext';
@@ -362,14 +365,13 @@ function NavItemElement({
ref={ref as React.Ref<HTMLButtonElement>}
type="button"
onClick={onClick}
- {...rest}
+ // A disabled item keeps its tab stop, so the browser still sends it events.
+ // It runs no caller handler except `onFocus` and `onBlur`.
+ {...withholdCallerHandlers(rest, !!isDisabled)}
{...(isDisabled
? {
'aria-disabled': true,
- ...disabledInteractionProps(
- rest.onKeyDown as
- React.KeyboardEventHandler<HTMLButtonElement> | undefined,
- ),
+ ...disabledInteractionProps<HTMLButtonElement>(),
}
: null)}>
{children}