Plugin Options

Configuration options for @hono-email/tailwind-plugin. Passed to the bundler plugin factory functions (Vite, Rollup, Webpack, Esbuild, etc.).

---

EmailTailwindPluginOptions

export type EmailTailwindPluginOptions = {
  configPath?: string
  css?: string
  packageNames?: string[]
  runtimeModuleSpecifier?: string
  safelist?: string[]
}

configPath Optional

Type: string

Path to a custom Tailwind Configuration file (e.g., './tailwind.config.js'). If omitted, the plugin resolves config files from the workspace root automatically.

css Optional

Type: string

Additional raw CSS appended to the generated Tailwind CSS artifacts. Useful for injecting base variables or custom layer directives.

packageNames Optional

Type: string[]

Specifies the package names containing the <Tailwind> component that the plugin should scan for transformation. Defaults to ['hono-email'].

runtimeModuleSpecifier Optional

Type: string

Specifies a custom module path for importing runtime helpers injected by the plugin. Primarily used for advanced monorepo setups or testing.

safelist Optional

Type: string[]

An array of Tailwind classes to always generate and include in the build output, even if they are not statically detected in email templates.