Ir para o conteúdo principal

Vue – @govbr-ds/components-vue

npm (next)

Este wrapper Vue encapsula os Web Components do GovBR-DS v4, permitindo que sejam utilizados como componentes nativos no Vue.

Por que usar este wrapper? 🤔​

  • Verificação de tipos.
  • Integração com Vue Router.
  • Suporte a v-model para componentes de formulário.

Mais detalhes na documentação do Stencil.

Instalação 📦​

npm install @govbr-ds/core @govbr-ds/components @govbr-ds/components-vue
# ou
pnpm add @govbr-ds/core @govbr-ds/components @govbr-ds/components-vue
# ou
yarn add @govbr-ds/core @govbr-ds/components @govbr-ds/components-vue

Nota importante: pnpm e tree-shaking​

Se ao consumir estes pacotes você notar que o bundler não está removendo código não utilizado (tree‑shaking), pode haver uma incompatibilidade com o layout padrão do pnpm.

Solução rápida (opcional, somente se precisar): crie um arquivo .npmrc na raiz do seu projeto com:

node-linker=hoisted

Por que isso ajuda: por padrão, o pnpm organiza as dependências em pastas isoladas com symlinks. Alguns bundlers/otimizadores se baseiam na estrutura de node_modules e no campo sideEffects para decidir o que pode ser eliminado. O layout hoisted aproxima o formato “achatado” (similar ao npm/yarn), facilitando essa análise e, em muitos casos, restaurando o tree‑shaking.

Observações:

  • Use apenas se o tree‑shaking realmente não estiver funcionando.
  • Pode aumentar o uso de disco e alterar a resolução de dependências do seu projeto.

Uso 📚​

Desenvolvimento 👨‍💻​

Estrutura do projeto​

├── 📁 src
│   ├── 📁 stencil-generated
│   └── 📄 index.ts

[!WARNING] Tudo dentro de stencil-generated é sobrescrito ao gerar o build de Web Components.

Scripts/Build​

nx build components
nx build vue

Gerenciar baseline de tamanho:

# Da raiz do monorepo:
pnpm run baseline:update:vue    # Atualizar baseline
pnpm run baseline:compare:vue   # Comparar com baseline atual

Documentações Complementares 📖​

Contribuindo 🤝​

Reportar Bugs/Problemas 🐛​

Abra uma issue: gitlab.com/.../issues/new

Commits 📝​

Padrões de branches e commits: gov.br/ds/wiki

Precisa de ajuda? 🆘​

Créditos 🎉​

Desenvolvido pelo SERPRO com a comunidade.