Sobre o projeto
Nuxt UI é uma biblioteca de UI para Vue e Nuxt que combina Reka UI, Tailwind CSS e Tailwind Variants. Seu objetivo declarado é fornecer aos desenvolvedores ferramentas para a construção de interfaces de usuário sofisticadas, acessíveis e de alta performance.
Status do repositório: este README reside no branch v4; branches separados v3 e v2 são mantidos para versões principais anteriores. A documentação pública está hospedada em ui.nuxt.com.
Instalação
- O pacote é instalado como @nuxt/ui juntamente com tailwindcss, com comandos exibidos para pnpm, yarn, npm e bun.
- Para Nuxt: registre '@nuxt/ui' no array de modules do nuxt.config.ts e aponte o css para uma folha de estilo como ~/assets/css/main.css.
- Para Vue puro: adicione o plugin Vite do Nuxt UI (@nuxt/ui/vite) ao vite.config.ts junto com @vitejs/plugin-vue, então registre o plugin Vue (@nuxt/ui/vue-plugin) no arquivo de entrada do app; um roteador é criado com vue-router no exemplo mostrado.
- Em ambas as configurações, a entrada de CSS importa "tailwindcss" seguido por "@nuxt/ui".
- Guias de instalação dedicados existem para Nuxt e Vue.
Templates
Um conjunto de templates prontos para uso é listado, com um link para uma página oficial de templates: Starter (ponto de partida mínimo), Landing (página de destino alimentada por Nuxt Content), Docs (site de documentação alimentado por Nuxt Content), SaaS (landing, preços, docs e blog alimentados por Nuxt Content), Dashboard (layout de múltiplas colunas), Chat (chatbot de IA com autenticação GitHub e histórico de chat persistente alimentado por Vercel AI SDK), Portfolio (portfólio e blog alimentados por Nuxt Content), Changelog (exibe notas de lançamento do repositório do GitHub alimentadas por Nuxt MDC), Editor (editor de texto rico alimentado por TipTap suportando tipos de conteúdo markdown, HTML e JSON), e Calendar (visualizações de dia, semana e mês com arrastar e soltar e atualizações otimistas).
Contribuição e desenvolvimento
Os contribuidores são convidados a reportar bugs e enviar sugestões através dos guias de reporte e contribuição do projeto. Um arquivo AGENTS.md fornece diretrizes de contribuição voltadas para assistentes de codificação de IA, cobrindo estrutura de componentes, padrões de tematização, convenções de teste e diretrizes de documentação; ele é descrito como sendo capturado automaticamente por agentes de codificação de IA. Instruções para configurar um ambiente de desenvolvimento local estão vinculadas na documentação de contribuição.
Créditos são dados a nuxt/nuxt, nuxt/icon, nuxt/fonts, nuxt-modules/color-mode, unovue/reka-ui, tailwindlabs/tailwindcss e vueuse/vueuse. O projeto é licenciado sob a licença MIT.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.