@codarmais/ui 0.1.0
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 +138 -0
- package/dist/App.d.ts +2 -0
- package/dist/codar-mais-ui-lib.es.js +1417 -0
- package/dist/codar-mais-ui-lib.umd.js +101 -0
- package/dist/codar_mais.png +0 -0
- package/dist/components/HeaderLogo/HeaderLogo.d.ts +12 -0
- package/dist/components/HeaderLogo/HeaderLogo.stories.d.ts +10 -0
- package/dist/components/HeaderLogo/HeaderLogo.styles.d.ts +8 -0
- package/dist/components/HeaderLogo/index.d.ts +2 -0
- package/dist/components/index.d.ts +2 -0
- package/dist/index.d.ts +1 -0
- package/package.json +73 -0
package/README.md
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
|
|
2
|
+
# Codar Mais UI
|
|
3
|
+
|
|
4
|
+
Biblioteca de componentes React utilizada nos sistemas da **<CodarMais />**, desenvolvida com **React + Vite + Styled Components** e documentada com **Storybook**.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 🚀 Tecnologias
|
|
9
|
+
|
|
10
|
+
- React
|
|
11
|
+
- Vite
|
|
12
|
+
- TypeScript
|
|
13
|
+
- Styled-components
|
|
14
|
+
- Storybook
|
|
15
|
+
- Vitest
|
|
16
|
+
- Playwright
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 📦 Repositório
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 📥 Instalação das dependências
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm install
|
|
32
|
+
# ou
|
|
33
|
+
yarn install
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## ▶️ Executar o projeto (dev)
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm run dev
|
|
42
|
+
# ou
|
|
43
|
+
yarn dev
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 📚 Storybook
|
|
49
|
+
|
|
50
|
+
### Executar Storybook
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npm run storybook
|
|
54
|
+
# ou
|
|
55
|
+
yarn storybook
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Acesse:
|
|
59
|
+
http://localhost:6006
|
|
60
|
+
|
|
61
|
+
### Build do Storybook
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npm run build-storybook
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 🏗️ Build da biblioteca
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npm run build
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Saída em `/dist`
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 📦 Instalação da lib
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
npm install @codarmais/ui
|
|
83
|
+
# ou
|
|
84
|
+
yarn add @codarmais/ui
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## ♿ Acessibilidade
|
|
94
|
+
|
|
95
|
+
- Suporte a teclado
|
|
96
|
+
- aria-label
|
|
97
|
+
- foco navegável
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## 📁 Estrutura
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
src/
|
|
105
|
+
├─ components/
|
|
106
|
+
│ ├─ HeaderLogo/
|
|
107
|
+
│ └─ index.ts
|
|
108
|
+
└─ index.ts
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 📌 Versionamento
|
|
114
|
+
|
|
115
|
+
Semantic Versioning (SemVer)
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## 📤 Publicação
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
npm run build
|
|
123
|
+
npm login
|
|
124
|
+
npm publish --access public
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## 🧑💻 Autor
|
|
130
|
+
|
|
131
|
+
Richard Santos
|
|
132
|
+
Codar Mais
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## 📄 Licença
|
|
137
|
+
|
|
138
|
+
MIT
|
package/dist/App.d.ts
ADDED