Skip to Content
Livery is in early development. Star us on GitHub!
API Reference@livery/coreOverview

Interfaces

BooleanToken

Defined in: types/index.ts:67 

Boolean token definition

Extends

  • TokenDefinitionBase<"boolean", boolean>

Properties

defaultValue?

readonly optional defaultValue: boolean

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "boolean"

Defined in: types/index.ts:68 

Overrides

TokenDefinitionBase.type

CacheConfig

Defined in: types/index.ts:247 

Cache configuration for theme resolver

Properties

maxSize?

readonly optional maxSize: number

Defined in: types/index.ts:253 

Maximum number of cached entries

staleWhileRevalidate?

readonly optional staleWhileRevalidate: boolean

Defined in: types/index.ts:251 

Whether to serve stale data while revalidating

ttl?

readonly optional ttl: number

Defined in: types/index.ts:249 

Time-to-live in milliseconds

ColorToken

Defined in: types/index.ts:36 

Color token definition Accepts hex, rgb, rgba, hsl, hsla values

Extends

  • TokenDefinitionBase<"color", string>

Properties

defaultValue?

readonly optional defaultValue: string

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "color"

Defined in: types/index.ts:37 

Overrides

TokenDefinitionBase.type

CreateCssVarHelperOptions

Defined in: css/index.ts:72 

Options for createCssVarHelper function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Properties

options?

optional options: CssVariableOptions

Defined in: css/index.ts:76 

Optional CSS variable configuration

schema

schema: Schema<T>

Defined in: css/index.ts:74 

The schema to generate variable references for

CreateResolverOptions

Defined in: resolver/index.ts:26 

Options for createResolver function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Properties

cache?

optional cache: CacheConfig

Defined in: resolver/index.ts:32 

Optional cache configuration

fetcher()

fetcher: (params) => Partial<InferTheme<T>> | Promise<Partial<InferTheme<T>>>

Defined in: resolver/index.ts:30 

Function that fetches theme data for a given theme ID

Parameters
params
themeId

string

Returns

Partial<InferTheme<T>> | Promise<Partial<InferTheme<T>>>

schema

schema: Schema<T>

Defined in: resolver/index.ts:28 

The schema to validate theme data against

CreateSchemaOptions

Defined in: schema/index.ts:175 

Options for createSchema function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Properties

definition

definition: T

Defined in: schema/index.ts:177 

The schema definition containing tokens and nested groups

CssVariableOptions

Defined in: types/index.ts:289 

Options for CSS variable generation

Properties

prefix?

readonly optional prefix: string

Defined in: types/index.ts:291 

Prefix for CSS variable names (default: none)

separator?

readonly optional separator: string

Defined in: types/index.ts:293 

Separator between path segments (default: ’-‘)

transformName()?

readonly optional transformName: (path) => string

Defined in: types/index.ts:295 

Transform function for variable names

Parameters
path

string

Returns

string

CssVarOptions

Defined in: css/index.ts:58 

Options for cssVar function

Properties

options?

optional options: CssVariableOptions

Defined in: css/index.ts:62 

Optional CSS variable configuration

path

path: string

Defined in: css/index.ts:60 

Dot-notation path to the token (e.g., “colors.primary”)

DimensionToken

Defined in: types/index.ts:44 

Dimension token definition Accepts values with units: px, rem, em, %, vh, vw, etc.

Extends

  • TokenDefinitionBase<"dimension", string>

Properties

defaultValue?

readonly optional defaultValue: string

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "dimension"

Defined in: types/index.ts:45 

Overrides

TokenDefinitionBase.type

FontFamilyToken

Defined in: types/index.ts:75 

Font family token definition Accepts font family stacks (e.g., “Inter, sans-serif”)

Extends

  • TokenDefinitionBase<"fontFamily", string>

Properties

defaultValue?

readonly optional defaultValue: string

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "fontFamily"

Defined in: types/index.ts:76 

Overrides

TokenDefinitionBase.type

FontWeightToken

Defined in: types/index.ts:83 

Font weight token definition Accepts numeric weights (100-900) or keywords

Extends

  • TokenDefinitionBase<"fontWeight", string | number>

Properties

defaultValue?

readonly optional defaultValue: string | number

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "fontWeight"

Defined in: types/index.ts:84 

Overrides

TokenDefinitionBase.type

GetTokenAtPathOptions

Defined in: schema/index.ts:292 

Options for getTokenAtPath function

