@govbr-ds/webcomponents 1.6.0 → 1.6.2

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 +22 -18
  2. package/dist/webcomponents.common.js +1389 -1031
  3. package/dist/webcomponents.common.js.map +1 -1
  4. package/dist/webcomponents.umd.js +1394 -1036
  5. package/dist/webcomponents.umd.js.map +1 -1
  6. package/dist/webcomponents.umd.min.js +2 -2
  7. package/dist/webcomponents.umd.min.js.map +1 -1
  8. package/package.json +6 -9
package/README.md CHANGED
@@ -1,6 +1,13 @@
1
1
  # Web Components GovBR-DS
2
2
 
3
- Biblioteca baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') e construída usando Web Components para ser independente de frameworks.
3
+ Nosso objetivo é disponibilizar uma biblioteca de componentes baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') que possa ser consumida independente de frameworks ou tecnologias utilizadas nos projetos.
4
+
5
+ ## Demonstração
6
+
7
+ Acesse nossos sites e veja nossos componentes em ação:
8
+
9
+ - [Storybook - Produção](https://gov.br/ds/webcomponents/)
10
+ - [Storybook - Desenvolvimento](https://govbr-ds.gitlab.io/wbc/govbr-ds-wbc/)
4
11
 
5
12
  ## Tecnologias
6
13
 
@@ -15,6 +22,10 @@ Esse projeto é desenvolvido usando:
15
22
 
16
23
  > 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').
17
24
 
25
+ ## Documentações Complementares
26
+
27
+ Consulte nossa a seção sobre Web Componente na nossa [Wiki](https://govbr-ds.gitlab.io/tools/wiki/hugo-cms/desenvolvimento/web-components) para obter mais informações.
28
+
18
29
  ## Uso
19
30
 
20
31
  Existem 2 maneiras de usar nossos Web Components:
@@ -57,32 +68,23 @@ Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologi
57
68
 
58
69
  ```markdown
59
70
  /raiz
60
- └───public
61
- │ └───index.html
62
71
  └───src
63
- │ │───App.vue
64
- │ │───main.js
65
- │ │
66
- │ │───library
67
- │ │ │───lib.js
68
- │ │ │───components
69
- │ │ │───mixins
70
- │ │ └───util
71
- │ │───pages
72
- │ │───router
73
- │ └───stories
72
+ │───assets
73
+ │───library
74
+ │ │───lib.js
75
+ │ │───components
76
+ │ │───mixins
77
+ │ └───util
78
+ └───stories
74
79
  ```
75
80
 
76
- - **public/index.html**: página inicial da aplicação Vue que faz uso dos componentes da biblioteca.
77
81
  - **src**
78
- - **App.vue** e **main.js**: arquivos da aplicação Vue.
82
+ - **assets**: pasta com arquivos estáticos
79
83
  - **library**
80
84
  - **lib.js**: inicializa todos os custom elements e define o que faz parte da biblioteca. É usado para fazer o build final.
81
85
  - **components**: pasta com os componentes da biblioteca, seus testes e stories do storybook.
82
86
  - **mixins**: mixins que são usados em vários componentes.
83
87
  - **util**: funções criadas para facilitar ações dentro dos componentes
84
- - **pages**: páginas da aplicação Vue. São os exemplos que usamos para testar
85
- - **router**: arquivo com as rotas apontando para as páginas (pages) da aplicação Vue
86
88
  - **stories**: Arquivos com as stories gerais do storybook
87
89
 
88
90
  > Aplicação Vue é uma aplicação criada para testar rapidamente nossos componentes. Ela não é disponibilizada no build e nem disponibilizamos um site com ela.
@@ -133,6 +135,8 @@ Essa compilação pode demorar para refletir as alterações na página. Assim,
133
135
 
134
136
  Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
135
137
 
138
+ > Para outras informações, consulte nossa [Wiki](https://govbr-ds.gitlab.io/tools/wiki/hugo-cms/desenvolvimento/web-components/).
139
+
136
140
  ## Contribuindo
137
141
 
138
142
  Antes de abrir um Merge Request tenha em mente algumas informações: