Quick start with class-recipe
This page styles a button and a card with Tailwind CSS classes. The same steps apply to any CSS approach. Install the package first (see Installation). The glossary defines each term.
1. Create a recipe
Section titled “1. Create a recipe”cva takes the classes of an element: those it always has, in base, and
those of each option of each
variant, in variants. The
recipe below also has a
compound variant: classes
that it adds only when several variants have particular options at the
same time. Here, the hover color applies only to a primary button that is
not loading. Create the recipe once, at the top level of a module:
import { cva } from "@lynstack/class-recipe";
export const button = cva({ base: "inline-flex items-center rounded-md font-medium", variants: { tone: { primary: "bg-blue-600 text-white", neutral: "bg-gray-100 text-gray-900", }, size: { sm: "h-8 px-3 text-sm", md: "h-10 px-4", }, loading: { true: "cursor-wait opacity-75", }, }, compoundVariants: [ { variants: { tone: "primary", loading: false }, className: "hover:bg-blue-700", }, ], defaultVariants: { tone: "primary", size: "md" },});2. Call it
Section titled “2. Call it”A recipe takes a selection, the variants you choose, and returns the class name:
button()→ "inline-flex items-center rounded-md font-medium bg-blue-600 text-white h-10 px-4 hover:bg-blue-700"button({ tone: "neutral", size: "sm" })→ "inline-flex items-center rounded-md font-medium bg-gray-100 text-gray-900 h-8 px-3 text-sm"button({ loading: true })→ "inline-flex items-center rounded-md font-medium bg-blue-600 text-white h-10 px-4 cursor-wait opacity-75"toneandsizehave defaults, so a selection may leave them out.loadingdeclares onlytrue, so it is a boolean variant: optional, andfalseby default.- The compound variant adds its classes when
toneisprimaryandloadingisfalse, which the first call matches through the defaults.
3. Use it in a component
Section titled “3. Use it in a component”VariantsOf types a component’s props from its recipe, and the recipe
takes a className that it adds last:
import type { ComponentProps } from "react";import type { VariantsOf } from "@lynstack/class-recipe";
type ButtonProps = ComponentProps<"button"> & VariantsOf<typeof button>;
export function Button({ tone, size, loading, className, ...props}: ButtonProps) { return ( <button className={button({ tone, size, loading, className })} {...props} /> );}See Building components for
passing all props at once with variantKeys, and for variant names such
as size that HTML elements also use.
4. Style several elements with sva
Section titled “4. Style several elements with sva”A component with several elements, its slots, uses one slot recipe, which returns the class name of every slot:
import { sva } from "@lynstack/class-recipe";
export const card = sva({ slots: ["root", "header", "body"], base: { root: "rounded-lg border", header: "font-semibold", body: "text-gray-600", }, variants: { size: { sm: { root: "p-3", header: "text-sm" }, md: { root: "p-5", header: "text-base" }, }, }, defaultVariants: { size: "md" },});card({ size: "sm" })→ { root: "rounded-lg border p-3", header: "font-semibold text-sm", body: "text-gray-600", }See sva.
5. Resolve conflicts, if you need to
Section titled “5. Resolve conflicts, if you need to”Do you need tailwind-merge? No, if your recipes are conflict-free. Yes, if
a className that a caller passes must replace the recipe’s classes.
With the default join, every class is kept, so a recipe should never set
one CSS property twice (see
Writing conflict-free recipes).
To let classes override each other instead, create the functions with
twMerge, once, in a module of your own:
import { createRecipes } from "@lynstack/class-recipe";import { twMerge } from "tailwind-merge";
export const { cx, cva, sva } = createRecipes({ join: twMerge });See Merging classes.
Next steps
Section titled “Next steps”- Variants explains required, default, boolean, and compound variants in depth.
- Writing conflict-free recipes
shows how to design recipes that need no
tailwind-merge. - Cookbook has recipes for common components.