Properties

definition

definition: SchemaDefinition

Defined in: schema/index.ts:294 

The schema definition to search in

path

path: string

Defined in: schema/index.ts:296 

Dot-notation path to the token (e.g., “colors.primary”)

GetTokenPathsOptions

Defined in: schema/index.ts:245 

Options for getTokenPaths function

Properties

definition

definition: SchemaDefinition

Defined in: schema/index.ts:247 

The schema definition to extract paths from

prefix?

optional prefix: string

Defined in: schema/index.ts:249 

Optional prefix to prepend to all paths (used for recursion)

NumberToken

Defined in: types/index.ts:52 

Number token definition Accepts numeric values (integers or floats)

Extends

  • TokenDefinitionBase<"number", number>

Properties

defaultValue?

readonly optional defaultValue: number

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "number"

Defined in: types/index.ts:53 

Overrides

TokenDefinitionBase.type

Schema

Defined in: types/index.ts:136 

A validated schema created by createSchema()

Type Parameters

T

T extends SchemaDefinition = SchemaDefinition

Properties

[SCHEMA_BRAND]

readonly [SCHEMA_BRAND]: true

Defined in: types/index.ts:137 

definition

readonly definition: T

Defined in: types/index.ts:138 

ShadowToken

Defined in: types/index.ts:91 

Shadow token definition Accepts CSS box-shadow or text-shadow values

Extends

  • TokenDefinitionBase<"shadow", string>

Properties

defaultValue?

readonly optional defaultValue: string

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "shadow"

Defined in: types/index.ts:92 

Overrides

TokenDefinitionBase.type

StringToken

Defined in: types/index.ts:60 

String token definition Accepts arbitrary string values

Extends

  • TokenDefinitionBase<"string", string>

Properties

defaultValue?

readonly optional defaultValue: string

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "string"

Defined in: types/index.ts:61 

Overrides

TokenDefinitionBase.type

ThemeResolver

Defined in: types/index.ts:271 

A theme resolver instance

Type Parameters

T

T extends SchemaDefinition

Methods

clearCache()

clearCache(): void

Defined in: types/index.ts:277 

Clear all cached themes

Returns

void

get()

get<P>(params): Promise<PathValue<T, P>>

Defined in: types/index.ts:279 

Get a value at a specific path

Type Parameters
P

P

Parameters
params
path

P

themeId

string

Returns

Promise<PathValue<T, P>>

invalidate()

invalidate(params): void

Defined in: types/index.ts:275 

Invalidate cached theme for a theme ID

Parameters
params
themeId

string

Returns

void

resolve()

resolve(params): Promise<InferTheme<T>>

Defined in: types/index.ts:273 

Resolve theme for a theme ID, using cache if available

Parameters
params
themeId

string

Returns

Promise<InferTheme<T>>

ToCssStringAllOptions

Defined in: css/index.ts:278 

Options for toCssStringAll function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

K

K extends string

The union type of theme keys

Properties

attribute?

optional attribute: string

Defined in: css/index.ts:288 

Attribute name for theme selector (default: ‘data-theme’)

defaultTheme?

optional defaultTheme: K

Defined in: css/index.ts:284 

The default theme key (will be applied to :root)

options?

optional options: CssVariableOptions

Defined in: css/index.ts:286 

Optional CSS variable configuration

schema

schema: Schema<T>

Defined in: css/index.ts:280 

The schema to generate variables from

themes

themes: Record<K, InferTheme<T>>

Defined in: css/index.ts:282 

Record of theme names to resolved theme data

ToCssStringOptions

Defined in: css/index.ts:42 

Options for toCssString function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Properties

options?

optional options: CssVariableOptions

Defined in: css/index.ts:48 

Optional CSS variable configuration

schema

schema: Schema<T>

Defined in: css/index.ts:44 

The schema to generate variables from

selector?

optional selector: string

Defined in: css/index.ts:50 

CSS selector for the rule (defaults to ‘:root’)

theme

theme: InferTheme<T>

Defined in: css/index.ts:46 

The resolved theme data

ToCssVariablesOptions

Defined in: css/index.ts:26 

Options for toCssVariables function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Properties

options?

optional options: CssVariableOptions

Defined in: css/index.ts:32 

Optional CSS variable configuration

schema

schema: Schema<T>

Defined in: css/index.ts:28 

The schema to generate variables from

theme

theme: InferTheme<T>

Defined in: css/index.ts:30 

