@aspprev/versi-ds 0.1.1 → 0.2.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 +117 -395
- package/dist/{chunk-CSQXTG32.js → chunk-ET2BGHTO.js} +2 -1
- package/dist/{chunk-5VJ6H62W.js → chunk-FR5W52XU.js} +278 -18
- package/dist/chunk-FR5W52XU.js.map +1 -0
- package/dist/chunk-H4BBKKRZ.js +380 -0
- package/dist/chunk-H4BBKKRZ.js.map +1 -0
- package/dist/{chunk-L5UMGEXV.js → chunk-PIXRKI25.js} +77 -9
- package/dist/chunk-PIXRKI25.js.map +1 -0
- package/dist/core.d.ts +24 -5
- package/dist/core.js +11 -5
- package/dist/documents.d.ts +81 -1
- package/dist/documents.js +13 -3
- package/dist/forms.d.ts +26 -2
- package/dist/forms.js +4 -2
- package/dist/index.d.ts +3 -3
- package/dist/index.js +26 -8
- package/dist/manifest.json +5 -5
- package/dist/styles.css +1 -1
- package/package.json +19 -17
- package/dist/chunk-5VJ6H62W.js.map +0 -1
- package/dist/chunk-L5UMGEXV.js.map +0 -1
- package/dist/chunk-TESAXMCF.js +0 -45
- package/dist/chunk-TESAXMCF.js.map +0 -1
- /package/dist/{chunk-CSQXTG32.js.map → chunk-ET2BGHTO.js.map} +0 -0
package/README.md
CHANGED
|
@@ -1,461 +1,183 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Versi Design System
|
|
2
2
|
|
|
3
|
-
Biblioteca
|
|
3
|
+
Biblioteca React de componentes, tokens, temas e utilitários para padronizar as interfaces dos produtos ASPPrev.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
O [Storybook](#storybook) é a documentação visual oficial: nele você pode explorar componentes, foundations, temas, padrões de composição e estados acessíveis.
|
|
6
6
|
|
|
7
|
-
##
|
|
8
|
-
|
|
9
|
-
1. Instale o pacote e as dependências das camadas que vai usar.
|
|
10
|
-
2. Importe os estilos uma vez na entrada da aplicação.
|
|
11
|
-
3. Configure fonte, tema e preferências no elemento `html`.
|
|
12
|
-
4. Comece pelos exemplos de componentes e formulários abaixo.
|
|
13
|
-
5. Consulte o Storybook para explorar variantes, estados e propriedades.
|
|
14
|
-
|
|
15
|
-
## Instalação e consumo
|
|
16
|
-
|
|
17
|
-
Depois da publicação:
|
|
7
|
+
## Instalação
|
|
18
8
|
|
|
19
9
|
```bash
|
|
20
10
|
npm install @aspprev/versi-ds react react-dom
|
|
21
11
|
```
|
|
22
12
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
```tsx
|
|
26
|
-
import { Button } from "@aspprev/versi-ds/core";
|
|
27
|
-
import "@aspprev/versi-ds/styles.css";
|
|
28
|
-
import "@aspprev/versi-ds/themes.css"; // paletas opcionais, depois dos estilos
|
|
29
|
-
|
|
30
|
-
export function Example() {
|
|
31
|
-
return <Button>Continuar</Button>;
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
O CSS já está compilado: consumidores não precisam instalar Tailwind nem escanear o pacote. Importe-o uma vez na entrada da aplicação. Ele inclui estilos base/reset do Tailwind; carregue as personalizações da aplicação depois dos estilos do DS.
|
|
36
|
-
|
|
37
|
-
Os componentes básicos não exigem um provider global. Alguns controles precisam de contexto específico, como Formik nos formulários. Se a aplicação já usa React, preserve a versão compatível instalada em vez de adicionar uma segunda cópia.
|
|
38
|
-
|
|
39
|
-
## Entrypoints públicos
|
|
40
|
-
|
|
41
|
-
Todos os sufixos abaixo pertencem a `@aspprev/versi-ds`.
|
|
42
|
-
|
|
43
|
-
| Entrada | Conteúdo | Peers adicionais |
|
|
44
|
-
| ------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
|
45
|
-
| raiz | API completa de compatibilidade | Instale todos os peers opcionais |
|
|
46
|
-
| `/core` | Botões, tipografia, superfícies, avisos, avatares, imagens, tooltips, paginação, tabelas, status, layout e primitivas acessíveis | Nenhum |
|
|
47
|
-
| `/forms` | Input/InputStandalone, InputSelect, TextArea, InputPhone, SelectCountry, SelectMulti, DatePicker, RadioGroup, RadioCardGroup | `formik`, `date-fns`, `react-number-format` |
|
|
48
|
-
| `/charts` | LazyApexChart, TimeSeriesChart, InteractiveDonutChart, TimeRangeSelector e utilitários | `apexcharts`, `react-apexcharts` |
|
|
49
|
-
| `/overlays` | Modal, InputSwitch, AccessibilityPreferencesPanel, HighContrastToggle | `@headlessui/react` |
|
|
50
|
-
| `/documents` | BoletoBarCode e DocumentItem | `jsbarcode` |
|
|
51
|
-
| `/countries` | COUNTRY_OPTIONS, PHONE_COUNTRY_OPTIONS, getCountryOptions, getCountryFlagUrl, filterCountryOptions e tipos | Nenhum |
|
|
52
|
-
| `/styles.css` | Tokens, modos, componentes e utilitários compilados | — |
|
|
53
|
-
| `/themes.css` | Presets de paletas | — |
|
|
13
|
+
Requisitos do pacote:
|
|
54
14
|
|
|
55
|
-
|
|
15
|
+
- Node.js `>=20.19.0`;
|
|
16
|
+
- React `>=18.2.0 <20`;
|
|
17
|
+
- React DOM `>=18.2.0 <20`.
|
|
56
18
|
|
|
57
|
-
|
|
19
|
+
As integrações abaixo são opcionais e só precisam ser instaladas pelas entradas que as utilizam: `@headlessui/react`, `apexcharts`, `date-fns`, `formik`, `jsbarcode`, `react-apexcharts` e `react-number-format`.
|
|
58
20
|
|
|
59
|
-
|
|
21
|
+
## Uso
|
|
60
22
|
|
|
61
|
-
|
|
62
|
-
# Formulários
|
|
63
|
-
npm install formik@^2.4.9 date-fns@^4.1.0 react-number-format@^5.4.4
|
|
64
|
-
|
|
65
|
-
# Gráficos
|
|
66
|
-
npm install apexcharts@5.3.6 react-apexcharts@^1.9.0
|
|
23
|
+
Importe o CSS global uma vez na entrada da aplicação:
|
|
67
24
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
# Código de barras
|
|
72
|
-
npm install jsbarcode@^3.12.3
|
|
25
|
+
```tsx
|
|
26
|
+
import "@aspprev/versi-ds/styles.css";
|
|
27
|
+
import "@aspprev/versi-ds/themes.css";
|
|
73
28
|
```
|
|
74
29
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
`CountrySelect`, `MultiSelect`, `PhoneInput`, `Datepicker` e `CheckBox` permanecem aliases depreciados. Prefira `SelectCountry`, `SelectMulti`, `InputPhone`, `DatePicker` e `Checkbox`. Não use deep imports de componentes em `dist` ou `src`.
|
|
78
|
-
|
|
79
|
-
## Escolhendo os componentes
|
|
80
|
-
|
|
81
|
-
| Necessidade | Componentes |
|
|
82
|
-
| ----------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
83
|
-
| Ações e navegação | Button, Pagination, PageTabsHeader |
|
|
84
|
-
| Texto e hierarquia | Typography, PageHeading, TextGroup, Divider |
|
|
85
|
-
| Estrutura | Surface, ModalCard, FormGrid, FormActions, InfoGrid, InfoItem, FilterBar |
|
|
86
|
-
| Avisos, status e carregamento | Notice, StatusBadge, DomainStatusBadge, PageState, LoadingDots, CircularLoading |
|
|
87
|
-
| Identidade e apoio visual | Avatar, ThemedImage, IconProvider, Tooltip |
|
|
88
|
-
| Texto, seleção e datas | Input, InputStandalone, InputSelect, TextArea, SelectMulti, DatePicker |
|
|
89
|
-
| Países e telefones | SelectCountry, InputPhone |
|
|
90
|
-
| Opções e valores graduais | Checkbox, RadioGroup, RadioCardGroup, InputSwitch, Slider, InputSlider |
|
|
91
|
-
| Dados tabulares | Table, MobileCardTable |
|
|
92
|
-
| Visualizações | TimeSeriesChart, InteractiveDonutChart, TimeRangeSelector, LazyApexChart |
|
|
93
|
-
| Diálogos e documentos | Modal, DocumentItem, BoletoBarCode |
|
|
94
|
-
| Acessibilidade | SkipLink, FocusNavigationMode, FormErrorNavigation, AccessibilityPreferencesPanel, HighContrastToggle |
|
|
95
|
-
|
|
96
|
-
Essa tabela organiza os componentes por finalidade. Consulte os entrypoints para escolher o import: Checkbox está em `/core`, RadioGroup em `/forms` e InputSwitch em `/overlays`, por exemplo.
|
|
97
|
-
|
|
98
|
-
## Componentes básicos na prática
|
|
30
|
+
Use componentes pela raiz ou por um entrypoint público:
|
|
99
31
|
|
|
100
32
|
```tsx
|
|
101
|
-
import {
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
StatusBadge,
|
|
105
|
-
Surface,
|
|
106
|
-
Typography,
|
|
107
|
-
} from "@aspprev/versi-ds/core";
|
|
33
|
+
import { Button, Surface, Typography } from "@aspprev/versi-ds";
|
|
34
|
+
import { Input, OtpCodeInput } from "@aspprev/versi-ds/forms";
|
|
35
|
+
import { FileDropzone, QRCode } from "@aspprev/versi-ds/documents";
|
|
108
36
|
|
|
109
37
|
export function Resumo() {
|
|
110
38
|
return (
|
|
111
|
-
<Surface tone="card" padding="default"
|
|
112
|
-
<Typography element="
|
|
113
|
-
|
|
114
|
-
</Typography>
|
|
115
|
-
<Typography semanticRole="body">
|
|
116
|
-
Confira as informações antes de continuar.
|
|
39
|
+
<Surface tone="card" padding="default">
|
|
40
|
+
<Typography element="h1" semanticRole="section-title">
|
|
41
|
+
Meu cadastro
|
|
117
42
|
</Typography>
|
|
118
|
-
<
|
|
119
|
-
Atualizado
|
|
120
|
-
</StatusBadge>
|
|
121
|
-
<Notice type="info">
|
|
122
|
-
Você pode revisar os dados a qualquer momento.
|
|
123
|
-
</Notice>
|
|
124
|
-
<Button type="button" variant="outline" color="primary">
|
|
125
|
-
Revisar
|
|
126
|
-
</Button>
|
|
43
|
+
<Button type="button">Continuar</Button>
|
|
127
44
|
</Surface>
|
|
128
45
|
);
|
|
129
46
|
}
|
|
130
47
|
```
|
|
131
48
|
|
|
132
|
-
|
|
133
|
-
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
134
|
-
| Button | `variant`: flat/outline/plain; `color`: primary/secondary/tertiary/danger/warning; `size`: small/medium/large; `width`: auto/full; `loading`, `loadingLabel`, `disabled` |
|
|
135
|
-
| Typography | `element`: elemento HTML; `semanticRole`: page-title/section-title/body/label/caption/helper; `size`, `weight`, `variant` |
|
|
136
|
-
| Surface | `tone`: card/subtle/muted/disabled/info/success/warning/danger/transparent; `padding`: none/compact/default; `elevation`: none/sm/md; `radius`: none/sm/md |
|
|
137
|
-
| Notice | `type`: info/primary/secondary/tertiary/gray/success/warning/danger; `onDismiss`, `icon`, `rounded` |
|
|
138
|
-
| StatusBadge | `tone`: neutral/info/success/warning/danger; `appearance`: outline/soft/solid; `size`: sm/md |
|
|
139
|
-
|
|
140
|
-
Em Typography, `semanticRole` define a apresentação; `element` define a semântica HTML. Use `element="h1"` para o título principal e níveis coerentes para as seções. Uma etiqueta de status precisa de texto compreensível, além da cor.
|
|
141
|
-
|
|
142
|
-
Para uma ação em andamento, use `loading` e um `loadingLabel` descritivo no Button. Dentro de formulários, declare `type="submit"` para enviar e `type="button"` para as demais ações.
|
|
143
|
-
|
|
144
|
-
## Formulários
|
|
49
|
+
### Entrypoints
|
|
145
50
|
|
|
146
|
-
|
|
51
|
+
| Entry point | Conteúdo |
|
|
52
|
+
| --- | --- |
|
|
53
|
+
| `@aspprev/versi-ds` | API principal e componentes mais usados |
|
|
54
|
+
| `/core` | componentes base, layout, status, tabela e hooks |
|
|
55
|
+
| `/forms` | campos Formik e controlados, seleção e OTP |
|
|
56
|
+
| `/documents` | documentos, upload, FileViewer e QRCode |
|
|
57
|
+
| `/overlays` | modal, preferências e camadas interativas |
|
|
58
|
+
| `/charts` | gráficos e seletores de período |
|
|
59
|
+
| `/countries` | países, telefones e bandeiras |
|
|
60
|
+
| `/styles.css` | estilos e tokens base |
|
|
61
|
+
| `/themes.css` | presets de tema |
|
|
147
62
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
```tsx
|
|
151
|
-
import { Form, Formik } from "formik";
|
|
152
|
-
import { Button, FormActions, FormGrid } from "@aspprev/versi-ds/core";
|
|
153
|
-
import { Input, InputSelect } from "@aspprev/versi-ds/forms";
|
|
154
|
-
|
|
155
|
-
type Valores = { nome: string; categoria: string };
|
|
156
|
-
|
|
157
|
-
export function Cadastro({
|
|
158
|
-
salvar,
|
|
159
|
-
}: {
|
|
160
|
-
salvar: (values: Valores) => Promise<void>;
|
|
161
|
-
}) {
|
|
162
|
-
return (
|
|
163
|
-
<Formik<Valores>
|
|
164
|
-
initialValues={{ nome: "", categoria: "" }}
|
|
165
|
-
validate={(values) => {
|
|
166
|
-
const errors: Partial<Record<keyof Valores, string>> = {};
|
|
167
|
-
if (!values.nome.trim()) errors.nome = "Informe seu nome.";
|
|
168
|
-
if (!values.categoria) errors.categoria = "Selecione uma categoria.";
|
|
169
|
-
return errors;
|
|
170
|
-
}}
|
|
171
|
-
onSubmit={salvar}
|
|
172
|
-
>
|
|
173
|
-
{({ isSubmitting }) => (
|
|
174
|
-
<Form>
|
|
175
|
-
<FormGrid columns={2}>
|
|
176
|
-
<Input name="nome" label="Nome completo" autoComplete="name" />
|
|
177
|
-
<InputSelect
|
|
178
|
-
name="categoria"
|
|
179
|
-
label="Categoria"
|
|
180
|
-
options={[
|
|
181
|
-
{ label: "Pessoa física", value: "pessoa-fisica" },
|
|
182
|
-
{ label: "Pessoa jurídica", value: "pessoa-juridica" },
|
|
183
|
-
]}
|
|
184
|
-
/>
|
|
185
|
-
</FormGrid>
|
|
186
|
-
<FormActions align="end">
|
|
187
|
-
<Button
|
|
188
|
-
type="submit"
|
|
189
|
-
loading={isSubmitting}
|
|
190
|
-
loadingLabel="Salvando cadastro"
|
|
191
|
-
>
|
|
192
|
-
Salvar
|
|
193
|
-
</Button>
|
|
194
|
-
</FormActions>
|
|
195
|
-
</Form>
|
|
196
|
-
)}
|
|
197
|
-
</Formik>
|
|
198
|
-
);
|
|
199
|
-
}
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
O `name` deve corresponder à chave em `initialValues`. Os erros integrados aparecem quando o campo está marcado como tocado (`touched`). Forneça `label`; o placeholder é um exemplo de preenchimento, não substitui o rótulo.
|
|
203
|
-
|
|
204
|
-
FormGrid usa uma coluna em telas menores e aplica `columns` a partir do breakpoint `tablet` (1024 px). FormActions organiza as ações em coluna no mobile e em linha nas telas maiores.
|
|
205
|
-
|
|
206
|
-
### Campo controlado sem contexto Formik
|
|
207
|
-
|
|
208
|
-
```tsx
|
|
209
|
-
import { useState } from "react";
|
|
210
|
-
import { InputStandalone } from "@aspprev/versi-ds/forms";
|
|
211
|
-
|
|
212
|
-
export function Busca() {
|
|
213
|
-
const [termo, setTermo] = useState("");
|
|
214
|
-
return (
|
|
215
|
-
<InputStandalone
|
|
216
|
-
name="busca"
|
|
217
|
-
label="Buscar por nome"
|
|
218
|
-
value={termo}
|
|
219
|
-
onChange={(event) => setTermo(event.target.value)}
|
|
220
|
-
/>
|
|
221
|
-
);
|
|
222
|
-
}
|
|
223
|
-
```
|
|
224
|
-
|
|
225
|
-
Input e InputStandalone oferecem máscaras como `cpf`, `cnpj`, `cep`, `phone`, `date` e `currency`. A máscara auxilia a digitação; a aplicação ainda deve validar e normalizar o valor exigido pela sua API. Use InputPhone para seleção internacional de país e DDI.
|
|
226
|
-
|
|
227
|
-
## Diálogos controlados
|
|
228
|
-
|
|
229
|
-
```tsx
|
|
230
|
-
import { useState } from "react";
|
|
231
|
-
import { Button } from "@aspprev/versi-ds/core";
|
|
232
|
-
import { Modal } from "@aspprev/versi-ds/overlays";
|
|
233
|
-
|
|
234
|
-
export function Detalhes() {
|
|
235
|
-
const [aberto, setAberto] = useState(false);
|
|
236
|
-
return (
|
|
237
|
-
<>
|
|
238
|
-
<Button type="button" onClick={() => setAberto(true)}>
|
|
239
|
-
Ver detalhes
|
|
240
|
-
</Button>
|
|
241
|
-
<Modal
|
|
242
|
-
isOpen={aberto}
|
|
243
|
-
onClose={() => setAberto(false)}
|
|
244
|
-
title="Detalhes do cadastro"
|
|
245
|
-
showIcon={false}
|
|
246
|
-
>
|
|
247
|
-
<p>Informações complementares do cadastro.</p>
|
|
248
|
-
<Button type="button" onClick={() => setAberto(false)}>
|
|
249
|
-
Fechar
|
|
250
|
-
</Button>
|
|
251
|
-
</Modal>
|
|
252
|
-
</>
|
|
253
|
-
);
|
|
254
|
-
}
|
|
255
|
-
```
|
|
63
|
+
Evite deep imports. Use somente os entrypoints públicos documentados no `package.json`.
|
|
256
64
|
|
|
257
|
-
|
|
65
|
+
## Organização do Design System
|
|
258
66
|
|
|
259
|
-
|
|
67
|
+
- **Components**: controles de ação, formulários, feedback, navegação, dados, documentos, overlays e layout.
|
|
68
|
+
- **Foundations**: cores, tipografia, espaçamento e sombras derivados dos tokens.
|
|
69
|
+
- **Themes**: esquema claro/escuro, contraste, escala tipográfica e presets de identidade.
|
|
70
|
+
- **Hooks e utilitários**: breakpoints, acessibilidade, preferências e posicionamento.
|
|
71
|
+
- **Countries e charts**: dados de países/bandeiras e integrações de gráficos.
|
|
260
72
|
|
|
261
|
-
|
|
73
|
+
Os tokens canônicos ficam em `tokens/design-system.tokens.json`. Arquivos CSS gerados não devem ser editados manualmente.
|
|
262
74
|
|
|
263
|
-
##
|
|
75
|
+
## Storybook
|
|
264
76
|
|
|
265
|
-
|
|
77
|
+
Instale as dependências e inicie a documentação visual:
|
|
266
78
|
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
data-ds-theme="verde3"
|
|
271
|
-
data-contrast="high"
|
|
272
|
-
data-contrast-theme="dark"
|
|
273
|
-
data-font-scale="large"
|
|
274
|
-
data-motion="reduce"
|
|
275
|
-
></html>
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
| Atributo | Valores |
|
|
279
|
-
| --------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
280
|
-
| `data-color-scheme` | `light`, `dark` |
|
|
281
|
-
| `data-ds-theme` | `default`, `azul1`, `azul2`, `azul3`, `laranja1`, `laranja2`, `verde1`, `verde2`, `verde3`, `verde4`, `rosa1` |
|
|
282
|
-
| `data-contrast` | `normal`, `high` |
|
|
283
|
-
| `data-contrast-theme` | `light`, `dark` (esquema do alto contraste) |
|
|
284
|
-
| `data-font-scale` | `default`, `large`, `extra-large` |
|
|
285
|
-
| `data-motion` | `full`, `reduce` |
|
|
286
|
-
|
|
287
|
-
As preferências são controladas pelo consumidor, que também cuida da persistência e sincronização. As classes legadas das paletas continuam disponíveis. Tokens de cores usam triplets RGB para aceitar opacidade.
|
|
288
|
-
|
|
289
|
-
O pacote não distribui nem baixa fontes. Configure `--font-nunito-sans` ou sobrescreva `--font-family-base`; sem Nunito Sans disponível, o navegador usa `sans-serif`. O Storybook carrega Nunito Sans pelo Google Fonts e precisa de rede para reproduzir essa tipografia nas referências visuais existentes. O consumidor pode hospedar a própria fonte; não há dependência de `next/font`.
|
|
290
|
-
|
|
291
|
-
### Alterar o tema em execução
|
|
292
|
-
|
|
293
|
-
No navegador, atualize os atributos do elemento raiz:
|
|
294
|
-
|
|
295
|
-
```ts
|
|
296
|
-
const root = document.documentElement;
|
|
297
|
-
root.dataset.colorScheme = "dark";
|
|
298
|
-
root.dataset.dsTheme = "azul1";
|
|
299
|
-
root.dataset.contrast = "normal";
|
|
300
|
-
root.dataset.contrastTheme = "dark";
|
|
301
|
-
root.dataset.fontScale = "large";
|
|
302
|
-
root.dataset.motion = "reduce";
|
|
303
|
-
```
|
|
304
|
-
|
|
305
|
-
Use o `html` para que diálogos e listas renderizados fora da árvore do componente recebam o mesmo tema. Aplique as preferências conhecidas antes da primeira pintura quando houver SSR. Para acompanhar o tema do sistema, a aplicação deve resolver a preferência para `light` ou `dark`.
|
|
306
|
-
|
|
307
|
-
AccessibilityPreferencesPanel recebe `preferences` e entrega mudanças parciais em `onPreferencesChange`. Mescle essas mudanças com o estado atual e sincronize os atributos CSS. O valor `fontScale="standard"` do painel corresponde a `data-font-scale="default"`; `highContrast` corresponde a normal/high e `reduceMotion` a full/reduce. O painel não persiste nem aplica automaticamente as preferências no documento.
|
|
308
|
-
|
|
309
|
-
### Usar tokens no CSS da aplicação
|
|
310
|
-
|
|
311
|
-
Prefira tokens semânticos, que expressam a função da cor, em vez de copiar valores de uma paleta:
|
|
312
|
-
|
|
313
|
-
```css
|
|
314
|
-
.resumo-cadastro {
|
|
315
|
-
color: rgb(var(--content-primary));
|
|
316
|
-
background-color: rgb(var(--surface-page));
|
|
317
|
-
border: 1px solid rgb(var(--border-default));
|
|
318
|
-
padding: var(--spacing-md);
|
|
319
|
-
border-radius: var(--border-radius-md);
|
|
320
|
-
}
|
|
321
|
-
|
|
322
|
-
.resumo-cadastro:focus-visible {
|
|
323
|
-
outline: 2px solid rgb(var(--focus-ring));
|
|
324
|
-
outline-offset: 2px;
|
|
325
|
-
}
|
|
79
|
+
```bash
|
|
80
|
+
npm install
|
|
81
|
+
npm run storybook
|
|
326
82
|
```
|
|
327
83
|
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
O CSS distribuído inclui as classes necessárias aos componentes, não todas as classes possíveis do Tailwind. Para layouts próprios, use seu CSS ou o build Tailwind da aplicação; o `tailwind.config.cjs` deste repositório não é um export público.
|
|
331
|
-
|
|
332
|
-
### Configurar a família tipográfica
|
|
333
|
-
|
|
334
|
-
Depois de carregar a fonte escolhida, configure sua família no CSS global. Para uma alternativa sem download de fonte:
|
|
84
|
+
O servidor usa a porta `6006`. Para a configuração standalone:
|
|
335
85
|
|
|
336
|
-
```
|
|
337
|
-
:
|
|
338
|
-
--font-nunito-sans: system-ui;
|
|
339
|
-
--font-family-base: var(--font-nunito-sans), sans-serif;
|
|
340
|
-
}
|
|
86
|
+
```bash
|
|
87
|
+
npm run storybook:standalone
|
|
341
88
|
```
|
|
342
89
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
90
|
+
A árvore da documentação é organizada assim:
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
Getting Started
|
|
94
|
+
├── Introduction
|
|
95
|
+
├── Installation
|
|
96
|
+
├── Usage
|
|
97
|
+
└── Contributing
|
|
98
|
+
|
|
99
|
+
Foundations
|
|
100
|
+
├── Overview
|
|
101
|
+
├── Colors
|
|
102
|
+
├── Typography
|
|
103
|
+
├── Spacing
|
|
104
|
+
└── Shadows
|
|
105
|
+
|
|
106
|
+
Components
|
|
107
|
+
├── Actions
|
|
108
|
+
├── Forms
|
|
109
|
+
├── Feedback
|
|
110
|
+
├── Data Display
|
|
111
|
+
├── Documents
|
|
112
|
+
├── Navigation
|
|
113
|
+
├── Overlay
|
|
114
|
+
├── Layout
|
|
115
|
+
└── Accessibility
|
|
116
|
+
|
|
117
|
+
Patterns
|
|
118
|
+
├── Forms
|
|
119
|
+
└── Feedback
|
|
120
|
+
|
|
121
|
+
Themes
|
|
122
|
+
├── Overview
|
|
123
|
+
├── Comparison
|
|
124
|
+
└── ThemeLab
|
|
125
|
+
|
|
126
|
+
Guidelines
|
|
127
|
+
├── Accessibility
|
|
128
|
+
└── Usage
|
|
378
129
|
```
|
|
379
130
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
As 250 bandeiras são incorporadas ao JavaScript como URLs `data:image/svg+xml;base64,...`. `getCountryFlagUrl("BR")` retorna o SVG do pacote; códigos desconhecidos retornam string vazia. Não copie `public/flags`: Next.js, Vite, Storybook, SSR e aplicações sob subpath usam o mesmo asset, sem CDN, rota estática ou postinstall.
|
|
383
|
-
|
|
384
|
-
Opções customizadas com `flags.svg` não vazio têm prioridade; sem ele, o componente usa o ISO-2 e, se desconhecido, um placeholder. `flags.png` permanece como metadado legado e não é requisitado. Com CSP, permita `data:` em `img-src`. Use a URL em `<img>`; não é necessário `next/image`.
|
|
385
|
-
|
|
386
|
-
O build gera `src/data/country-flags.json` deterministicamente a partir dos SVGs, e tsup incorpora esse mapa ao chunk compartilhado. Os 250 originais também permanecem em `dist/flags` para compatibilidade e auditoria. Isso aumenta o JavaScript de quem importa países ou formulários; não existe carregamento individual sob demanda. Consulte `docs/BANDEIRAS.md` e o fixture `examples/flags-consumer`.
|
|
131
|
+
A toolbar permite comparar esquema de cores, preset, contraste, escala de fonte e movimento reduzido. O addon de acessibilidade permanece disponível para inspeção manual e os testes automatizados usam Axe nos cenários visuais.
|
|
387
132
|
|
|
388
133
|
## Desenvolvimento e validação
|
|
389
134
|
|
|
390
135
|
```bash
|
|
391
|
-
npm install
|
|
392
136
|
npm run tokens:check
|
|
393
|
-
npm run check:governance
|
|
394
|
-
npm run check:security
|
|
395
137
|
npm run typecheck
|
|
396
|
-
npm run build
|
|
397
138
|
npm test
|
|
398
|
-
npm run
|
|
139
|
+
npm run build
|
|
399
140
|
npm run build-storybook
|
|
400
|
-
npx playwright install chromium
|
|
401
141
|
npm run test:visual
|
|
402
142
|
npm run check:package
|
|
403
|
-
npm run
|
|
404
|
-
npm pack --dry-run
|
|
143
|
+
npm run prepack
|
|
405
144
|
```
|
|
406
145
|
|
|
407
|
-
|
|
146
|
+
O script `prepack` valida tokens, governança, segurança, TypeScript, build, tamanho e conteúdo do pacote. O projeto não possui um script `lint` separado.
|
|
408
147
|
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
No Storybook, abra o grupo `Design System` e escolha um componente. Use suas stories para comparar estados e variantes, e os controles para experimentar as propriedades disponíveis. A barra de ferramentas altera esquema de cores, paleta, contraste, escala da fonte e movimento. O `ThemeLab/Playground` reúne a exploração dos temas; o painel de acessibilidade ajuda na inspeção de cada cenário.
|
|
412
|
-
|
|
413
|
-
`prepack` verifica tokens, governança, dependências (`npm audit`), TypeScript, build, tamanho e conteúdo antes de empacotar. O tarball inclui somente `dist/`, `README.md` e o `package.json` obrigatório do npm. Stories, testes, documentação interna e ferramentas não são publicados. Sourcemaps em `dist` são intencionais para diagnóstico.
|
|
414
|
-
|
|
415
|
-
## Aplicação de exemplo
|
|
416
|
-
|
|
417
|
-
O repositório inclui uma aplicação React/Vite em `examples/pilot`, com cadastro,
|
|
418
|
-
validação de formulário, países/telefone, tabela, modal e controles de aparência.
|
|
419
|
-
Ela instala o DS a partir do tarball e usa apenas os entrypoints públicos.
|
|
420
|
-
|
|
421
|
-
Na raiz do repositório:
|
|
148
|
+
Para testar o exemplo integrado:
|
|
422
149
|
|
|
423
150
|
```bash
|
|
424
151
|
npm run pilot:prepare
|
|
425
|
-
npm run pilot
|
|
152
|
+
npm run test:pilot
|
|
426
153
|
```
|
|
427
154
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
155
|
+
Antes de uma publicação, gere um tarball local com `npm pack` e valide sua instalação nos consumidores.
|
|
156
|
+
|
|
157
|
+
## Temas
|
|
431
158
|
|
|
432
|
-
|
|
159
|
+
As preferências são controladas pelo consumidor no elemento `html`:
|
|
433
160
|
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
| Diálogo ou dropdown com tema diferente | Aplique os atributos de tema no html para alcançar também os elementos renderizados fora da árvore do componente. |
|
|
443
|
-
| Fonte diferente do Storybook | Carregue a fonte desejada e configure --font-nunito-sans; a fonte não acompanha o pacote. |
|
|
444
|
-
| Erro de hooks em aplicação RSC | Defina estado e callbacks em um componente cliente; consulte a seção sobre servidor e navegador. |
|
|
161
|
+
```ts
|
|
162
|
+
const root = document.documentElement;
|
|
163
|
+
root.dataset.colorScheme = "dark";
|
|
164
|
+
root.dataset.dsTheme = "azul1";
|
|
165
|
+
root.dataset.contrast = "high";
|
|
166
|
+
root.dataset.fontScale = "large";
|
|
167
|
+
root.dataset.motion = "reduce";
|
|
168
|
+
```
|
|
445
169
|
|
|
446
|
-
|
|
170
|
+
Os valores válidos estão documentados em **Themes/Overview** no Storybook. Prefira tokens semânticos, como `--surface-page`, `--content-primary`, `--border-default` e `--focus-ring`, em vez de copiar valores de uma paleta.
|
|
447
171
|
|
|
448
|
-
|
|
172
|
+
## Contribuição
|
|
449
173
|
|
|
450
|
-
|
|
451
|
-
| --------------------------------- | ------------------------------------------------------- |
|
|
452
|
-
| docs/API-PUBLICA-CONTROLES.md | Contratos dos controles, estado, teclado e dependências |
|
|
453
|
-
| docs/COMPONENTES-CLIENT-SERVER.md | Fronteiras cliente e servidor |
|
|
454
|
-
| docs/THEMELAB-E-GLOBALS-CSS.md | Temas e personalização do CSS |
|
|
455
|
-
| tokens/README.md | Fonte e geração dos tokens |
|
|
456
|
-
| docs/GOVERNANCA-DESIGN-SYSTEM.md | Contribuição, versionamento e publicação |
|
|
457
|
-
| docs/EVOLUCAO-DESIGN-SYSTEM.md | Histórico de mudanças e validações |
|
|
174
|
+
Ao criar ou alterar um componente:
|
|
458
175
|
|
|
459
|
-
|
|
460
|
-
|
|
176
|
+
1. reutilize tokens e componentes existentes;
|
|
177
|
+
2. mantenha a API tipada e compatível com React;
|
|
178
|
+
3. garanta foco visível, teclado, nomes acessíveis, erros e estados de carregamento;
|
|
179
|
+
4. crie ou atualize stories com estados relevantes;
|
|
180
|
+
5. adicione testes unitários, de interação e de acessibilidade quando aplicável;
|
|
181
|
+
6. execute `npm run prepack` antes de gerar o pacote.
|
|
461
182
|
|
|
183
|
+
Detalhes de contratos, governança e segurança ficam na pasta `docs/`. A documentação de uso visual deve permanecer principalmente no Storybook.
|
|
@@ -306,9 +306,10 @@ var Tooltip = ({
|
|
|
306
306
|
var Tooltip_default = Tooltip;
|
|
307
307
|
|
|
308
308
|
export {
|
|
309
|
+
breakpoints,
|
|
309
310
|
useBreakpoint,
|
|
310
311
|
mergeAriaDescribedBy,
|
|
311
312
|
getFloatingLayerClass,
|
|
312
313
|
Tooltip_default
|
|
313
314
|
};
|
|
314
|
-
//# sourceMappingURL=chunk-
|
|
315
|
+
//# sourceMappingURL=chunk-ET2BGHTO.js.map
|