@govbr-ds/webcomponents 1.4.0-rc.1 → 1.4.1-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +38 -54
  2. package/dist/webcomponents.common.js +10865 -11040
  3. package/dist/webcomponents.common.js.map +1 -1
  4. package/dist/webcomponents.umd.js +10865 -11040
  5. package/dist/webcomponents.umd.js.map +1 -1
  6. package/dist/webcomponents.umd.min.js +1 -1
  7. package/dist/webcomponents.umd.min.js.map +1 -1
  8. package/package.json +12 -15
package/README.md CHANGED
@@ -1,10 +1,6 @@
1
1
  # Web Components GOVBR-DS
2
2
 
3
- Biblioteca de Web Components baseado no [GOVBR-DS](https://gov.br/ds 'GOVBR-DS').
4
-
5
- ## Objetivo
6
-
7
- Construir uma biblioteca de componentes que faça uso das tecnologias de Web Components e que seja reutilizável junto com vários frameworks, bibliotecas e browsers.
3
+ Biblioteca baseada no [GOVBR-DS](https://gov.br/ds 'GOVBR-DS') e construída usando Web Components para ser independente de frameworks.
8
4
 
9
5
  ## Tecnologias
10
6
 
@@ -16,7 +12,7 @@ Esse projeto é desenvolvido usando:
16
12
 
17
13
  Para saber mais detalhes sobre Web Components sugerimos que consulte o [MDN](https://developer.mozilla.org/pt-BR/docs/Web/Web_Components 'Web Components | MDN').
18
14
 
19
- ### Dependências
15
+ ## Dependências
20
16
 
21
17
  Para conseguir usar nossa biblioteca sem problemas temos as seguintes dependências:
22
18
 
@@ -28,23 +24,11 @@ Para conseguir usar nossa biblioteca sem problemas temos as seguintes dependênc
28
24
 
29
25
  > O fontawesome e a fonte rawline podem ser importadas de um CDN. Consulte a documentação no site do [GOVBR-DS](https://www.gov.br/ds/ 'GOVBR-DS') para mais detalhes.
30
26
 
31
- ## Como usar nossa biblioteca em seu projeto?
32
-
33
- ### Uso de polyfill
34
-
35
- Caso os requisitos to seu projeto incluam navegadores que não suportam completamente os Web Components, adicione os [polyfills](https://www.webcomponents.org/polyfills) ao seu projeto.
36
-
37
- Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
38
-
39
- ### Instalação da biblioteca
40
-
41
- Você pode instalar a nossa biblioteca de Web Components no seu projeto usando:
27
+ ## Instalação
42
28
 
43
- ```node
29
+ ```bash
44
30
  npm install --save @govbr-ds/webcomponents
45
- ```
46
-
47
- ### Uso
31
+ ```## Uso
48
32
 
49
33
  Depois de instalada, importe a biblioteca de dentro da parta node_modules:
50
34
 
@@ -52,19 +36,33 @@ Depois de instalada, importe a biblioteca de dentro da parta node_modules:
52
36
  @import "node_modules/@govbr-ds/webcomponents/dist/webcomponents.umd.min.js"
53
37
  ```
54
38
 
55
- ## Exemplos de uso
39
+ ### Exemplos de uso
56
40
 
57
- Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologias. Consulte o [nosso grupo aqui no giltab](https://gitlab.com/govbr-ds/dev/wbc 'GOVBR-DS/DEV/WBC') e procure pelos projetos de 'Quickstart' para mais detalhes.
41
+ Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologias. Consulte o [nosso grupo aqui no gitlab](https://gitlab.com/govbr-ds/dev/wbc 'GOVBR-DS/DEV/WBC') e procure pelos projetos de 'Quickstart' para mais detalhes.
58
42
 
59
- ## Documentação
43
+ ## Rodando localmente
60
44
 
61
- Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
45
+ Clone o projeto
46
+
47
+ ```bash
48
+ git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git
49
+ ```
62
50
 
63
- ## Como executar o projeto?
51
+ Entre no diretório do projeto
52
+
53
+ ```bash
54
+ cd govbr-ds-wbc
55
+ ```
56
+
57
+ Instale as dependências
58
+
59
+ ```bash
60
+ npm install
61
+ ```
64
62
 
65
63
  Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:
66
64
 
67
- ###  Executar como VueJS
65
+ ###  Executar como VueJS Components
68
66
 
69
67
  Nessa visualização você executa o projeto em uma página auxiliar (fora do storybook) e sem compilar o resultado para Web Components.
70
68
 
@@ -84,31 +82,11 @@ npm run storybook
84
82
 
85
83
  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.
86
84
 
87
- ##  Compilar a biblioteca
88
-
89
- Gera o build da biblioteca dentro da pasta **dist**.
90
-
91
- ```node
92
- npm run build
93
- ```
94
-
95
- ##  Testes unitários
96
-
97
- Executa os testes unitários e sava os resultados na pasta coverage.
98
-
99
- ```node
100
- npm run test:unit
101
- ```
102
-
103
- ##  Lints
104
-
105
- Nesse projeto usamos diversos tipos de lints para automaticamente verificar o código antes de enviar para review. Para executá-los e obter os resultados execute o comando:
85
+ ## Documentação
106
86
 
107
- ```node
108
- npm run lint
109
- ```
87
+ Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
110
88
 
111
- ## Como contribuir?
89
+ ## Contribuindo
112
90
 
113
91
  Antes de abrir um Merge Request tenha em mente algumas informações:
114
92
 
@@ -116,11 +94,11 @@ Antes de abrir um Merge Request tenha em mente algumas informações:
116
94
  - 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](https://govbr-ds.gitlab.io/govbr-ds-wiki/ 'Wiki').
117
95
  - Quer contribuir com o projeto? Confira o nosso guia [como contribuir](./CONTRIBUTING.md 'Como contribuir?').
118
96
 
119
- ## Reportar bugs/necessidades
97
+ ### Reportar bugs/necessidades
120
98
 
121
99
  Você pode usar as [issues](https://gitlab.com/govbr-ds/dev/wbc/govbr-ds-wbc/-/issues/new) 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.
122
100
 
123
- Nos comprometemos a responder a todas as issues
101
+ Nos comprometemos a responder a todas as issues.
124
102
 
125
103
  ## Precisa de ajuda?
126
104
 
@@ -136,11 +114,17 @@ Use nossos canais abaixo para obter tirar suas dúvidas:
136
114
 
137
115
  - Usando nosso canal no discord <https://discord.gg/U5GwPfqhUP>
138
116
 
139
- ### Commits
117
+ ## Commits
140
118
 
141
119
  Nesse projeto usamos um padrão para branches e commits. Por favor observe a documentação na nossa [wiki](https://govbr-ds.gitlab.io/govbr-ds-wiki/ 'Wiki') para aprender sobre os nossos padrões.
142
120
 
143
- ## Créditos
121
+ ## Apêndice
122
+
123
+ ### Polyfill
124
+
125
+ Caso os requisitos to seu projeto incluam navegadores que não suportam completamente os Web Components, adicione os [polyfills](https://www.webcomponents.org/polyfills) ao seu projeto.
126
+
127
+ Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')## Créditos
144
128
 
145
129
  Os Web Components do [GOVBR-DS](https://gov.br/ds/ 'GOVBR-DS') são criados pelo [SERPRO](https://www.serpro.gov.br/ 'SERPRO | Serviço Federal de Processamento de Dados') e [Dataprev](https://www.dataprev.gov.br/ 'Dataprev | Empresa de Tecnologia e Informações da Previdência') juntamente com a participação da comunidade.
146
130