An open source design system that's fully customizable and agent ready
TypeScript
perf(ChatLayout): replace ResizeObserver with CSS container queries (#2505)
Cindy Zhang9dca298af07d
diff --git a/packages/core/src/Chat/XDSChatLayout.test.tsx b/packages/core/src/Chat/XDSChatLayout.test.tsxindex f5a54df045..7843aa8676 100644--- a/packages/core/src/Chat/XDSChatLayout.test.tsx+++ b/packages/core/src/Chat/XDSChatLayout.test.tsx@@ -1,25 +1,11 @@// Copyright (c) Meta Platforms, Inc. and affiliates.-import {describe, it, expect, vi, beforeEach} from 'vitest';+import {describe, it, expect} from 'vitest';import {render, screen} from '@testing-library/react';import {XDSChatLayout} from './XDSChatLayout';-class FakeResizeObserver {- callback: ResizeObserverCallback;- constructor(cb: ResizeObserverCallback) {- this.callback = cb;- }- observe = vi.fn();- unobserve = vi.fn();- disconnect = vi.fn();-}--beforeEach(() => {- vi.stubGlobal('ResizeObserver', FakeResizeObserver);-});-describe('XDSChatLayout', () => {- it('renders children', () => {+ it('renders children in the message area', () => {render(<XDSChatLayout composer={<div>composer</div>}><div>Hello message</div>@@ -28,22 +14,16 @@ describe('XDSChatLayout', () => {expect(screen.getByText('Hello message')).toBeTruthy();});- it('renders composer in fixed dock', () => {+ it('renders composer in dock', () => {render(<XDSChatLayout composer={<div data-testid="composer">Compose</div>}><div>msg</div></XDSChatLayout>,);- const composer = screen.getByTestId('composer');- expect(composer).toBeTruthy();- // The dock (parent of the composer's wrapper) should have position: fixed- const dock = composer.parentElement?.parentElement;- expect(dock).toBeTruthy();- // StyleX applies classes, so check the element exists in the DOM structure- expect(dock?.tagName).toBe('DIV');+ expect(screen.getByTestId('composer')).toBeTruthy();});- it('renders empty state when children is empty', () => {+ it('renders empty state when children is empty array', () => {render(<XDSChatLayoutcomposer={<div>composer</div>}@@ -54,7 +34,7 @@ describe('XDSChatLayout', () => {expect(screen.getByText('No messages yet')).toBeTruthy();});- it('does not render empty state when children exist', () => {+ it('prefers children over empty state when both present', () => {render(<XDSChatLayoutcomposer={<div>composer</div>}@@ -66,35 +46,56 @@ describe('XDSChatLayout', () => {expect(screen.queryByText('No messages yet')).toBeNull();});- it('has container-type on root', () => {- render(- <XDSChatLayout composer={<div>composer</div>} data-testid="layout-root">+ it('applies density attribute to root element', () => {+ const {rerender} = render(+ <XDSChatLayout+ composer={<div>composer</div>}+ data-testid="layout"+ density="compact">+ <div>msg</div>+ </XDSChatLayout>,+ );+ const root = screen.getByTestId('layout');+ expect(root.className).toContain('compact');++ rerender(+ <XDSChatLayout+ composer={<div>composer</div>}+ data-testid="layout"+ density="spacious"><div>msg</div></XDSChatLayout>,);- const root = screen.getByTestId('layout-root');- expect(root).toBeTruthy();- expect(root.className).toContain('xds-chat-layout');+ expect(root.className).toContain('spacious');});- it('applies data-testid', () => {+ it('defaults density to balanced', () => {render(- <XDSChatLayout composer={<div>composer</div>} data-testid="my-layout">+ <XDSChatLayout composer={<div>composer</div>} data-testid="layout"><div>msg</div></XDSChatLayout>,);- expect(screen.getByTestId('my-layout')).toBeTruthy();+ const root = screen.getByTestId('layout');+ expect(root.className).toContain('balanced');});- it('renders scrollButton slot', () => {+ it('renders custom scrollButton slot', () => {render(<XDSChatLayoutcomposer={<div>composer</div>}- scrollButton={<button type="button">Scroll to bottom</button>}>+ scrollButton={<button type="button">Scroll down</button>}>+ <div>msg</div>+ </XDSChatLayout>,+ );+ expect(screen.getByRole('button', {name: /Scroll down/})).toBeTruthy();+ });++ it('hides scrollButton when null', () => {+ render(+ <XDSChatLayout composer={<div>composer</div>} scrollButton={null}><div>msg</div></XDSChatLayout>,);- const button = screen.getByRole('button', {name: /Scroll to bottom/});- expect(button).toBeTruthy();+ expect(screen.queryByRole('button')).toBeNull();});});diff --git a/packages/core/src/Chat/XDSChatLayout.tsx b/packages/core/src/Chat/XDSChatLayout.tsxindex ae315dc4b0..545051200d 100644--- a/packages/core/src/Chat/XDSChatLayout.tsx+++ b/packages/core/src/Chat/XDSChatLayout.tsx@@ -12,18 +12,21 @@* Provides the scroll container ref and content ref, renders the* scroll-to-bottom button, frosted glass dock, and message area.*+ * Density (compact/balanced/spacious) is controlled via a prop with+ * 'balanced' as the default. No JS measurement or ResizeObserver needed.+ * The container-type on root enables container queries in child components.+ ** SYNC: When modified, update these files to stay in sync:* - /packages/core/src/Chat/index.ts (exports)* - /apps/storybook/stories/ChatLayout.stories.tsx* - /packages/cli/templates/blocks/components/ChatLayout/ (block examples)*/-import {type ReactNode, useEffect, useMemo, useRef, useState} from 'react';+import {type ReactNode, useMemo, useRef} from 'react';import * as stylex from '@stylexjs/stylex';import {spacingVars} from '../theme/tokens.stylex';import type {XDSBaseProps} from '../XDSBaseProps';import {xdsClassName, mergeProps, mergeRefs} from '../utils';-import {observeResize, unobserveResize} from '../utils/sharedResizeObserver';import {useXDSChatStreamScroll} from './useXDSChatStreamScroll';import {useXDSChatNewMessages} from './useXDSChatNewMessages';import {XDSChatLayoutScrollButton} from './XDSChatLayoutScrollButton';@@ -87,6 +90,13 @@ export interface XDSChatLayoutProps extends XDSBaseProps<HTMLDivElement> {* When omitted, the layout root itself is the scroll container.*/scrollRef?: React.RefObject<HTMLElement | null>;++ /**+ * Layout density. Controls spacing, max-width, and blur layer sizing.+ *+ * @default 'balanced'+ */+ density?: Density;}// =============================================================================@@ -117,16 +127,9 @@ const styles = stylex.create({marginInline: 'auto',minHeight: '100%',paddingBlockEnd: spacingVars['--spacing-6'],- },- messageAreaCompact: {- maxWidth: '100%',- },- messageAreaBalanced: {+ width: '100%',maxWidth: '100%',- },- messageAreaSpacious: {- maxWidth: 800,- paddingInline: spacingVars['--spacing-4'],+ paddingInline: 0,},emptyState: {@@ -161,7 +164,39 @@ const styles = stylex.create({pointerEvents: 'none',backdropFilter: 'blur(12px)',WebkitBackdropFilter: 'blur(12px)',+ height: 100,+ maskImage: 'linear-gradient(to bottom, transparent, black 36px)',+ WebkitMaskImage: 'linear-gradient(to bottom, transparent, black 36px)',+ },++ dock: {+ position: 'relative',+ zIndex: 1,+ pointerEvents: 'auto',+ paddingInline: spacingVars['--spacing-3'],+ paddingBlockEnd: spacingVars['--spacing-3'],+ },++ dockInner: {+ marginInline: 'auto',+ width: '100%',+ maxWidth: '100%',},++ // --- Forced density overrides (disable container queries) ---+ messageAreaCompact: {+ maxWidth: '100%',+ paddingInline: 0,+ },+ messageAreaBalanced: {+ maxWidth: '100%',+ paddingInline: 0,+ },+ messageAreaSpacious: {+ maxWidth: 800,+ paddingInline: spacingVars['--spacing-4'],+ },+blurLayerCompact: {height: 80,maskImage: 'linear-gradient(to bottom, transparent, black 24px)',@@ -178,11 +213,6 @@ const styles = stylex.create({WebkitMaskImage: 'linear-gradient(to bottom, transparent, black 48px)',},- dock: {- position: 'relative',- zIndex: 1,- pointerEvents: 'auto',- },dockCompact: {paddingInline: spacingVars['--spacing-2'],paddingBlockEnd: spacingVars['--spacing-2'],@@ -196,9 +226,6 @@ const styles = stylex.create({paddingBlockEnd: spacingVars['--spacing-3'],},- dockInner: {- marginInline: 'auto',- },dockInnerCompact: {maxWidth: '100%',},@@ -214,16 +241,6 @@ const styles = stylex.create({// Helpers// =============================================================================-function getDensity(width: number): Density {- if (width < 480) {- return 'compact';- }- if (width <= 768) {- return 'balanced';- }- return 'spacious';-}-function hasVisibleContent(children: ReactNode): boolean {if (children == null || children === false) {return false;@@ -234,10 +251,6 @@ function hasVisibleContent(children: ReactNode): boolean {return true;}-// =============================================================================-// Sub-components-// =============================================================================-// =============================================================================// Component// =============================================================================@@ -245,6 +258,7 @@ function hasVisibleContent(children: ReactNode): boolean {export function XDSChatLayout({children,composer,+ density = 'balanced',emptyState,scrollButton,scrollRef: externalScrollRef,@@ -259,8 +273,6 @@ export function XDSChatLayout({const scrollContainerRef = externalScrollRef ?? rootRef;const isSelfScrolling = !externalScrollRef;- const [density, setDensity] = useState<Density>('balanced');-// --- Default scroll behavior ---const scroll = useXDSChatStreamScroll({scrollRef: scrollContainerRef});const newMsgs = useXDSChatNewMessages({@@ -285,55 +297,37 @@ export function XDSChatLayout({[scrollContainerRef, newMsgs.contentRef],);- // --- Density observer ---- useEffect(() => {- const root = rootRef.current;- if (!root) {- return;- }- observeResize(root, () => {- setDensity(getDensity(root.clientWidth));- });- return () => unobserveResize(root);- }, []);-// --- Derived styles ---const showEmpty = !hasVisibleContent(children);- const messageAreaStyle =- density === 'compact'- ? styles.messageAreaCompact- : density === 'spacious'- ? styles.messageAreaSpacious- : styles.messageAreaBalanced;-- const blurLayerStyle =- density === 'compact'- ? styles.blurLayerCompact- : density === 'spacious'- ? styles.blurLayerSpacious- : styles.blurLayerBalanced;-- const dockStyle =- density === 'compact'- ? styles.dockCompact- : density === 'spacious'- ? styles.dockSpacious- : styles.dockBalanced;-- const dockInnerStyle =- density === 'compact'- ? styles.dockInnerCompact- : density === 'spacious'- ? styles.dockInnerSpacious- : styles.dockInnerBalanced;+ const densityStyles = {+ compact: {+ messageArea: styles.messageAreaCompact,+ blurLayer: styles.blurLayerCompact,+ dock: styles.dockCompact,+ dockInner: styles.dockInnerCompact,+ },+ balanced: {+ messageArea: styles.messageAreaBalanced,+ blurLayer: styles.blurLayerBalanced,+ dock: styles.dockBalanced,+ dockInner: styles.dockInnerBalanced,+ },+ spacious: {+ messageArea: styles.messageAreaSpacious,+ blurLayer: styles.blurLayerSpacious,+ dock: styles.dockSpacious,+ dockInner: styles.dockInnerSpacious,+ },+ } as const;++ const currentDensity = densityStyles[density];return (<XDSChatLayoutContext value={layoutContext}><divref={mergeRefs(ref, rootRef)}data-testid={testId}- data-density={density}{...mergeProps(xdsClassName('chat-layout', {density}),stylex.props(@@ -345,7 +339,7 @@ export function XDSChatLayout({style,)}>{/* Message area */}- <div {...stylex.props(styles.messageArea, messageAreaStyle)}>+ <div {...stylex.props(styles.messageArea, currentDensity.messageArea)}>{showEmpty && emptyState ? (<div {...stylex.props(styles.emptyState)}>{emptyState}</div>) : (@@ -365,11 +359,11 @@ export function XDSChatLayout({{scrollButton === undefined ? defaultScrollButton : scrollButton}{/* Frosted glass layer */}- <div {...stylex.props(styles.blurLayer, blurLayerStyle)} />+ <div {...stylex.props(styles.blurLayer, currentDensity.blurLayer)} />{/* Composer */}- <div {...stylex.props(styles.dock, dockStyle)}>- <div {...stylex.props(styles.dockInner, dockInnerStyle)}>+ <div {...stylex.props(styles.dock, currentDensity.dock)}>+ <div {...stylex.props(styles.dockInner, currentDensity.dockInner)}>{composer}</div></div>