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.

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 type for utils overshadowing properties #960

Merged
merged 1 commit into from
Oct 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
62 changes: 62 additions & 0 deletions packages/core/tests/issue-921.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { createStitches, PropertyValue, CSS } from '../types/index'

const config = {
utils: {
background: (value: boolean | PropertyValue<'background'>) => {
if (typeof value === 'boolean') {
return value ? {
background: 'red'
} : {}
} else {
return {
background: value
}
}
}
},
}

const { css, globalCss } = createStitches(config)

globalCss({
html: {
background: true
},
body: {
background: 'green'
},
})

const Component = css({
background: true,
'> *': {
background: 'green'
}
})

Component({
background: 'green',
'> *': {
background: true
}
})

css(Component, {
background: 'green'
})

css(Component, {
background: true
})

const style: CSS = {
background: true // expect error
}

const style2: CSS<typeof config> = {
background: true
}

const style3: CSS<typeof config> = {
background: 'green'
}
2 changes: 1 addition & 1 deletion packages/core/types/css-util.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type CSS<
}
// known property styles
& {
[K in keyof CSSProperties]?: (
[K in keyof CSSProperties as K extends keyof Utils ? never : K]?: (
| ValueByPropertyName<K>
| TokenByPropertyName<K, Theme, ThemeMap>
| Native.Globals
Expand Down
81 changes: 81 additions & 0 deletions packages/react/tests/issue-921.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
import { createStitches, PropertyValue, CSS } from '../types/index'

const config = {
utils: {
background: (value: boolean | PropertyValue<'background'>) => {
if (typeof value === 'boolean') {
return value ? {
background: 'red'
} : {}
} else {
return {
background: value
}
}
}
},
}

const { css, globalCss, styled } = createStitches(config)

globalCss({
html: {
background: true
},
body: {
background: 'green'
},
})

const CComponent = css({
background: true,
'> *': {
background: 'green'
}
})

CComponent({
background: 'green',
'> *': {
background: true
}
})

css(CComponent, {
background: 'green'
})

css(CComponent, {
background: true
})

const SComponent = styled('div', {
background: 'green',
'> *': {
background: true
}
})

void function Test() {
return (
<SComponent css={{
background: true,
'> *': {
background: 'green'
}
}}
/>
)
}

const style: CSS = {
background: true // expect error
}

const style2: CSS<typeof config> = {
background: true
}

const style3: CSS<typeof config> = {
background: 'green'
}
2 changes: 1 addition & 1 deletion packages/react/types/css-util.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type CSS<
}
// known property styles
& {
[K in keyof CSSProperties]?: (
[K in keyof CSSProperties as K extends keyof Utils ? never : K]?: (
Copy link
Member

Choose a reason for hiding this comment

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

I remember that at some point, we explicitly didn’t want utils to override CSS properties, and the types for utils below currently showcase the intention, so this PR doesn’t completely fix the issue.

Now changing this runtime behavior to match the types would be a breaking change to existing users, so I will go ahead and merge this and then fix the type for utils so that it matches what happens at runtime

| ValueByPropertyName<K>
| TokenByPropertyName<K, Theme, ThemeMap>
| Native.Globals
Expand Down