Skip to content

Add getThemeEntries API #15294

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

Closed
wants to merge 2 commits into from
Closed

Add getThemeEntries API #15294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23b4454
Add `getThemeEntries` API
thecrypticace Dec 4, 2024
91756b7
Add test
thecrypticace Dec 4, 2024
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
13 changes: 12 additions & 1 deletion packages/tailwindcss/src/design-system.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
import { toCss } from './ast'
import { parseCandidate, parseVariant, type Candidate, type Variant } from './candidate'
import { compileAstNodes, compileCandidates } from './compile'
import { getClassList, getVariants, type ClassEntry, type VariantEntry } from './intellisense'
import {
getClassList,
getThemeEntries,
getVariants,
type ClassEntry,
type ThemeEntry,
type VariantEntry,
} from './intellisense'
import { getClassOrder } from './sort'
import type { Theme, ThemeKey } from './theme'
import { Utilities, createUtilities, withAlpha } from './utilities'
Expand Down Expand Up @@ -31,6 +38,7 @@ export type DesignSystem = {

// Used by IntelliSense
candidatesToCss(classes: string[]): (string | null)[]
getThemeEntries(): ThemeEntry[]
}

export function buildDesignSystem(theme: Theme): DesignSystem {
Expand Down Expand Up @@ -84,6 +92,9 @@ export function buildDesignSystem(theme: Theme): DesignSystem {
getVariants() {
return getVariants(this)
},
getThemeEntries() {
return getThemeEntries()
},

parseCandidate(candidate: string) {
return parsedCandidates.get(candidate)
Expand Down
112 changes: 112 additions & 0 deletions packages/tailwindcss/src/intellisense.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,3 +431,115 @@ test('Custom at-rule variants do not show up as a value under `group`', async ()
expect(not.values).toContain('variant-3')
expect(not.values).toContain('variant-4')
})

test('Can get a list of suggestable theme variables and namespaces', async () => {
let input = css`
@import 'tailwindcss/utilities';
`

let design = await __unstable__loadDesignSystem(input, {
loadStylesheet: async (_, base) => ({
base,
content: '@tailwind utilities;',
}),
})

let entries = design.getThemeEntries()

expect(entries).toMatchInlineSnapshot(`
[
{
"kind": "variable",
"name": "--default-transition-duration",
},
{
"kind": "variable",
"name": "--default-transition-timing-function",
},
{
"kind": "variable",
"name": "--default-font-family",
},
{
"kind": "variable",
"name": "--default-font-feature-settings",
},
{
"kind": "variable",
"name": "--default-font-variation-settings",
},
{
"kind": "variable",
"name": "--default-mono-font-family",
},
{
"kind": "variable",
"name": "--default-mono-font-feature-settings",
},
{
"kind": "variable",
"name": "--default-mono-font-variation-settings",
},
{
"kind": "namespace",
"name": "--breakpoint",
},
{
"kind": "namespace",
"name": "--color",
},
{
"kind": "namespace",
"name": "--animate",
},
{
"kind": "namespace",
"name": "--blur",
},
{
"kind": "namespace",
"name": "--radius",
},
{
"kind": "namespace",
"name": "--shadow",
},
{
"kind": "namespace",
"name": "--inset-shadow",
},
{
"kind": "namespace",
"name": "--drop-shadow",
},
{
"kind": "variable",
"name": "--spacing",
},
{
"kind": "namespace",
"name": "--container",
},
{
"kind": "namespace",
"name": "--font",
},
{
"kind": "namespace",
"name": "--font-size",
},
{
"kind": "namespace",
"name": "--tracking",
},
{
"kind": "namespace",
"name": "--leading",
},
{
"kind": "namespace",
"name": "--ease",
},
]
`)
})
34 changes: 34 additions & 0 deletions packages/tailwindcss/src/intellisense.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,37 @@ export function getVariants(design: DesignSystem) {

return list
}

export interface ThemeEntry {
kind: 'namespace' | 'variable'
name: string
}

export function getThemeEntries(): ThemeEntry[] {
return [
// Polyfill data for older versions of the design system
{ kind: 'variable', name: '--default-transition-duration' },
{ kind: 'variable', name: '--default-transition-timing-function' },
{ kind: 'variable', name: '--default-font-family' },
{ kind: 'variable', name: '--default-font-feature-settings' },
{ kind: 'variable', name: '--default-font-variation-settings' },
{ kind: 'variable', name: '--default-mono-font-family' },
{ kind: 'variable', name: '--default-mono-font-feature-settings' },
{ kind: 'variable', name: '--default-mono-font-variation-settings' },
{ kind: 'namespace', name: '--breakpoint' },
{ kind: 'namespace', name: '--color' },
{ kind: 'namespace', name: '--animate' },
{ kind: 'namespace', name: '--blur' },
{ kind: 'namespace', name: '--radius' },
{ kind: 'namespace', name: '--shadow' },
{ kind: 'namespace', name: '--inset-shadow' },
{ kind: 'namespace', name: '--drop-shadow' },
{ kind: 'variable', name: '--spacing' },
{ kind: 'namespace', name: '--container' },
{ kind: 'namespace', name: '--font' },
{ kind: 'namespace', name: '--font-size' },
{ kind: 'namespace', name: '--tracking' },
{ kind: 'namespace', name: '--leading' },
{ kind: 'namespace', name: '--ease' },
]
}