Skip to content

Commit

Permalink
Remove Headless UI and add UI framework recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
marcaureln committed May 25, 2024
1 parent b71e450 commit 89bb73c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 14 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introdu

- 👓 [Sass](https://sass-lang.com/)
- 🪁 [Tailwind CSS](https://tailwindcss.com)
-[Headless UI components](https://headlessui.dev)
- 🇬 [Google Fonts](https://google-fonts.nuxtjs.org/)
- 🚀 [Nuxt Icon](https://nuxt.com/modules/icon) (add any icons from [icones.js.org](https://icones.js.org/) collection)
- 🔍 [Nuxt SEO](https://nuxtseo.com/) (robots.txt, sitemap, link checker, etc.)
Expand All @@ -31,6 +30,16 @@ npx nuxi init -t gh:inputstudio/nuxt3-starter <project-name>

After that, make sure to go through the TODOs (search for `TODO` in your code editor) to customize the project to your needs. Enjoy ✨

## Which UI framework should I use?

This starter template uses Tailwind CSS by default. You can add any UI framework you want on top of it. Here are some that we use and recommend (they are all fully compatible with Tailwind):

- [Headless UI](https://nuxt.com/modules/headlessui)
- [Daisy UI](https://daisyui.com/docs/install/)
- [NuxtUI](https://ui.nuxt.com/)

Feel free to use any other UI framework you like 🙂.

## Production

To build the application for production, run the following command:
Expand Down
13 changes: 1 addition & 12 deletions nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,7 @@ export default defineNuxtConfig({
'/_nuxt/**': { headers: { 'cache-control': `public,max-age=${cacheTTL},s-maxage=${cacheTTL}` } },
},
},
modules: [
'@nuxtjs/google-fonts',
'@nuxtjs/seo',
'nuxt-headlessui',
'nuxt-icon',
'@nuxtjs/tailwindcss',
'@nuxt/eslint',
],
headlessui: {
// https://nuxt.com/modules/headlessui
prefix: 'Headless',
},
modules: ['@nuxtjs/google-fonts', '@nuxtjs/seo', 'nuxt-icon', '@nuxtjs/tailwindcss', '@nuxt/eslint'],
googleFonts: {
// https://google-fonts.nuxtjs.org/getting-started/options
families: {
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"@nuxtjs/tailwindcss": "^6.11.4",
"eslint": "^8.57.0",
"nuxt": "^3.11.2",
"nuxt-headlessui": "^1.1.5",
"nuxt-icon": "^0.6.10",
"prettier": "^3.2.5",
"prettier-plugin-tailwindcss": "^0.5.11",
Expand Down

0 comments on commit 89bb73c

Please sign in to comment.