@themvora/tailwind

Provides createTailwindPlugin (emits the theme as CSS variables usable by Tailwind utilities), synchronizeDarkClass (keeps Tailwind's dark variant in sync with the runtime), and the themeCSS helper.

Generated from packages/tailwind/src by apps/docs/scripts/generate-api-reference.mjs. Do not edit by hand — run pnpm --filter @themvora/docs api:generate.

Functions

createTailwindPlugin(options?): { name: string }

Creates a Tailwind plugin for Themvora.

The plugin registers Themvora with Tailwind so that theme tokens can be consumed as Tailwind utilities. It is configured with the theme definitions and an optional default theme.

See also: synchronizeDarkClass, themeCSS

Returns { name: string } — A Tailwind plugin object.

import { createTailwindPlugin } from "@themvora/tailwind";
import { getBuiltInThemes } from "@themvora/core";

export default {
  plugins: [
    createTailwindPlugin({
      themes: getBuiltInThemes(),
      defaultTheme: "light",
    }),
  ],
};

synchronizeDarkClass(theme): void

Synchronizes the dark class on the document root with the given theme's mode.

Adds the dark class when the theme's mode is "dark" and removes it otherwise. No-op when document is unavailable (for example during SSR).

See also: createTailwindPlugin

Returns void

Interfaces

TailwindPluginOptions

Options for createTailwindPlugin.

See also: createTailwindPlugin

Variables

themeCSS

A CSS string containing the Themvora Tailwind theme CSS.

Points to the generated theme CSS file (./theme.css) that defines the theme tokens as CSS variables for use with Tailwind.

See also: createTailwindPlugin

"/* Theme CSS is available at ./theme.css */"

Related docs

• Tailwind CSS — the adapter integration