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

fix(css): Prevent transforming @page properties like size #2341

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(css): Prevent transforming @page properties like size #2341

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 packages/css/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ export const css =
const x = styles[key as keyof typeof styles]
const val = typeof x === 'function' ? x(theme) : x

if (val && typeof val === 'object') {
Copy link
Member

@hasparus hasparus Oct 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I agree that this is the implementation for the solution, but I'm very conflicted about having a special case for @page.

It feels bad, doesn't it? Could we maybe... choose a different solution?
There's no perfect solution here, but I suppose I'd rather resign from the size shorthand and add w and h shorthands in its place.

An alternative we could consider — could we just not implement anything?
There's an escape hatch with css prop, Safari doesn't support @page. Seems less correct than dropping the size alias, and we'd probably need an error thrown only in development, but it's something 🤷

Copy link
Member Author

Choose a reason for hiding this comment

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

w/h shorthands will require changes by a significant percentage of Theme UI users & seems like a price they shouldn’t have to pay to me. The number of people using @page is likely tiny, & it’s very easy to update what code in the extremely rare case this change breaks it (imagine usages of that selector to find & replace vs “size” in a codebase). This isn’t very correct but it just doesn’t seem like a common issue to be sad about not getting your (screen-optimized) theme as automatically accessible in printing page setup for some browsers.

if (val && typeof val === 'object' && key !== '@page') {
if (hasDefault(val)) {
result[key] = val[THEME_UI_DEFAULT_KEY]
continue
Expand Down
11 changes: 11 additions & 0 deletions packages/css/test/past-bugs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,15 @@ describe('theme scales, get and default object property (#1439)', () => {

expect(actual).toStrictEqual({ zIndex: 1 })
})

// https://github.com/system-ui/theme-ui/issues/2166
test('size property works inside at page', () => {
const actual = css({ size: '2rem', '@page': { size: 'A4' } })({})

expect(actual).toStrictEqual({
width: '2rem',
height: '2rem',
'@page': { size: 'A4' },
})
})
})