@govbr-ds/webcomponents 1.3.1 → 1.4.0-rc.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.
- package/README.md +10 -6
- package/dist/webcomponents.common.js +315 -242
- package/dist/webcomponents.common.js.map +1 -0
- package/dist/webcomponents.umd.js +315 -242
- package/dist/webcomponents.umd.js.map +1 -0
- package/dist/webcomponents.umd.min.js +1 -1
- package/dist/webcomponents.umd.min.js.map +1 -0
- package/package.json +36 -43
package/README.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
# GOVBR-DS
|
|
1
|
+
# Web Components GOVBR-DS
|
|
2
2
|
|
|
3
3
|
Biblioteca de Web Components baseado no [GOVBR-DS](https://gov.br/ds 'GOVBR-DS').
|
|
4
4
|
|
|
5
5
|
## Objetivo
|
|
6
6
|
|
|
7
|
-
Construir uma biblioteca de componentes que faça uso das tecnologias de Web Components e que seja reutilizável
|
|
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.
|
|
8
8
|
|
|
9
9
|
## Tecnologias
|
|
10
10
|
|
|
11
11
|
Esse projeto é desenvolvido usando:
|
|
12
12
|
|
|
13
13
|
1. [VueJS 3](https://v3.vuejs.org/ 'VueJS 3')
|
|
14
|
-
1. [
|
|
14
|
+
1. [Storybook](https://storybook.js.org/ 'Storybook')
|
|
15
15
|
1. [Jest](https://jestjs.io/ 'Jest')
|
|
16
16
|
|
|
17
17
|
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').
|
|
@@ -46,7 +46,7 @@ npm install --save @govbr-ds/webcomponents
|
|
|
46
46
|
|
|
47
47
|
### Uso
|
|
48
48
|
|
|
49
|
-
Depois de instalada, importe a biblioteca de dentro da parta node_modules
|
|
49
|
+
Depois de instalada, importe a biblioteca de dentro da parta node_modules:
|
|
50
50
|
|
|
51
51
|
```javascript
|
|
52
52
|
@import "node_modules/@govbr-ds/webcomponents/dist/webcomponents.umd.min.js"
|
|
@@ -84,7 +84,7 @@ npm run storybook
|
|
|
84
84
|
|
|
85
85
|
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
86
|
|
|
87
|
-
## Compilar biblioteca
|
|
87
|
+
## Compilar a biblioteca
|
|
88
88
|
|
|
89
89
|
Gera o build da biblioteca dentro da pasta **dist**.
|
|
90
90
|
|
|
@@ -110,7 +110,11 @@ npm run lint
|
|
|
110
110
|
|
|
111
111
|
## Como contribuir?
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
Antes de abrir um Merge Request tenha em mente algumas informações:
|
|
114
|
+
|
|
115
|
+
- Esse é um projeto opensource e contribuições são bem-vindas.
|
|
116
|
+
- 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
|
+
- Quer contribuir com o projeto? Confira o nosso guia [como contribuir](./CONTRIBUTING.md 'Como contribuir?').
|
|
114
118
|
|
|
115
119
|
## Reportar bugs/necessidades
|
|
116
120
|
|