@esperanca-ui/componentes 2.1.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 +120 -0
- package/dist/componentes-esperanca.es.js +20794 -0
- package/dist/componentes-esperanca.es.js.map +1 -0
- package/dist/componentes-esperanca.umd.js +100 -0
- package/dist/componentes-esperanca.umd.js.map +1 -0
- package/dist/components/Background/Background.d.ts +14 -0
- package/dist/components/Background/index.d.ts +2 -0
- package/dist/components/Button/Button.d.ts +37 -0
- package/dist/components/Card/Card.d.ts +22 -0
- package/dist/components/Checkbox/Checkbox.d.ts +16 -0
- package/dist/components/ComboBox/ComboBox.d.ts +26 -0
- package/dist/components/ConfirmDialog/ConfirmDialog.d.ts +11 -0
- package/dist/components/FormSidebar/FormSidebar.d.ts +23 -0
- package/dist/components/Grid/Grid.d.ts +13 -0
- package/dist/components/Grid/index.d.ts +1 -0
- package/dist/components/Input/Input.d.ts +15 -0
- package/dist/components/Loading/Loading.d.ts +8 -0
- package/dist/components/MetricCard/MetricCard.d.ts +11 -0
- package/dist/components/Modal/Modal.d.ts +12 -0
- package/dist/components/PageHeader/PageHeader.d.ts +12 -0
- package/dist/components/Portal/Portal.d.ts +7 -0
- package/dist/components/Radio/Radio.d.ts +36 -0
- package/dist/components/Sidebar/Sidebar.d.ts +81 -0
- package/dist/components/Table/DataTable.d.ts +36 -0
- package/dist/components/Textarea/Textarea.d.ts +15 -0
- package/dist/components/ThemeProvider/ThemeProvider.d.ts +16 -0
- package/dist/components/ThemeProvider/index.d.ts +1 -0
- package/dist/components/Toast/Toast.d.ts +18 -0
- package/dist/components/Tooltip/Tooltip.d.ts +9 -0
- package/dist/hooks/useAnnouncements.d.ts +4 -0
- package/dist/hooks/useClickOutside.d.ts +3 -0
- package/dist/hooks/useFocusTrap.d.ts +1 -0
- package/dist/hooks/useKeyboardNavigation.d.ts +4 -0
- package/dist/hooks/useMediaQuery.d.ts +10 -0
- package/dist/hooks/useTheme.d.ts +1 -0
- package/dist/index.d.ts +46 -0
- package/dist/style.css +1 -0
- package/dist/utils/aria.d.ts +16 -0
- package/dist/utils/responsive.d.ts +9 -0
- package/dist/utils/styles.d.ts +4 -0
- package/package.json +51 -0
package/README.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# @esperanca-ui/componentes
|
|
2
|
+
|
|
3
|
+
Biblioteca de componentes React (DataTable, Sidebar, FormSidebar, Input, ComboBox, Checkbox, Radio, RadioGroup, Textarea e Button) com estilos em CSS puro, build com Vite e documentação via Storybook.
|
|
4
|
+
|
|
5
|
+
## TL;DR
|
|
6
|
+
- Instalar dependencias: `npm install`
|
|
7
|
+
- Rodar Storybook: `npm run storybook`
|
|
8
|
+
- Build da biblioteca: `npm run build`
|
|
9
|
+
- Docker (docs + CDN): `docker compose up --build`
|
|
10
|
+
|
|
11
|
+
## Arquitetura (alto nivel)
|
|
12
|
+
- Componentes React em `src/components/`
|
|
13
|
+
- Estilos globais em `src/index.css` (tema claro/escuro via variaveis CSS)
|
|
14
|
+
- Build com `tsc` + `vite` e geracao de tipos via `vite-plugin-dts`
|
|
15
|
+
- Documentacao visual via Storybook em `.storybook/`
|
|
16
|
+
- Publicacao no GitLab Package Registry via pipeline de tag
|
|
17
|
+
|
|
18
|
+
## Estrutura de pastas
|
|
19
|
+
```
|
|
20
|
+
.
|
|
21
|
+
├── .cz.toml
|
|
22
|
+
├── .env.example
|
|
23
|
+
├── .gitlab-ci.yml
|
|
24
|
+
├── .npmrc
|
|
25
|
+
├── .storybook
|
|
26
|
+
│ ├── main.ts
|
|
27
|
+
│ ├── preview.css
|
|
28
|
+
│ └── preview.tsx
|
|
29
|
+
├── CHANGELOG.md
|
|
30
|
+
├── README.md
|
|
31
|
+
├── docker
|
|
32
|
+
│ └── Dockerfile
|
|
33
|
+
├── docker-compose.yml
|
|
34
|
+
├── docs
|
|
35
|
+
│ ├── components.md
|
|
36
|
+
│ ├── functions.md
|
|
37
|
+
│ ├── tutorial-instalacao-pacote-npm-gitlab.md
|
|
38
|
+
│ └── wiki-componentes-react.md
|
|
39
|
+
├── src
|
|
40
|
+
│ ├── components
|
|
41
|
+
│ │ ├── Button
|
|
42
|
+
│ │ │ ├── Button.stories.tsx
|
|
43
|
+
│ │ │ └── Button.tsx
|
|
44
|
+
│ │ ├── Checkbox
|
|
45
|
+
│ │ │ ├── Checkbox.stories.tsx
|
|
46
|
+
│ │ │ └── Checkbox.tsx
|
|
47
|
+
│ │ ├── ComboBox
|
|
48
|
+
│ │ │ ├── ComboBox.stories.tsx
|
|
49
|
+
│ │ │ └── ComboBox.tsx
|
|
50
|
+
│ │ ├── FormSidebar
|
|
51
|
+
│ │ │ ├── FormSidebar.stories.tsx
|
|
52
|
+
│ │ │ └── FormSidebar.tsx
|
|
53
|
+
│ │ ├── Input
|
|
54
|
+
│ │ │ ├── Input.stories.tsx
|
|
55
|
+
│ │ │ └── Input.tsx
|
|
56
|
+
│ │ ├── Radio
|
|
57
|
+
│ │ │ ├── Radio.stories.tsx
|
|
58
|
+
│ │ │ └── Radio.tsx
|
|
59
|
+
│ │ ├── Textarea
|
|
60
|
+
│ │ │ ├── Textarea.stories.tsx
|
|
61
|
+
│ │ │ └── Textarea.tsx
|
|
62
|
+
│ │ ├── Sidebar
|
|
63
|
+
│ │ │ ├── Sidebar.stories.tsx
|
|
64
|
+
│ │ │ └── Sidebar.tsx
|
|
65
|
+
│ │ └── Table
|
|
66
|
+
│ │ ├── DataTable.stories.tsx
|
|
67
|
+
│ │ └── DataTable.tsx
|
|
68
|
+
│ ├── hooks
|
|
69
|
+
│ │ └── useClickOutside.ts
|
|
70
|
+
│ ├── index.css
|
|
71
|
+
│ └── index.ts
|
|
72
|
+
├── tsconfig.json
|
|
73
|
+
├── tsconfig.node.json
|
|
74
|
+
└── vite.config.ts
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Configuracao (.env)
|
|
78
|
+
Arquivo de exemplo: `.env.example`.
|
|
79
|
+
|
|
80
|
+
Nao encontrado no repositorio
|
|
81
|
+
TODO: completar
|
|
82
|
+
|
|
83
|
+
## Como rodar
|
|
84
|
+
### Desenvolvimento
|
|
85
|
+
```bash
|
|
86
|
+
npm install
|
|
87
|
+
npm run storybook
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Acesse o Storybook local em `http://localhost:6006`.
|
|
91
|
+
|
|
92
|
+
### Build da biblioteca
|
|
93
|
+
```bash
|
|
94
|
+
npm run build
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Docker (Storybook estatico + CDN)
|
|
98
|
+
```bash
|
|
99
|
+
docker compose up --build
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Acesse a versao estatica em `http://localhost:3007`.
|
|
103
|
+
|
|
104
|
+
## Uso rapido
|
|
105
|
+
```tsx
|
|
106
|
+
import { DataTable, Sidebar, FormSidebar, Input, ComboBox, Checkbox, Radio, RadioGroup, Textarea, Button } from '@esperanca-ui/componentes';
|
|
107
|
+
import '@esperanca-ui/componentes/style.css';
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Verificacao rapida
|
|
111
|
+
```bash
|
|
112
|
+
npm run build
|
|
113
|
+
npm run build-storybook
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Documentacao
|
|
117
|
+
- Wiki tecnica: `docs/wiki-componentes-react.md`
|
|
118
|
+
- Funcoes/exports: `docs/functions.md`
|
|
119
|
+
- Componentes: `docs/components.md`
|
|
120
|
+
- Tutorial de instalacao em outro projeto: `docs/tutorial-instalacao-pacote-npm-gitlab.md`
|