The resolved theme data

UrlToken

Defined in: types/index.ts:99 

URL token definition Accepts URL values (validated format)

Extends

  • TokenDefinitionBase<"url", string>

Properties

defaultValue?

readonly optional defaultValue: string

Defined in: types/index.ts:28 

Inherited from

TokenDefinitionBase.defaultValue

description?

readonly optional description: string

Defined in: types/index.ts:29 

Inherited from

TokenDefinitionBase.description

type

readonly type: "url"

Defined in: types/index.ts:100 

Overrides

TokenDefinitionBase.type

ValidateOptions

Defined in: validation/index.ts:125 

Options for validate function

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Properties

data

data: unknown

Defined in: validation/index.ts:129 

The data to validate

schema

schema: Schema<T>

Defined in: validation/index.ts:127 

The schema to validate against

ValidationError

Defined in: types/index.ts:226 

A single validation error

Properties

expected

readonly expected: "object" | TokenType

Defined in: types/index.ts:229 

message

readonly message: string

Defined in: types/index.ts:228 

path

readonly path: string

Defined in: types/index.ts:227 

received

readonly received: unknown

Defined in: types/index.ts:230 

Type Aliases

InferTheme

InferTheme<T> = \{ [K in keyof T]: T[K] extends TokenDefinition ? TokenTypeToValue<T[K]> : T[K] extends SchemaDefinition ? InferTheme<T[K]> : never \}

Defined in: types/index.ts:172 

Infers the theme type from a schema definition Recursively processes nested groups

Type Parameters

T

T extends SchemaDefinition

PathValue

PathValue<T, P> = P extends `$\{infer Head\}.$\{infer Tail\}` ? Head extends keyof T ? T[Head] extends SchemaDefinition ? PathValue<T[Head], Tail> : never : never : P extends keyof T ? T[P] extends TokenDefinition ? TokenTypeToValue<T[P]> : T[P] extends SchemaDefinition ? InferTheme<T[P]> : never : never

Defined in: types/index.ts:197 

Gets the value type at a specific path in the theme

Type Parameters

T

T extends SchemaDefinition

P

P extends string

SchemaDefinition

SchemaDefinition = object

Defined in: types/index.ts:124 

A schema definition can contain tokens or nested groups

Index Signature

[key: string]: TokenDefinition | SchemaDefinition

ThemePath

ThemePath<T, Prefix> = \{ [K in keyof T & string]: T[K] extends TokenDefinition ? Prefix extends "" ? K : `$\{Prefix\}.$\{K\}` : T[K] extends SchemaDefinition ? ThemePath<T[K], Prefix extends "" ? K : `$\{Prefix\}.$\{K\}`> : never \}[keyof T & string]

Defined in: types/index.ts:184 

Helper to extract all valid paths from a schema Returns dot-notation paths like “colors.primary” or “spacing.md”

Type Parameters

T

T extends SchemaDefinition

Prefix

Prefix extends string = ""

TokenDefinition

TokenDefinition = ColorToken | DimensionToken | NumberToken | StringToken | BooleanToken | FontFamilyToken | FontWeightToken | ShadowToken | UrlToken

Defined in: types/index.ts:106 

Union of all token definition types

TokenType

TokenType = "color" | "dimension" | "number" | "string" | "boolean" | "fontFamily" | "fontWeight" | "shadow" | "url"

Defined in: types/index.ts:12 

Supported token types in the theming system

ValidationMode

ValidationMode = "strict" | "coerce" | "partial"

Defined in: types/index.ts:221 

Validation mode for theme data

ValidationResult

ValidationResult<T> = { data: T; success: true; } | { errors: readonly ValidationError[]; success: false; }

Defined in: types/index.ts:236 

Result of validation - either success with data or failure with errors

Type Parameters

T

T

Variables

t

const t: object

Defined in: schema/tokens.ts:203 

Token builders namespace

Type Declaration

boolean()

readonly boolean(): BooleanTokenBuilder

Creates a boolean token

Returns

BooleanTokenBuilder

color()

readonly color(): ColorTokenBuilder

Creates a color token

Returns

ColorTokenBuilder

A color token builder

Remarks

