Skip to content

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

TypeScript

fix(dialog): scrollable content, mobile visibility, container styles (#942)

Cindy Zhangcc123bf27369
diff --git a/packages/core/src/Dialog/XDSDialog.test.tsx b/packages/core/src/Dialog/XDSDialog.test.tsx
index 434fa0a4d8..b29ced6efb 100644
--- a/packages/core/src/Dialog/XDSDialog.test.tsx
+++ b/packages/core/src/Dialog/XDSDialog.test.tsx
@@ -263,4 +263,18 @@ describe('XDSDialog', () => {
expect(screen.getByRole('dialog')).toBeInTheDocument();
});
});
+
+ describe('inner flex wrapper', () => {
+ it('wraps children in a flex container for scroll support', () => {
+ render(
+ <XDSDialog isOpen={true} onOpenChange={() => {}}>
+ <div data-testid="child">Content</div>
+ </XDSDialog>,
+ );
+ const child = screen.getByTestId('child');
+ const wrapper = child.parentElement!;
+ expect(wrapper.tagName).toBe('DIV');
+ expect(wrapper.parentElement!.tagName).toBe('DIALOG');
+ });
+ });
});
diff --git a/packages/core/src/Dialog/XDSDialog.tsx b/packages/core/src/Dialog/XDSDialog.tsx
index 756bd1cf22..9c0d2f22c0 100644
--- a/packages/core/src/Dialog/XDSDialog.tsx
+++ b/packages/core/src/Dialog/XDSDialog.tsx
@@ -2,7 +2,7 @@
/**
* @file XDSDialog.tsx
- * @input Uses React, DialogHTMLAttributes, ReactNode
+ * @input Uses React, DialogHTMLAttributes, ReactNode, container (Layout)
* @output Exports XDSDialog component, XDSDialogProps, XDSDialogVariant, XDSDialogPurpose types
* @position Core implementation; consumed by index.ts, tested by XDSDialog.test.tsx
*
@@ -23,6 +23,7 @@ import {
easeVars,
shadowVars,
} from '../theme/tokens.stylex';
+import {container} from '../Layout/container.stylex';
import {xdsClassName, mergeProps} from '../utils';
/**
@@ -89,24 +90,29 @@ const styles = stylex.create({
':where([open])': 'flex',
},
flexDirection: 'column',
- overflow: 'hidden',
height: 'fit-content',
- // Animation for open/close
+ overscrollBehavior: 'contain',
+ // Entry/exit animation. Requires @starting-style + allow-discrete
+ // for transitioning from display:none. Browsers without support
+ // get instant show/hide (opacity defaults to 1 in base, animation
+ // layer only applies when @starting-style is supported).
opacity: {
- default: 0,
- ':where([open])': 1,
+ default: 1,
+ ':where(:not([open]))': 0,
},
transform: {
- default: 'scale(0.95) translateY(8px)',
- ':where([open])': 'scale(1) translateY(0)',
+ default: 'scale(1) translateY(0)',
+ ':where(:not([open]))': 'scale(0.95) translateY(8px)',
},
- transitionProperty: 'opacity, transform, display, overlay',
- transitionDuration: durationVars['--duration-medium'],
- transitionTimingFunction: easeVars['--ease-standard'],
- transitionBehavior: 'allow-discrete',
- '@starting-style': {
- opacity: 0,
- transform: 'scale(0.95) translateY(8px)',
+ '@supports (transition-behavior: allow-discrete)': {
+ transitionProperty: 'opacity, transform, display, overlay',
+ transitionDuration: durationVars['--duration-medium'],
+ transitionTimingFunction: easeVars['--ease-standard'],
+ transitionBehavior: 'allow-discrete',
+ '@starting-style': {
+ opacity: 0,
+ transform: 'scale(0.95) translateY(8px)',
+ },
},
'@media (prefers-reduced-motion: reduce)': {
transitionDuration: '0s',
@@ -136,6 +142,14 @@ const styles = stylex.create({
margin: 0,
inset: 0,
},
+ inner: {
+ display: 'flex',
+ flexDirection: 'column',
+ flex: '1 1 auto',
+ minHeight: 0,
+ overflow: 'hidden',
+ borderRadius: 'inherit',
+ },
});
// Dynamic styles for width, maxHeight, and position
@@ -360,6 +374,7 @@ export function XDSDialog({
{...mergeProps(
xdsClassName('dialog', {variant}),
stylex.props(
+ ...container({padding: 'spacing0'}),
styles.dialog,
styles.backdrop,
!isFullscreen && dynamicStyles.sizing(width, maxHeight),
@@ -377,7 +392,7 @@ export function XDSDialog({
style,
)}
{...safeProps}>
- {children}
+ <div {...stylex.props(styles.inner)}>{children}</div>
</dialog>
);
}
diff --git a/packages/core/src/Dialog/XDSDialogHeader.tsx b/packages/core/src/Dialog/XDSDialogHeader.tsx
index 088e4954f9..b99cda873a 100644
--- a/packages/core/src/Dialog/XDSDialogHeader.tsx
+++ b/packages/core/src/Dialog/XDSDialogHeader.tsx
@@ -13,7 +13,6 @@
* - /apps/storybook/stories/Dialog.stories.tsx
*/
-
import {useEffect, useRef, type ReactNode} from 'react';
import * as stylex from '@stylexjs/stylex';
import {spacingVars} from '../theme/tokens.stylex';
@@ -30,9 +29,17 @@ const styles = stylex.create({
justifyContent: 'space-between',
gap: spacingVars['--spacing-3'],
},
+ // Compensate for the icon button's visual padding on the actions area
+ actionsCompensation: {
+ marginBlock: `calc(-1 * ${spacingVars['--spacing-2']})`,
+ marginInlineEnd: `calc(-1 * ${spacingVars['--spacing-2']})`,
+ },
titleWrapper: {
flex: 1,
minWidth: 0,
+ display: 'flex',
+ flexDirection: 'column',
+ gap: 0,
},
titleFocusable: {
outline: 'none',
@@ -43,10 +50,6 @@ const styles = stylex.create({
gap: spacingVars['--spacing-2'],
flexShrink: 0,
},
- closeButton: {
- marginTop: `calc(-1 * ${spacingVars['--spacing-2']})`,
- marginRight: `calc(-1 * ${spacingVars['--spacing-2']})`,
- },
});
export interface XDSDialogHeaderProps {
@@ -134,7 +137,10 @@ export function XDSDialogHeader({
<div {...stylex.props(styles.actions)}>{startContent}</div>
)}
<div {...stylex.props(styles.titleWrapper)}>
- <XDSHeading ref={titleRef} level={2} xstyle={styles.titleFocusable}>
+ <XDSHeading
+ ref={titleRef}
+ level={2}
+ xstyle={styles.titleFocusable}>
{title}
</XDSHeading>
{subtitle && (
@@ -144,18 +150,20 @@ export function XDSDialogHeader({
)}
</div>
{(endContent || onOpenChange) && (
- <div {...stylex.props(styles.actions)}>
+ <div
+ {...stylex.props(
+ styles.actions,
+ onOpenChange && styles.actionsCompensation,
+ )}>
{endContent}
{onOpenChange && (
- <div {...stylex.props(styles.closeButton)}>
- <XDSButton
- variant="ghost"
- label="Close"
- tooltip="Close"
- icon={<XDSIcon icon="close" color="inherit" />}
- onClick={() => onOpenChange?.(false)}
- />
- </div>
+ <XDSButton
+ variant="ghost"
+ label="Close"
+ tooltip="Close"
+ icon={<XDSIcon icon="close" color="inherit" />}
+ onClick={() => onOpenChange?.(false)}
+ />
)}
</div>
)}