Skip to content
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

Jump to bottom

add margin prop to Modal #214

Merged
merged 1 commit into from
Sep 12, 2023
Merged

add margin prop to Modal #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/components/modal/__snapshots__/modal.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ exports[`Modal all options renders 1`] = `
<div
aria-describedby="radix-35"
aria-labelledby="radix-34"
class="relative my12 my60-mm wmax360 w-11/12 bg-white round"
class="relative my120 wmax360 w-11/12 bg-white round"
data-state="open"
id="radix-33"
role="dialog"
Expand Down
1 change: 1 addition & 0 deletions src/components/modal/modal.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ describe('Modal', () => {
const props = {
accessibleTitle: 'All options',
padding: 'none',
margin: 'large',
size: 'small',
onExit: jest.fn(),
initialFocus: '#foo',
Expand Down
13 changes: 12 additions & 1 deletion src/components/modal/modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ interface Props {
accessibleTitle: string;
size?: 'small' | 'large' | 'auto';
padding?: 'large' | 'none';
margin?: 'large' | 'default';
onExit?: () => void;
allowEventBubbling?: boolean;
initialFocus?: string;
Expand Down Expand Up @@ -50,6 +51,7 @@ export default function Modal({
accessibleTitle,
size = 'large',
padding = 'large',
margin = 'default',
allowEventBubbling = false,
initialFocus,
primaryAction,
Expand Down Expand Up @@ -81,6 +83,11 @@ export default function Modal({
widthClass = 'wmax600 w-11/12';
}

let marginClass = 'my12 my60-mm'
if (margin === 'large') {
marginClass = 'my120';
}

const overlayProps: {
className: string,
style: CSSProperties
Expand Down Expand Up @@ -109,7 +116,7 @@ export default function Modal({
onOpenAutoFocus?: (e) => void
} = {
className: classnames(
`relative my12 my60-mm ${widthClass} bg-white round`,
`relative ${marginClass} ${widthClass} bg-white round`,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`relative ${marginClass} ${widthClass} bg-white round`,
`fixed hmax-viewport-11/12 ${widthClass} bg-white round`,

@chriswhong what do you think about using fixed instead and also adding the following CSS to the element itself.

style: {
  top: '50%',
  left: '50%',
  transform: 'translate(-50%, -50%)'
}

That should center the modal and let us avoid adding fixed margins to begin with.

Copy link
Contributor Author

@chriswhong chriswhong Aug 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I lean towards modals opening near the top of the screen as a sensible default. This component could be used for content that is taller than the viewport, and the proposed change would cut off the top and bottom in that situation. (maybe for that much content we should not use a modal, but it's a footgun we should consider.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This component could be used for content that is taller than the viewport

Oh! That was the intention of adding hmax-viewport-11/12 so the modal is always shown but we would favor using an overflow scroll for content that extends beyond the viewport.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I lean towards modals opening near the top of the screen as a sensible default

That makes sense to me. Should we use a smaller percentage for top? My concern with adding a fixed margin-top option is that we'll want to add more over time to cover other scenarios and it will be hard to crawl out of that mess if we ever introduce breaking changes. Personally, I think adding a fixed top margin value - to begin with - was a mistake that I'm guilty of keeping around after the major changes in v2

{ 'px36 py36': padding === 'large' }
)
}
Expand Down Expand Up @@ -201,6 +208,10 @@ Modal.propTypes = {
* `'large'` or `'none'`.
*/
padding: PropTypes.oneOf(['large', 'none']),
/**
* `'large'` to compensate for a fixed top header or `'default'` to be closer to the top of the viewport.
*/
margin: PropTypes.oneOf(['large', 'default']),
/**
* The modal's primary action. If this is provided, an encouraging
* button will be rendered at the bottom of the modal.
Expand Down
Loading