Accepts hex (#RGB, #RRGGBB, #RRGGBBAA), rgb/rgba, and hsl/hsla values

dimension()

readonly dimension(): DimensionTokenBuilder

Creates a dimension token Accepts values with units: px, rem, em, %, vh, vw, etc.

Returns

DimensionTokenBuilder

fontFamily()

readonly fontFamily(): FontFamilyTokenBuilder

Creates a font family token Accepts font family stacks (e.g., “Inter, sans-serif”)

Returns

FontFamilyTokenBuilder

fontWeight()

readonly fontWeight(): FontWeightTokenBuilder

Creates a font weight token Accepts numeric weights (100-900) or keywords

Returns

FontWeightTokenBuilder

number()

readonly number(): NumberTokenBuilder

Creates a number token Accepts numeric values (integers or floats)

Returns

NumberTokenBuilder

shadow()

readonly shadow(): ShadowTokenBuilder

Creates a shadow token Accepts CSS box-shadow or text-shadow values

Returns

ShadowTokenBuilder

string()

readonly string(): StringTokenBuilder

Creates a string token Accepts arbitrary string values

Returns

StringTokenBuilder

url()

readonly url(): UrlTokenBuilder

Creates a URL token Accepts URL values (validated format)

Returns

UrlTokenBuilder

Remarks

Provides a fluent API for defining tokens in a schema. Inspired by Zod’s builder pattern.

Example

const schema = createSchema({
  definition: {
    colors: {
      primary: t.color().default('#3b82f6'),
      background: t.color().describe('Page background color'),
    },
    spacing: {
      sm: t.dimension().default('4px'),
      md: t.dimension().default('8px'),
    },
  },
});

Functions

coerce()

coerce<T>(options): ValidationResult<InferTheme<T>>

Defined in: validation/index.ts:223 

Validates and coerces theme data

Attempts to convert values to the correct type when possible. For example, “123” -> 123 for number tokens.

Type Parameters

T

T extends SchemaDefinition

Parameters

options

ValidateOptions<T>

Validation options containing schema and data

Returns

ValidationResult<InferTheme<T>>

Validation result with coerced typed data or errors

Example

const result = coerce({ schema, data: rawThemeData });
if (result.success) {
  console.log(result.data);
}

createCssVarHelper()

createCssVarHelper<T>(opts): <P>(path) => string

Defined in: css/index.ts:263 

Creates a typed helper for generating CSS variable references

Type Parameters

T

T extends SchemaDefinition

Parameters

opts

CreateCssVarHelperOptions<T>

Options containing schema and optional CSS variable configuration

Returns

A function that takes a path and returns the CSS var() reference

<P>(path): string

Type Parameters
P

P extends string

Parameters
path

P

Returns

string

Example

const themeVar = createCssVarHelper({ schema });
 
// Fully typed - only valid paths are allowed
const primary = themeVar('colors.primary');
// 'var(--colors-primary)'

createResolver()

createResolver<T>(opts): ThemeResolver<T>

Defined in: resolver/index.ts:132 

Creates a theme resolver with caching support

Type Parameters

T

T extends SchemaDefinition

The type of the schema definition

Parameters

opts

CreateResolverOptions<T>

Options containing schema, fetcher, and optional cache configuration

Returns

ThemeResolver<T>

A ThemeResolver instance with resolve, invalidate, clearCache, and get methods

Remarks

The resolver:

  • Fetches theme data using the provided fetcher function
  • Merges fetched data with schema defaults
  • Validates and coerces the merged data
  • Caches resolved themes with configurable TTL
  • Supports stale-while-revalidate for better performance

Example

const resolver = createResolver({
  schema,
  fetcher: async ({ themeId }) => {
    return await db.themes.findByTheme(themeId);
  },
  cache: {
    ttl: 60000, // 1 minute
    staleWhileRevalidate: true,
  },
});
 
// Resolve a complete theme
const theme = await resolver.resolve({ themeId: 'theme-123' });
 
// Get a specific value
const primaryColor = await resolver.get({ themeId: 'theme-123', path: 'colors.primary' });
 
// Invalidate cache for a theme
resolver.invalidate({ themeId: 'theme-123' });

createSchema()

createSchema<T>(opts): Schema<T>

Defined in: schema/index.ts:203 

Creates a validated schema from a definition object

Type Parameters

T

T extends SchemaDefinition

Parameters

opts

CreateSchemaOptions<T>

Options containing the schema definition

Returns

Schema<T>

A validated Schema object

Example

const schema = createSchema({
  definition: {
    colors: {
      primary: t.color().default('#3b82f6'),
      secondary: t.color(),
    },
    spacing: {
      sm: t.dimension().default('4px'),
      md: t.dimension().default('8px'),
      lg: t.dimension().default('16px'),
    },
  },
});

cssVar()

cssVar(opts): string

Defined in: css/index.ts:233 

Generates CSS variable reference (var()) for a token path

Parameters

opts

CssVarOptions

Options containing path and optional CSS variable configuration

Returns

string

CSS var() function call

Example

const ref = cssVar({ path: 'colors.primary' });
// 'var(--colors-primary)'
 
const withPrefix = cssVar({ path: 'colors.primary', options: { prefix: 'theme' } });
// 'var(--theme-colors-primary)'

escapeCssValue()

escapeCssValue(value): string

Defined in: validation/css-escape.ts:83 

Escapes a CSS value to prevent injection attacks

Parameters

value

string

The CSS value to escape

Returns

string

The escaped CSS value safe for use in CSS declarations

Remarks

This function escapes characters that could be used to break out of CSS variable declarations or inject malicious CSS:

  • Backslashes (\) - could be used to escape other escapes
  • Quotes (” and ’) - could break out of quoted values
  • Semicolons (;) - could end declarations and start new ones
  • Braces ({ and }) - could end rules and start new ones
  • Newlines (\n and \r) - could break parsing

The function is idempotent and safe to call multiple times.

Example

// Escaping a potentially malicious value
escapeCssValue('red; } body { background: url(evil); } .x {');
// Returns: 'red\\; \\} body \\{ background: url(evil)\\; \\} .x \\{'
 
// Safe values pass through unchanged (except for the escaping of special chars)
escapeCssValue('#3b82f6');
// Returns: '#3b82f6'
 
// Empty strings are handled safely
escapeCssValue('');
// Returns: ''

getTokenAtPath()

getTokenAtPath(opts): TokenDefinition | undefined

Defined in: schema/index.ts:322 

Gets a token definition at a specific path

Parameters

opts

GetTokenAtPathOptions

Options containing the schema definition and path

Returns

TokenDefinition | undefined

The token definition if found, otherwise undefined

Remarks

Navigates through nested groups using dot-notation path. Returns undefined if the path doesn’t exist or points to a nested group.

Example

const definition = {
  colors: { primary: t.color(), secondary: t.color() },
  spacing: { sm: t.dimension() }
};
getTokenAtPath({ definition, path: 'colors.primary' });
// { type: 'color', defaultValue: ... }
 
getTokenAtPath({ definition, path: 'colors' });
// undefined (not a token, it's a group)

getTokenPaths()

getTokenPaths(opts): string[]

Defined in: schema/index.ts:272 

Gets all token paths from a schema definition

Parameters

opts

GetTokenPathsOptions

Options containing the schema definition and optional prefix

Returns

string[]

Array of dot-notation paths to all tokens in the schema

Remarks

Recursively traverses the schema definition and collects the paths to all token definitions. Nested groups are traversed but not included in the result.

Example

const definition = {
  colors: { primary: t.color(), secondary: t.color() },
  spacing: { sm: t.dimension() }
};
getTokenPaths({ definition });
// ['colors.primary', 'colors.secondary', 'spacing.sm']

isSchema()

isSchema<T>(value): value is Schema<T>

Defined in: schema/index.ts:108 

Type guard to check if a value is a Schema

Type Parameters

T

T extends SchemaDefinition

The schema definition type

Parameters

value

unknown

The value to check

Returns

value is Schema<T>

True if the value is a branded Schema object created by createSchema

Remarks

Schemas are branded objects created by the createSchema function. This type guard checks for the presence of the internal brand symbol.

Example

const schema = createSchema({ definition: { colors: { primary: t.color() } } });
isSchema(schema); // true
isSchema({ definition: {} }); // false

isSchemaDefinition()

isSchemaDefinition(value): value is SchemaDefinition

Defined in: schema/index.ts:76 

Type guard to check if a value is a schema definition (nested group)

Parameters

value

unknown

The value to check

Returns

value is SchemaDefinition

True if the value is a nested group (object that’s not a token definition)

Remarks

A schema definition is an object that contains other tokens or nested groups. It’s distinguished from a token definition by not having a ‘type’ property.

Example

isSchemaDefinition({ primary: { type: 'color' } }); // true (nested group)
isSchemaDefinition({ type: 'color' }); // false (token definition)

isTokenDefinition()

isTokenDefinition(value): value is TokenDefinition

Defined in: schema/index.ts:51 

Type guard to check if a value is a token definition

Parameters

value

unknown

The value to check

Returns

value is TokenDefinition

True if the value is a token definition with a valid type property

Remarks

A token definition is an object with a ‘type’ property that matches one of the valid token types.

Example

isTokenDefinition({ type: 'color' }); // true
isTokenDefinition({ type: 'invalid' }); // false
isTokenDefinition('string'); // false

needsCssEscaping()

needsCssEscaping(value): boolean

Defined in: validation/css-escape.ts:109 

Checks if a CSS value contains potentially dangerous characters

Parameters

value

string

The CSS value to check

Returns

boolean

True if the value contains characters that would be escaped

Remarks

This is a fast check to determine if escaping is needed. Useful for optimization when processing many values.

Example

needsCssEscaping('red');           // false
needsCssEscaping('red; evil: x');  // true

toCssString()

toCssString<T>(opts): string

Defined in: css/index.ts:206 

Converts a resolved theme to a CSS string for injection

Generates a complete CSS rule with custom properties.

Type Parameters

T

T extends SchemaDefinition

Parameters

opts

ToCssStringOptions<T>

Options containing schema, theme, selector, and optional CSS variable configuration

Returns

string

CSS string ready for injection

Example

const css = toCssString({ schema, theme });
// :root {
//   --colors-primary: #3b82f6;
//   --spacing-md: 16px;
// }
 
// With custom selector
const scopedCss = toCssString({ schema, theme, selector: '.theme-container' });
// .theme-container {
//   --colors-primary: #3b82f6;
//   --spacing-md: 16px;
// }

toCssStringAll()

toCssStringAll<T, K>(opts): string

Defined in: css/index.ts:317 

Generates CSS for multiple themes with selectors

Creates CSS rules with [data-theme="<key>"] selectors for each theme. The default theme is also applied to :root for initial load.

Type Parameters

T

T extends SchemaDefinition

K

K extends string

Parameters

opts

ToCssStringAllOptions<T, K>

Options containing schema, themes, defaultTheme, and optional CSS variable configuration

Returns

string

CSS string with all themes

Example

const css = toCssStringAll({
  schema,
  themes: { light: lightTheme, dark: darkTheme },
  defaultTheme: 'light',
});
// :root, [data-theme="light"] {
//   --colors-primary: #14b8a6;
//   --colors-background: #ffffff;
// }
// [data-theme="dark"] {
//   --colors-primary: #2dd4bf;
//   --colors-background: #0f172a;
// }

toCssVariables()

toCssVariables<T>(opts): Record<string, string>

Defined in: css/index.ts:169 

Converts a resolved theme to CSS custom properties (variables)

Returns an object mapping variable names to values.

Type Parameters

T

T extends SchemaDefinition

Parameters

opts

ToCssVariablesOptions<T>

Options containing schema, theme, and optional CSS variable configuration

Returns

Record<string, string>

Object mapping CSS variable names to values

Example

const variables = toCssVariables({ schema, theme });
// { '--colors-primary': '#3b82f6', '--spacing-md': '16px', ... }
 
// With prefix
const prefixed = toCssVariables({ schema, theme, options: { prefix: 'theme' } });
// { '--theme-colors-primary': '#3b82f6', '--theme-spacing-md': '16px', ... }

validate()

validate<T>(options): ValidationResult<InferTheme<T>>

Defined in: validation/index.ts:177 

Validates theme data against a schema in strict mode

All required values must be present and match their token types exactly.

Type Parameters

T

T extends SchemaDefinition

Parameters

options

ValidateOptions<T>

Validation options containing schema and data

Returns

ValidationResult<InferTheme<T>>

Validation result with typed data or errors

Example

const result = validate({ schema, data: themeData });
if (result.success) {
  console.log(result.data);
}

validatePartial()

validatePartial<T>(options): ValidationResult<Partial<InferTheme<T>>>

Defined in: validation/index.ts:200 

Validates theme data in partial mode

Missing values are allowed and won’t cause errors. Useful for validating partial updates.

Type Parameters

T

T extends SchemaDefinition

Parameters

options

ValidateOptions<T>

Validation options containing schema and data

Returns

ValidationResult<Partial<InferTheme<T>>>

Validation result with typed partial data or errors

Example

const result = validatePartial({ schema, data: partialTheme });
if (result.success) {
  console.log(result.data);
}
Last updated on
OverviewOverview