An open source design system that's fully customizable and agent ready
TypeScript
fix(AppShell): auto height mode sidenav and sticky backgrounds (#615)
Cindy Zhang1e486dd3a862
diff --git a/packages/core/src/AppShell/XDSAppShell.test.tsx b/packages/core/src/AppShell/XDSAppShell.test.tsxindex c873ed46a7..d05dcfd999 100644--- a/packages/core/src/AppShell/XDSAppShell.test.tsx+++ b/packages/core/src/AppShell/XDSAppShell.test.tsx@@ -19,6 +19,7 @@ import {import {render, screen, fireEvent, act} from '@testing-library/react';import {XDSAppShell} from './XDSAppShell';import {XDSMobileNav} from '../MobileNav';+import {XDSSideNav, XDSSideNavItem, XDSSideNavSection} from '../SideNav';// jsdom doesn't implement showModal/close on <dialog>, so we mock thembeforeAll(() => {@@ -47,6 +48,19 @@ class MockResizeObserver {vi.stubGlobal('ResizeObserver', MockResizeObserver);+// Helper: minimal SideNav that provides the navigation landmark+function TestSideNav({children}: {children?: React.ReactNode}) {+ return (+ <XDSSideNav>+ <XDSSideNavSection title="Test" isHeaderHidden>+ <XDSSideNavItem+ label={typeof children === 'string' ? children : 'Nav'}+ />+ </XDSSideNavSection>+ </XDSSideNav>+ );+}+// Mock matchMediafunction createMockMatchMedia(matches: boolean) {const listeners: Array<(e: MediaQueryListEvent) => void> = [];@@ -134,13 +148,13 @@ describe('XDSAppShell', () => {it('renders sideNav in a nav element', () => {render(- <XDSAppShell sideNav={<div>Side Nav</div>}>+ <XDSAppShell sideNav={<TestSideNav />}><div>Content</div></XDSAppShell>,);const nav = screen.getByRole('navigation');expect(nav).toBeInTheDocument();- expect(screen.getByText('Side Nav')).toBeInTheDocument();+ expect(screen.getByText('Nav')).toBeInTheDocument();});it('renders without optional slots', () => {@@ -194,12 +208,12 @@ describe('XDSAppShell', () => {it('sideNav has aria-label', () => {render(- <XDSAppShell sideNav={<div>Nav</div>}>+ <XDSAppShell sideNav={<TestSideNav />}><div>Content</div></XDSAppShell>,);const nav = screen.getByRole('navigation');- expect(nav).toHaveAttribute('aria-label', 'Application navigation');+ expect(nav).toHaveAttribute('aria-label', 'Side navigation');});// ===========================================================================@@ -208,19 +222,17 @@ describe('XDSAppShell', () => {it('sideNav is visible by default (uncontrolled)', () => {render(- <XDSAppShell sideNav={<div>Nav Items</div>}>+ <XDSAppShell sideNav={<TestSideNav />}><div>Content</div></XDSAppShell>,);- expect(screen.getByText('Nav Items')).toBeInTheDocument();+ expect(screen.getByText('Nav')).toBeInTheDocument();expect(screen.getByRole('navigation')).toBeInTheDocument();});it('sideNav is hidden when defaultIsSideNavCollapsed is true', () => {render(- <XDSAppShell- sideNav={<div>Nav Items</div>}- defaultIsSideNavCollapsed={true}>+ <XDSAppShell sideNav={<TestSideNav />} defaultIsSideNavCollapsed={true}><div>Content</div></XDSAppShell>,);@@ -234,7 +246,7 @@ describe('XDSAppShell', () => {it('sideNav is hidden when isSideNavCollapsed is true (controlled)', () => {render(<XDSAppShell- sideNav={<div>Nav Items</div>}+ sideNav={<TestSideNav />}isSideNavCollapsed={true}onSideNavCollapsedChange={() => {}}><div>Content</div>@@ -246,7 +258,7 @@ describe('XDSAppShell', () => {it('sideNav is visible when isSideNavCollapsed is false (controlled)', () => {render(<XDSAppShell- sideNav={<div>Nav Items</div>}+ sideNav={<TestSideNav />}isSideNavCollapsed={false}onSideNavCollapsedChange={() => {}}><div>Content</div>@@ -263,7 +275,7 @@ describe('XDSAppShell', () => {const onChange = vi.fn();render(<XDSAppShell- sideNav={<div>Nav</div>}+ sideNav={<TestSideNav />}sideNavBreakpoint="md"onSideNavCollapsedChange={onChange}><div>Content</div>@@ -282,7 +294,7 @@ describe('XDSAppShell', () => {const onChange = vi.fn();render(<XDSAppShell- sideNav={<div>Nav</div>}+ sideNav={<TestSideNav />}sideNavBreakpoint="none"onSideNavCollapsedChange={onChange}><div>Content</div>@@ -303,7 +315,7 @@ describe('XDSAppShell', () => {render(<XDSAppShell- sideNav={<div>Nav Items</div>}+ sideNav={<TestSideNav />}isSideNavCollapsed={false}onSideNavCollapsedChange={() => {}}><div>Content</div>@@ -313,7 +325,7 @@ describe('XDSAppShell', () => {// Should show default mobile nav (XDSMobileNav wrapping sideNav)expect(screen.getByTestId('sidenav-mobile')).toBeInTheDocument();// Should show nav content inside the mobile nav- expect(screen.getByText('Nav Items')).toBeInTheDocument();+ expect(screen.getByText('Nav')).toBeInTheDocument();});it('default mobile nav calls onSideNavCollapsedChange on close', () => {@@ -323,7 +335,7 @@ describe('XDSAppShell', () => {const onChange = vi.fn();render(<XDSAppShell- sideNav={<div>Nav</div>}+ sideNav={<TestSideNav />}isSideNavCollapsed={false}onSideNavCollapsedChange={onChange}><div>Content</div>@@ -473,7 +485,7 @@ describe('XDSAppShell', () => {it('renders mobileNav slot content', () => {render(<XDSAppShell- sideNav={<div>Side Nav</div>}+ sideNav={<TestSideNav />}mobileNav={<XDSMobileNavisOpen={true}@@ -492,7 +504,7 @@ describe('XDSAppShell', () => {it('does not render mobileNav when not provided', () => {render(- <XDSAppShell sideNav={<div>Side Nav</div>}>+ <XDSAppShell sideNav={<TestSideNav />}><div>Content</div></XDSAppShell>,);@@ -505,7 +517,7 @@ describe('XDSAppShell', () => {render(<XDSAppShell- sideNav={<div>Side Nav</div>}+ sideNav={<TestSideNav />}mobileNav={<XDSMobileNavisOpen={false}@@ -529,7 +541,7 @@ describe('XDSAppShell', () => {const onClose = vi.fn();render(<XDSAppShell- sideNav={<div>Side Nav</div>}+ sideNav={<TestSideNav />}mobileNav={<XDSMobileNav isOpen={true} onOpenChange={onClose} title="Nav"><div>Mobile Nav</div>diff --git a/packages/core/src/AppShell/XDSAppShell.tsx b/packages/core/src/AppShell/XDSAppShell.tsxindex 3509f6e904..af2b7b344c 100644--- a/packages/core/src/AppShell/XDSAppShell.tsx+++ b/packages/core/src/AppShell/XDSAppShell.tsx@@ -316,12 +316,19 @@ const styles = stylex.create({sideNavAutoWrapper: {alignSelf: 'stretch',},+ // Panel fill for auto mode — panel fills the sticky container vertically+ panelAutoFill: {+ flex: 1,+ },// Sticky sideNav for auto height mode — sticks within the wrappersideNavSticky: {position: 'sticky',top: 'var(--appshell-header-height, 0px)',- height: 'calc(100vh - var(--appshell-header-height, 0px))',+ height: 'calc(100dvh - var(--appshell-header-height, 0px))',overflow: 'auto',+ // Ensure children (XDSLayoutPanel → XDSSideNav) fill the sticky container+ display: 'flex',+ flexDirection: 'column',},});@@ -410,6 +417,11 @@ export function XDSAppShell({? styles.contentBgSurface: undefined;+ // Background for sticky elements in auto mode — must be opaque so content+ // doesn't show through when scrolling underneath. Uses the nav area bg if+ // set, otherwise falls back to the shell variant bg (always surface for section).+ const stickyBgStyle = navAreaStyle ?? styles.navAreaSurface;+// =========================================================================// Header height measurement for sticky sideNav offset (auto mode)// =========================================================================@@ -419,12 +431,11 @@ export function XDSAppShell({// Merge forwarded ref with internal shell refconst setShellRef = useCallback((node: HTMLDivElement | null) => {- (shellRef as React.MutableRefObject<HTMLDivElement | null>).current =- node;+ (shellRef as React.RefObject<HTMLDivElement | null>).current = node;if (typeof ref === 'function') {ref(node);} else if (ref) {- (ref as React.MutableRefObject<HTMLDivElement | null>).current = node;+ (ref as React.RefObject<HTMLDivElement | null>).current = node;}},[ref],@@ -521,7 +532,12 @@ export function XDSAppShell({const headerContent =headerInner != null ? (- <div ref={headerRef} {...stylex.props(isAuto && styles.headerSticky)}>+ <div+ ref={headerRef}+ {...stylex.props(+ isAuto && styles.headerSticky,+ isAuto && stickyBgStyle,+ )}>{headerInner}</div>) : undefined;@@ -539,10 +555,8 @@ export function XDSAppShell({padding={0}hasDivider={navHasDividers}width={sideNavWidth}- role="navigation"- label="Application navigation"isScrollable={isFill}- xstyle={navAreaStyle}>+ xstyle={[navAreaStyle, isAuto && styles.panelAutoFill]}>{sideNav}</XDSLayoutPanel>) : undefined;@@ -550,7 +564,9 @@ export function XDSAppShell({const sideNavContent =sideNavPanel != null && isAuto ? (<div {...stylex.props(styles.sideNavAutoWrapper)}>- <div {...stylex.props(styles.sideNavSticky)}>{sideNavPanel}</div>+ <div {...stylex.props(styles.sideNavSticky, stickyBgStyle)}>+ {sideNavPanel}+ </div></div>) : (sideNavPanel