0.2.3 ā¢ Published 4 years ago
nuxt-windicss-module v0.2.3
Features
- ā”ļø It's FAST - 20~100x times faster than @nuxtjs/tailwindcss
- š§© On-demand CSS utilities (Compatible with Tailwind CSS v2) and native elements style resetting
- š Load configurations from
tailwind.config.js
- š CSS
@apply
/@screen
directives transforms - š³ Support Utility Groups - e.g.
bg-gray-200 hover:(bg-gray-100 text-red-300)
- š§āš¤āš§ Compatible with nuxt-vite
Install
yarn add nuxt-windicss-module -D
# npm i nuxt-windicss-module -D
:warning: This module is a pre-release, please report any issues you find.
Usage
Within your nuxt.config.js
add the following.
// nuxt.config.js
buildModules: [
'nuxt-windicss-module',
],
This module won't work with @nuxtjs/tailwindcss
, you will need to remove it.
buildModules: [
- '@nuxtjs/tailwindcss',
],
This module will read from your root tailwind.config.js
or windi.config.js
config if present. See here for details.
Migrating
If you were previously using @nuxtjs/tailwindcss
, please consult the documentation on migrating.
Configuration
- Default:
windicss: {
scan: {
dirs: ['./'],
exclude: ['.nuxt/**/*']
},
transformCSS: 'pre',
preflight: {
alias: {
// add nuxt aliases
'nuxt-link': 'a',
}
}
}
- See options.ts for configuration reference.
Hooks
You can use the following nuxt hooks to modify the behaviour of the code.
windicss:config
- Arguments: options
Modify the windicss configuration before it is passed to the webpack plugin.
Caveats
Scoped Style
@media
directive with scoped style can only work with css
postcss
scss
but not sass
, less
nor stylus
Credits
- Windy team
- @antfu Based on his Rollup / Vite implementation & his util package
License
MIT License Ā© 2021 Harlan Wilton