Skip to main content

GenerateThemeOptions<T>

Options for generating a color theme

Example​

const options: GenerateThemeOptions = {
  baseColor: '#ff0000',
  expandPalette: true,
  colorScheme: 'complementary',
  infoHue: 200,
  successHue: 120,
  warningHue: 40,
  errorHue: 0
};

Type Parameters​

Type ParameterDefault typeDescription
T extends booleanfalseBoolean type parameter that determines if the theme palette should be expanded

Properties​

baseColor​

baseColor: `#${string}`;

The base color to generate the theme from

Defined in​

tailwind/tailwind.type.ts:45

colorScheme?​

optional colorScheme: ColorSchemeType;

The type of color scheme to generate

Defined in​

tailwind/tailwind.type.ts:47

errorHue?​

optional errorHue: number;

The hue value for error colors

Defined in​

tailwind/tailwind.type.ts:51

expandPalette?​

optional expandPalette: T;

Whether to generate an expanded palette with additional shades

Defined in​

tailwind/tailwind.type.ts:46

infoHue?​

optional infoHue: number;

The hue value for info colors

Defined in​

tailwind/tailwind.type.ts:48

successHue?​

optional successHue: number;

The hue value for success colors

Defined in​

tailwind/tailwind.type.ts:49

warningHue?​

optional warningHue: number;

The hue value for warning colors

Defined in​

tailwind/tailwind.type.ts:50