Skip to content

class-recipe FAQ

No, if your recipes are conflict-free. Yes, if a className that a caller passes must replace the recipe’s classes. See Merging classes.

A variant without a default is required, so a component cannot forget to choose it. Give it a default in defaultVariants to make it optional. To add no classes when a call leaves it out, declare an option without classes, such as none: "", and make it the default. A boolean variant, whose only options are true and false, is always optional. See Variants.

Why does creating a recipe throw a TypeError?

Section titled “Why does creating a recipe throw a TypeError?”

The config has the wrong shape, which TypeScript reports as an error too. The message names the part to fix. The most common ones:

  • The config has no variants. variants is required, even when the recipe has none: pass variants: {}.
  • A compound variant gives its classes under class, as class-variance-authority and tailwind-variants do. Rename it to className in cva, or classNames in sva.
  • Classes are an array, false, or null.
  • A slot recipe gets a string where it takes the classes of each slot.

See cva and Migrating from tailwind-variants.

Why does the console warn that a recipe’s config names what it does not declare?

Section titled “Why does the console warn that a recipe’s config names what it does not declare?”

A default, a compound variant, or the classes of a slot name a variant, an option, or a slot that the config does not declare, usually a typo in a config declared before the call, where TypeScript does not catch every one. The recipe adds no classes for that name. The message lists each one; fix the name, or declare it. See Names the config does not declare.

Which merge library for Tailwind CSS v3 or v4?

Section titled “Which merge library for Tailwind CSS v3 or v4?”

On Tailwind CSS v4, use tailwind-merge v3, or cn. On Tailwind CSS v3, use tailwind-merge v2: cn and tailwind-merge v3 support only v4. See Using cn.

Why do I get “A recipe composes only recipes created by @lynstack/recipe”?

Section titled “Why do I get “A recipe composes only recipes created by @lynstack/recipe”?”

composes lists something that is not a recipe of the package, or the app installs two copies of @lynstack/recipe, the package that class-recipe is built on, since each copy knows only its own recipes. Check that the app installs one copy, with npm ls @lynstack/recipe, and deduplicate it, with npm dedupe or your package manager’s equivalent. See Composing recipes.

Why does my interface not satisfy the type of variants?

Section titled “Why does my interface not satisfy the type of variants?”

TypeScript reports “Index signature for type ‘string’ is missing” when you type the variants with an interface. An interface has no index signature. Write the type with type instead. See Typing recipes.

Why is size a type error on my input component?

Section titled “Why is size a type error on my input component?”

<input> already has a size attribute, which is a number, so it conflicts with a size variant. Remove the attribute from the props with Omit<ComponentProps<"input">, "size">. The same applies to type and other attribute names. See Building components.

Put breakpoint classes in the options, such as two: "grid-cols-1 md:grid-cols-2", or declare an option for each responsive behavior. A recipe takes one option per variant, not an option per breakpoint. See Migrating from tailwind-variants.

How do I get a props type that includes className?

Section titled “How do I get a props type that includes className?”

Use PropsOf<typeof button>: the variants of the recipe and its className, or classNames for a slot recipe. RecipeProps<typeof button> is a type error: RecipeProps takes the parts of a config, not a recipe. See Typing recipes.

Yes. A recipe is pure, and its cache holds only the class names of declared selections, never className or other props, so requests can share it. Create recipes at the top level of a module. If the variants come from requests and the recipe declares many combinations, turn its cache off. See Frameworks and SSR.

Yes. A recipe joins any class names: CSS Modules, plain stylesheets, or any utility framework. Only tailwind-merge is specific to Tailwind CSS, and you need it only to resolve conflicts. See the overview.

Bundlephobia shows its size. It ships as ES modules only, is tree-shakable, and has one dependency, @lynstack/recipe.

  • Glossary defines the terms these docs use.
  • Variants explains how a recipe reads its props.