@govbr-ds/webcomponents-rafael NPM

Web Components GOVBR-DS

Biblioteca baseada no GOVBR-DS e construída usando Web Components para ser independente de frameworks.

Tecnologias

Esse projeto é desenvolvido usando:

Para saber mais detalhes sobre Web Components sugerimos que consulte o MDN.

Dependências

Para conseguir usar nossa biblioteca sem problemas temos as seguintes dependências:

O fontawesome e a fonte rawline podem ser importadas de um CDN. Consulte a documentação no site do GOVBR-DS para mais detalhes.

Instalação

npm install --save @govbr-ds/webcomponents

Uso

Depois de instalada, importe a biblioteca de dentro da pasta node_modules:

@import "node_modules/@govbr-ds/webcomponents/dist/webcomponents.umd.min.js"

Exemplos de uso

Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologias. Consulte o nosso grupo aqui no gitlab e procure pelos projetos de 'Quickstart' para mais detalhes.

Rodando localmente

Clone o projeto:

git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git

Entre no diretório do projeto:

cd govbr-ds-wbc

Instale as dependências:

npm install

Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:

Executar como VueJS Components

Nessa visualização você executa o projeto em uma página auxiliar (fora do storybook) e sem compilar o resultado para Web Components.

npm run serve

Executar como Web Components

Nessa visualização o projeto é executado a partir do storybook e convertido para Web Components.

Aqui você consegue testar as configurações, obter snippets de código e visualizar os componentes rodando como nos ambientes de produção.

npm run storybook

Essa compilação pode demorar para refletir as alterações na página. Assim, recomendamos que utilizem primeiro a execução como VueJS durante o desenvolvimento e quando considerarem as alterações maduras o suficiente façam os testes como Web Components.

Documentação

Nossa documentação está disponível em https://gov.br/ds/webcomponents/.

Contribuindo

Antes de abrir um Merge Request tenha em mente algumas informações:

Esse é um projeto opensource e contribuições são bem-vindas.
Para facilitar a aprovação da sua contribuição, escolha um título curto, simples e explicativo para o MR, e siga os padrões da nossa wiki.
Quer contribuir com o projeto? Confira o nosso guia como contribuir.

Reportar bugs/necessidades

Você pode usar as issues para nos informar os problemas que tem enfrentado ao usar nossa biblioteca ou mesmo o que gostaria que fizesse parte do projeto. Por favor use o modelo que mais se encaixa na sua necessidade e preencha com o máximo de detalhes possível.

Nos comprometemos a responder a todas as issues.