An open source design system that's fully customizable and agent ready
TypeScript
fix(SideNav): prevent resizable overflow (#6196)
Harjoth Khara7ae694f0b233
diff --git a/.changeset/clip-the-resizable-sidenav-handle-within-the-sid-r265.md b/.changeset/clip-the-resizable-sidenav-handle-within-the-sid-r265.mdnew file mode 100644index 0000000000..8da7667f24--- /dev/null+++ b/.changeset/clip-the-resizable-sidenav-handle-within-the-sid-r265.md@@ -0,0 +1,6 @@+---+'@astryxdesign/core': patch+---++[fix] Clip the resizable SideNav handle within the sidebar bounds+@harjothkharadiff --git a/apps/storybook/stories/SideNav.stories.tsx b/apps/storybook/stories/SideNav.stories.tsxindex f393694a0f..05ed4caa8a 100644--- a/apps/storybook/stories/SideNav.stories.tsx+++ b/apps/storybook/stories/SideNav.stories.tsx@@ -1,6 +1,7 @@// Copyright (c) Meta Platforms, Inc. and affiliates.import type {Meta, StoryObj} from '@storybook/react';+import {AppShell} from '@astryxdesign/core/AppShell';import {SideNav,SideNavHeading,@@ -676,6 +677,88 @@ export const CollapsibleSidebar: Story = {),};+// =============================================================================+// Resizable in AppShell+// =============================================================================++export const ResizableInAppShell: Story = {+ name: 'Resizable in AppShell',+ parameters: {+ layout: 'fullscreen',+ },+ render: () => (+ <AppShell+ contentPadding={6}+ sideNav={+ <SideNav+ resizable+ header={+ <SideNavHeading+ icon={+ <NavIcon icon={<CubeIcon style={{width: 16, height: 16}} />} />+ }+ heading="My App"+ />+ }>+ <SideNavSection title="Main">+ <SideNavItem+ label="Dashboard"+ icon={HomeIcon}+ selectedIcon={HomeIconSolid}+ isSelected+ />+ <SideNavItem label="Projects" icon={FolderIcon} />+ <SideNavItem label="Analytics" icon={ChartBarIcon} />+ </SideNavSection>+ </SideNav>+ }>+ <Text type="body">Drag the sidebar edge to resize the navigation.</Text>+ </AppShell>+ ),+ play: async ({canvasElement}) => {+ await document.fonts.ready;+ await new Promise<void>(resolve =>+ requestAnimationFrame(() => requestAnimationFrame(() => resolve())),+ );++ const nav = canvasElement.querySelector<HTMLElement>('nav');+ const panel = nav?.closest<HTMLElement>('.astryx-app-shell-sidenav');+ const handle = canvasElement.querySelector<HTMLElement>(+ '[data-testid="astryx-sidenav-resize-handle"]',+ );++ if (!panel || !handle) {+ throw new Error('Resizable AppShell fixture did not render as expected');+ }++ if (panel.scrollWidth !== panel.clientWidth) {+ throw new Error(+ `Resizable SideNav overflowed its AppShell panel: clientWidth ${panel.clientWidth}px, scrollWidth ${panel.scrollWidth}px`,+ );+ }++ handle.focus();+ await new Promise<void>(resolve => requestAnimationFrame(() => resolve()));++ const focusStyle = getComputedStyle(handle);+ const outlineWidth = Number.parseFloat(focusStyle.outlineWidth);+ const outlineOffset = Number.parseFloat(focusStyle.outlineOffset);+ if (+ canvasElement.ownerDocument.activeElement !== handle ||+ !handle.matches(':focus-visible') ||+ focusStyle.outlineStyle === 'none' ||+ !Number.isFinite(outlineWidth) ||+ outlineWidth <= 0 ||+ !Number.isFinite(outlineOffset) ||+ outlineOffset > -outlineWidth+ ) {+ throw new Error(+ `Resize handle focus ring was not visibly inset: ${outlineWidth}px ${focusStyle.outlineStyle}, offset ${outlineOffset}px`,+ );+ }+ },+};+// =============================================================================// Iconless Items with Nested Children// =============================================================================diff --git a/packages/core/src/SideNav/SideNav.doc.mjs b/packages/core/src/SideNav/SideNav.doc.mjsindex e809ce5bcb..aeb192de53 100644--- a/packages/core/src/SideNav/SideNav.doc.mjs+++ b/packages/core/src/SideNav/SideNav.doc.mjs@@ -25,7 +25,7 @@ export const docs = {{className: 'astryx-side-nav-section'},],},- description: 'Container with five zones: header, topContent, children (scrollable), footer, and footerIcons. Supports collapsible mode.',+ description: 'Container with five zones: header, topContent, children (scrollable), footer, and footerIcons. Supports collapsible and resizable modes.',props: [{name: 'header',diff --git a/packages/core/src/SideNav/SideNav.test.tsx b/packages/core/src/SideNav/SideNav.test.tsxindex de31cbc867..165f6a4168 100644--- a/packages/core/src/SideNav/SideNav.test.tsx+++ b/packages/core/src/SideNav/SideNav.test.tsx@@ -989,6 +989,16 @@ describe('SideNav resizable', () => {).toBeInTheDocument();});+ it('clips the overlay drag handle within the resizable nav bounds', () => {+ render(<SideNav resizable>Content</SideNav>);+ const nav = screen.getByRole('navigation');+ const container = nav.parentElement;+ const handle = screen.getByTestId('astryx-sidenav-resize-handle');++ expect(container).toContainElement(handle);+ expect(getComputedStyle(container!).overflow).toBe('clip');+ });+it('does not render drag handle without resizable', () => {render(<SideNav>Content</SideNav>);expect(diff --git a/packages/core/src/SideNav/SideNav.tsx b/packages/core/src/SideNav/SideNav.tsxindex 4a3c3b3c18..ab6442a5e5 100644--- a/packages/core/src/SideNav/SideNav.tsx+++ b/packages/core/src/SideNav/SideNav.tsx@@ -11,7 +11,8 @@* Sidebar navigation container with five zones: header + topContent (sticky together),* children (scrollable), footer, and footerIcons (sticky bottom).*- * Supports optional resize via drag handle at the inline-end edge.+ * Supports optional resize via a drag handle at the inline-end edge. The+ * resizable wrapper clips handle overflow while keeping its focus ring inside.** SYNC: When modified, update these files to stay in sync:* - /packages/core/src/SideNav/SideNav.doc.mjs@@ -25,7 +26,7 @@ import {useCallback, useImperativeHandle, useRef, type ReactNode} from 'react';import type {BaseProps} from '../BaseProps';import * as stylex from '@stylexjs/stylex';import type {StyleXStyles} from '@stylexjs/stylex';-import {spacingVars} from '../theme/tokens.stylex';+import {focusVars, spacingVars} from '../theme/tokens.stylex';import {mergeProps} from '../utils';import {SideNavCollapseContext,@@ -241,6 +242,16 @@ const styles = stylex.create({display: 'flex',flexShrink: 0,height: '100%',+ overflow: 'clip',+ },+ resizableHandle: {+ // Keep the shared ring inside the clipping boundary. The wrapper cannot+ // use overflow-clip-margin: that paint allowance also contributes the+ // overlay's half-pixel spill to AppShell's scrollable overflow.+ outlineOffset: {+ default: '0',+ ':focus-visible': `calc(0px - ${focusVars['--focus-outline-width']})`,+ },},// Topbar mode — horizontal layout for mobile top bartopbar: {@@ -658,6 +669,7 @@ export function SideNav({position="overlay"pillPlacement="end"isAlwaysVisible={false}+ xstyle={styles.resizableHandle}resizable={resizableHook.props}label={t('@astryx.sideNav.resizeSidebar')}/>