Guia · Começando

Instalação

Instale o pacote, importe a folha de estilos uma única vez e use os componentes, registrando-os globalmente ou importando só o que precisa.

1. Instale o pacote

Requer Vue ^3.3. O pacote é publicado como ESM e CJS.

Terminal
npm install vueui-nova-kit
# ou
pnpm add vueui-nova-kit
yarn add vueui-nova-kit

2. Importe os estilos e tokens

O arquivo vueui-nova-kit/style.css contém os estilos de todos os componentes e os tokens de design (--v-color-*, --v-radius-*, --v-space-*, --v-font-*, --v-motion-*), já com as variações para [data-theme="dark"]. Importe-o uma vez, antes dos seus próprios estilos, para conseguir sobrescrever tokens com facilidade.

main.ts
// main.ts (ou um plugin do Nuxt)
import 'vueui-nova-kit/style.css'
Só os tokens. Para usar apenas as variáveis, sem os estilos dos componentes, importe vueui-nova-kit/tokens.css. Os helpers de tokens em runtime (setToken, resetTokens, listTokens) vêm da entrada principal e de vueui-nova-kit/tokens; veja Customização de estilo.

3. Registre os componentes

Global

Prático para protótipos e apps que usam muitos componentes: todos ficam disponíveis em qualquer template.

main.ts
import { createApp } from 'vue'
import * as Nova from 'vueui-nova-kit'
import 'vueui-nova-kit/style.css'
import App from './App.vue'

const app = createApp(App)

// registra todos os componentes V* exportados
for (const [name, component] of Object.entries(Nova)) {
  if (/^V[A-Z]/.test(name) && typeof component === 'object') {
    app.component(name, component)
  }
}

app.mount('#app')

Por componente (recomendado)

Importe apenas o que usa. Com bundlers modernos, os componentes não usados ficam de fora do bundle.

Assinatura.vue
<script setup lang="ts">
import { ref } from 'vue'
import { VButton, VSelect } from 'vueui-nova-kit'

const plano = ref('pro')
const opcoes = [
  { value: 'free', label: 'Free' },
  { value: 'pro', label: 'Pro' },
]
</script>

<template>
  <VSelect v-model="plano" :options="opcoes" label="Plano" />
  <VButton variant="primary">Assinar</VButton>
</template>

Nuxt

Adicione o CSS em nuxt.config.ts e, se quiser registro global, um plugin. Os componentes funcionam com SSR; para evitar flash de tema, veja o script anti-flash.

nuxt.config.ts
// nuxt.config.ts
export default defineNuxtConfig({
  css: ['vueui-nova-kit/style.css'],
  build: { transpile: ['vueui-nova-kit'] },
})
plugins/nova.ts
// plugins/nova.ts — registro global (opcional)
import * as Nova from 'vueui-nova-kit'

export default defineNuxtPlugin((nuxtApp) => {
  for (const [name, component] of Object.entries(Nova)) {
    if (/^V[A-Z]/.test(name) && typeof component === 'object') {
      nuxtApp.vueApp.component(name, component)
    }
  }
})

Vite

Nenhuma configuração extra além do plugin padrão do Vue.

src/main.ts
// src/main.ts — projeto Vite + Vue 3
import { createApp } from 'vue'
import 'vueui-nova-kit/style.css'
import App from './App.vue'

createApp(App).mount('#app')
vite.config.ts
// vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [vue()],
})

Próximos passos