Skip to main content

Function: mergeThemeConfig()

mergeThemeConfig<T, U>(baseTheme: T, overrides: U): { [KeyType in string | number | symbol]: ({ [Key in string | number | symbol as Key extends keyof PickIndexSignature<U> ? never : Key]: PickIndexSignature<T>[Key] } & PickIndexSignature<U> & { [Key in string | number | symbol as Key extends keyof OmitIndexSignature<U> ? never : Key]: OmitIndexSignature<T>[Key] } & OmitIndexSignature<U>)[KeyType] }

Defined in: shared/types/themeConfig.ts:815

Merges theme overrides with base theme configuration using type-safe merging.

Type Parameters​

T​

T extends ThemeConfig

U​

U extends ThemeOverride

Parameters​

baseTheme​

T

Base theme configuration

overrides​

U

Theme overrides to apply

Returns​

{ [KeyType in string | number | symbol]: ({ [Key in string | number | symbol as Key extends keyof PickIndexSignature<U> ? never : Key]: PickIndexSignature<T>[Key] } & PickIndexSignature<U> & { [Key in string | number | symbol as Key extends keyof OmitIndexSignature<U> ? never : Key]: OmitIndexSignature<T>[Key] } & OmitIndexSignature<U>)[KeyType] }

Merged theme configuration with type-safe property resolution

Remarks​

Uses type-fest's Merge utility to combine theme configurations with proper type safety. This provides better type inference than manual object spreading and ensures all properties are handled correctly.

Example​

const baseTheme: ThemeConfig = getBaseTheme();
const overrides: ThemeOverride = {
    colors: { text: { primary: "#007bff" } },
    spacing: { lg: "20px" },
};

const mergedTheme = mergeThemeConfig(baseTheme, overrides);
// Result is fully typed with merged properties