diff --git a/docs/content/1.getting-started/1.setup.md b/docs/content/1.getting-started/1.setup.md index 0d051bd9..71e96771 100644 --- a/docs/content/1.getting-started/1.setup.md +++ b/docs/content/1.getting-started/1.setup.md @@ -47,10 +47,10 @@ Discover your color palette based on your Tailwind config with the [Tailwind vie ## Tailwind Files -When running `nuxt dev`, this module will look for these two files: +When running `nuxt dev`, this module will look for these files: - `./assets/css/tailwind.css` -- `./tailwind.config.js` +- `./tailwind.config.{js,ts}` If they don't exist, the module will inject a basic configuration for each one so you don't have to create these files. @@ -62,6 +62,22 @@ You can configure the paths in the [module options](/getting-started/options). Learn more about overwriting the Tailwind configuration in the [Tailwind Config](/tailwind/config) section. +## TypeScript (optional) + +Officially Tailwind config files are plain JavaScript, however with this module, you can optionally use a TypeScript file for your config. + +To do so, rename `tailwind.config.js` to `tailwind.config.ts` and use the types from the tailwindcss module. + +```ts [tailwind.config.ts] +import { Config } from 'tailwindcss' + +export default { + theme: { + extend: {} + }, +} +``` + ## Options You can customize the module's behavior by using the `tailwindcss` property in `nuxt.config`: diff --git a/playground/tailwind.config.js b/playground/tailwind.config.js deleted file mode 100644 index b1c6ea43..00000000 --- a/playground/tailwind.config.js +++ /dev/null @@ -1 +0,0 @@ -export default {} diff --git a/playground/tailwind.config.ts b/playground/tailwind.config.ts new file mode 100644 index 00000000..f681b928 --- /dev/null +++ b/playground/tailwind.config.ts @@ -0,0 +1,6 @@ +import type { Config } from 'tailwindcss' + +export default { + theme: { + }, +} diff --git a/src/module.ts b/src/module.ts index 216c75ec..61a75c52 100644 --- a/src/module.ts +++ b/src/module.ts @@ -29,7 +29,7 @@ export default defineNuxtModule({ configKey: 'tailwindcss' }, defaults: nuxt => ({ - configPath: 'tailwind.config.js', + configPath: 'tailwind.config', cssPath: join(nuxt.options.dir.assets, 'css/tailwind.css'), config: defaultTailwindConfig(nuxt.options), viewer: true, diff --git a/src/tailwind.config.ts b/src/tailwind.config.ts index 1fc77f01..a4ca4dca 100644 --- a/src/tailwind.config.ts +++ b/src/tailwind.config.ts @@ -1,5 +1,7 @@ // Learn more at https://tailwindcss.com/docs/configuration -export default ({ srcDir }) => ({ +import { Config } from 'tailwindcss' + +export default ({ srcDir }): Config => ({ theme: { extend: {} },