Interface ModuleOptions

src/types.ts:91–153

}

export interface ModuleOptions {
  /**
   * The path of the Tailwind configuration file. The extension can be omitted, in which case it will try to find a `.js`, `.cjs`, `.mjs`, or `.ts` file.
   *
   * @default []
   * @deprecated provide string in `config`
   */
  configPath: Arrayable<string>
  /**
   * The path of the Tailwind CSS file. If the file does not exist, the module's default CSS file will be imported instead.
   *
   * @default '~/assets/css/tailwind.css'
   */
  cssPath: string | false | [string, { injectPosition: InjectPosition }]
  /**
   * Configuration for Tailwind CSS. Accepts (array of) string and inline configurations.
   *
   * for default, see https://tailwindcss.nuxtjs.org/tailwind/config
   */
  config: Arrayable<InlineTWConfig | string>
  /**
   * [tailwind-config-viewer](https://github.com/rogden/tailwind-config-viewer) usage *in development*
   *
   * @default true // { endpoint: '_tailwind' }
   */
  viewer: BoolObj<ViewerConfig>
  /**
   * Usage of configuration references in runtime. See https://tailwindcss.nuxtjs.org/tailwind/config#referencing-in-the-application
   *
   * @default false // if true, { alias: '#tailwind-config', level: 2 }
   */
  exposeConfig: BoolObj<ExposeConfig>
  /**
   * Suppress logging to the console when everything is ok
   *
   * @default nuxt.options.logLevel === 'silent'
   */
  quiet: boolean
  /**
   * Enable some utilities for better editor support and DX.
   *
   * Read https://tailwindcss.nuxtjs.org/tailwind/editor-support.
   *
   * @default false // if true, { autocompleteUtil: true }
   */
  editorSupport: BoolObj<EditorSupportConfig>
  /**
   * Enable module experimental functionalities.
   *
   * @default false
   */
  experimental?: Partial<ExperimentalOptions>
  /**
   * This option falls back to the Tailwind configuration inlined to the PostCSS
   * loader, so any configuration changes while the dev server is running will
   * not reflect. This is similar to the functionality prior to v6.12.0.
   *
   * Note: this is only provided for temporary broken builds that may require