Skip to content

Ensure escaped theme variables are handled correctly #16064

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

Merged
philipp-spiess merged 3 commits into from
Jan 31, 2025
Merged

Ensure escaped theme variables are handled correctly #16064

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9c7140
Ensure escaped theme variables are handled correctly
philipp-spiess Jan 30, 2025
c9afcbe
Allow both escaped dots and underscores to be registered in theme
philipp-spiess Jan 30, 2025
b05d3cb
Merge branch 'main' into fix/escaped-theme-vars
philipp-spiess Jan 31, 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
Prev Previous commit
Next Next commit
Allow both escaped dots and underscores to be registered in theme
  • Loading branch information
@philipp-spiess
philipp-spiess committed Jan 30, 2025
commit c9afcbe2b52dd7a13a80e02511d7fc2ae01c746e
4 changes: 2 additions & 2 deletions packages/tailwindcss/src/compat/plugin-api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1425,7 +1425,7 @@ describe('theme', async () => {
:root, :host {
--width-1: 0.25rem;
--width-1\\/2: 60%;
--width-1_5: 0.375rem;
--width-1\\.5: 0.375rem;
--width-2_5: 0.625rem;
}
"
Expand Down Expand Up @@ -1482,7 +1482,7 @@ describe('theme', async () => {
:root, :host {
--width-1: 0.25rem;
--width-1\\/2: 60%;
--width-1_5: 0.375rem;
--width-1\\.5: 0.375rem;
--width-2_5: 0.625rem;
}
"
Expand Down
22 changes: 18 additions & 4 deletions packages/tailwindcss/src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,21 +158,35 @@ describe('compiling CSS', () => {
css`
@theme {
--spacing-*: initial;
--spacing-1\.5: 2.5rem;
--spacing-1\.5: 1.5px;
--spacing-2_5: 2.5px;
--spacing-3\.5: 3.5px;
--spacing-3_5: 3.5px;
--spacing-foo\/bar: 3rem;
}
@tailwind utilities;
`,
['m-1.5', 'm-foo/bar'],
['m-1.5', 'm-2.5', 'm-2_5', 'm-3.5', 'm-foo/bar'],
),
).toMatchInlineSnapshot(`
":root, :host {
--spacing-1_5: 2.5rem;
--spacing-1\\.5: 1.5px;
--spacing-2_5: 2.5px;
--spacing-3\\.5: 3.5px;
--spacing-3_5: 3.5px;
--spacing-foo\\/bar: 3rem;
}

.m-1\\.5 {
margin: var(--spacing-1_5);
margin: var(--spacing-1\\.5);
}

.m-2\\.5, .m-2_5 {
margin: var(--spacing-2_5);
}

.m-3\\.5 {
margin: var(--spacing-3\\.5);
}

.m-foo\\/bar {
Expand Down
19 changes: 13 additions & 6 deletions packages/tailwindcss/src/theme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ export class Theme {
) {}

add(key: string, value: string, options = ThemeOptions.NONE): void {
key = key.replaceAll('.', '_')

if (key.endsWith('-*')) {
if (value !== 'initial') {
throw new Error(`Invalid theme value \`${value}\` for namespace \`${key}\``)
Expand Down Expand Up @@ -147,11 +145,20 @@ export class Theme {
#resolveKey(candidateValue: string | null, themeKeys: ThemeKey[]): string | null {
for (let namespace of themeKeys) {
let themeKey =
candidateValue !== null
? (`${namespace}-${candidateValue.replaceAll('.', '_')}` as ThemeKey)
: namespace
candidateValue !== null ? (`${namespace}-${candidateValue}` as ThemeKey) : namespace

if (!this.values.has(themeKey)) {
// If the exact theme key is not found, we might be trying to resolve a key containing a dot
// that was registered with an underscore instead:
if (candidateValue !== null && candidateValue.includes('.')) {
themeKey = `${namespace}-${candidateValue.replaceAll('.', '_')}` as ThemeKey

if (!this.values.has(themeKey)) continue
} else {
continue
}
}

if (!this.values.has(themeKey)) continue
if (isIgnoredThemeKey(themeKey, namespace)) continue

return themeKey
Expand Down