Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/windicss/nuxt-windicss
🍃 Windi CSS for Nuxt ⚡
https://github.com/windicss/nuxt-windicss
Last synced: 3 months ago
JSON representation
🍃 Windi CSS for Nuxt ⚡
- Host: GitHub
- URL: https://github.com/windicss/nuxt-windicss
- Owner: windicss
- Created: 2021-03-03T03:37:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T11:59:38.000Z (about 1 year ago)
- Last Synced: 2024-03-14T01:16:32.434Z (3 months ago)
- Language: Vue
- Homepage:
- Size: 6.34 MB
- Stars: 332
- Watchers: 6
- Forks: 24
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Lists
- awesome-stars - nuxt-windicss
- awesome-windicss - nuxt-windicss-module
README
Windi CSS for Nuxt.js! ⚡️
Next generation utility-first CSS framework.
![]()
Status: Stable v2 ✅ , bridge ✅, v3 ✅
Made possible by my Sponsor Program 💖
Follow me @harlan_zw 🐦
![]()
## Features
- 🧩 On-demand CSS utilities (Compatible with Tailwind CSS v2) and native elements style resetting
- 📄 Use [directives](https://windicss.org/features/directives.html) in any CSS lang `@apply`, `@variants`, `@screen`, `@layer`, `theme()` (Note: Vite / Nuxt v3 has limited support)
- 🎳 Support Utility Groups - e.g. `bg-gray-200 hover:(bg-gray-100 text-red-300)`
- 🧑🤝🧑 Plays nicely with Nuxt v3, Nuxt v2, [@nuxt/vite](https://github.com/nuxt/vite) and [@nuxt/content](https://content.nuxtjs.org/)
- 🔎 Integrated with [windicss-analysis](https://github.com/windicss/windicss-analysis)
## Getting Started
### Try it Online
- [Nuxt v3 + WindiCSS](https://stackblitz.com/edit/nuxt-3-windicss?file=app.vue)
- [Nuxt v2 + WindiCSS](https://stackblitz.com/edit/nuxt-v2-windicss?file=components/Tutorial.vue)
- [Nuxt bridge + WindiCSS](https://stackblitz.com/edit/nuxt-bridge-windicss?file=README.md)
### Install
```bash
yarn add nuxt-windicss -D
# npm i nuxt-windicss -D
```
## Usage
Within your `nuxt.config.js` add the following.
```js
// nuxt.config.js
export default {
buildModules: [
'nuxt-windicss',
],
}
```
### Nuxt 3
```js
import { defineNuxtConfig } from 'nuxt3'
export default defineNuxtConfig({
modules: [
'nuxt-windicss',
],
})
```
### Typescript
For Nuxt config typescript support, add the module within your `tsconfig.json`.
```json
{
"compilerOptions": {
"types": [
"nuxt-windicss"
]
}
}
```
### Windi Design In DevTools
Add the import with your existing windi imports and you'll have autocompletion in your Chrome DevTools! See ["Design in DevTools"](https://windicss.org/integrations/vite.html#design-in-devtools) for more information.
```ts
export default {
// ...
css: [
'virtual:windi.css',
'virtual:windi-devtools',
],
}
```
### Windi Analyzer
> An analyser tool for [Windi CSS](https://github.com/windicss/windicss). Browse your utilities usages, have an overview of your design system, identify "bad practices", and more!
You can enable Windi Analzyer using the Nuxt config. The analyser is only available in development mode.
```js
export default defineNuxtConfig({
buildModules: [
'nuxt-windicss',
],
windicss: {
analyze: true
}
})
```
Alternatively, you can provide an object to control the analysis or the server.
```js
windicss: {
analyze: {
analysis: {
interpretUtilities: false,
},
// see https://github.com/unjs/listhen#options
server: {
port: 4444,
open: true,
}
}
}
```
### Migrating from tailwind
This module won't work with `@nuxtjs/tailwindcss`, you will need to remove it.
```diff
buildModules: [
- '@nuxtjs/tailwindcss',
],
```
If you have a `tailwind.config.js`, please rename it to `windi.config.js` or `windi.config.ts`.
Follow the [migration guide](https://windicss.org/guide/migration.html) for other change details.
### Ordering (optional)
By default, this all windi layers will be automatically imported for you.
If you'd like to change the layout ordering you can include the layers in any order you like.
For example, if you had a `main.css` which had `h1 { margin-bottom: 30px; }`, you might do something like this:
```js
// nuxt.config.js
export default {
// ...
css: [
// windi preflight
'virtual:windi-base.css',
// your stylesheets which overrides the preflight
'@/css/main.css',
// windi extras
'virtual:windi-components.css',
'virtual:windi-utilities.css',
],
}
```
## Documentation
Read the [documentation](https://windicss.org/integrations/nuxt.html) for more details.
## Credits
- Windy team
- [@antfu](https://github.com/antfu) Based on his Rollup / Vite implementation & his util package
## Sponsors
## License
MIT License © 2021 [Harlan Wilton](https://github.com/harlan-zw)