Skip to content

Only render a footer border on Dialogs with a scrolling body #5897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Only render a footer border on Dialogs with a scrolling body #5897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41b4421
only renders a footer border on dialogs with a scrolling body
mperrotti Apr 7, 2025
2fcd653
Merge branch 'main' into mp/rm-dialog-btm-border
hectahertz Apr 9, 2025
3f6bfce
Merge branch 'main' into mp/rm-dialog-btm-border
hectahertz Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions packages/react/src/Dialog/Dialog.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@
}
}

/* Used to determine whether there should be a border between the body and footer */
@keyframes detect-scroll {
from,
to {
--can-scroll: 1;
}
}

.Backdrop {
position: fixed;
top: 0;
Expand Down Expand Up @@ -212,6 +220,28 @@
flex-grow: 1;
}

/*
Add a border between the body and footer if:
- the dialog has a footer
- the dialog has a body that can scroll
- the browser supports the `animation-timeline` property and its `scroll()` function
*/
.Dialog:has(.Footer) {
--can-scroll: 0;

.DialogOverflowWrapper {
animation: detect-scroll;
animation-timeline: scroll(self);

/* If the browser does not support the `animation-timeline` property, always show a border */
border-bottom: var(--borderWidth-default) solid var(--borderColor-default);

@supports (animation-timeline: scroll(self)) {
border-bottom: calc(1px * var(--can-scroll)) solid var(--borderColor-default);
}
}
}

.Header {
z-index: 1;
padding: var(--base-size-8);
Expand Down Expand Up @@ -246,8 +276,6 @@
flex-flow: wrap;
justify-content: flex-end;
padding: var(--base-size-16);
/* stylelint-disable-next-line primer/box-shadow */
box-shadow: 0 -1px 0 var(--borderColor-default);
gap: var(--base-size-8);
flex-shrink: 0;

Expand Down
49 changes: 46 additions & 3 deletions packages/react/src/Dialog/Dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,35 @@ const StyledDialog = toggleStyledComponent(
}
}

/* Used to determine whether there should be a border between the body and footer */
@keyframes detect-scroll {
from,
to {
--can-scroll: 1;
}
}

/*
Add a border between the body and footer if:
- the dialog has a footer
- the dialog has a body that can scroll
- the browser supports the animation-timeline property and its scroll() function
*/
&:has([data-component='Dialog.Footer']) {
--can-scroll: 0;
[data-component='Dialog.Body'] {
animation: detect-scroll;
animation-timeline: scroll(self);

/* If the browser does not support the animation-timeline property, always show a border */
border-bottom: var(--borderWidth-default) solid var(--borderColor-default);

@supports (animation-timeline: scroll(self)) {
border-bottom: calc(1px * var(--can-scroll)) solid var(--borderColor-default);
}
}
}

${sx};
`,
)
Expand Down Expand Up @@ -527,7 +556,13 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP
className={clsx(className, enabled && classes.Dialog)}
>
{header}
<ScrollableRegion aria-labelledby={dialogLabelId} className={classes.DialogOverflowWrapper}>
<ScrollableRegion
// `data-component` is used for a `:has` selector for `styled-components`.
// This can be removed when we remove `styled-components`.
data-component="Dialog.Body"
aria-labelledby={dialogLabelId}
className={classes.DialogOverflowWrapper}
>
{body}
</ScrollableRegion>
{footer}
Expand Down Expand Up @@ -623,7 +658,6 @@ const StyledFooter = toggleStyledComponent(
CSS_MODULES_FEATURE_FLAG,
'div',
styled.div<SxProp>`
box-shadow: 0 -1px 0 ${get('colors.border.default')};
padding: ${get('space.3')};
display: flex;
flex-flow: wrap;
Expand All @@ -644,7 +678,16 @@ type StyledFooterProps = React.ComponentProps<'div'> & SxProp

const Footer = React.forwardRef<HTMLElement, StyledFooterProps>(function Footer({className, ...rest}, forwardRef) {
const enabled = useFeatureFlag(CSS_MODULES_FEATURE_FLAG)
return <StyledFooter ref={forwardRef} className={clsx(className, enabled && classes.Footer)} {...rest} />
return (
<StyledFooter
ref={forwardRef}
className={clsx(className, enabled && classes.Footer)}
// `data-component` is used for a `:has` selector for `styled-components`.
// This can be removed when we remove `styled-components`.
data-component="Dialog.Footer"
{...rest}
/>
)
})
Footer.displayName = 'Dialog.Footer'

Expand Down
Loading