@celke/kole-react 0.1.0 → 0.3.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 CHANGED
@@ -1,255 +1,401 @@
1
- # @celke/kole-react
2
-
3
- Biblioteca de componentes **React** para sistemas administrativos. Design tokens
4
- próprios (cores, raios, densidade, tema claro/escuro), CSS puro e sem dependência
5
- de Tailwind.
6
-
7
- ## Instalação
8
-
9
- ```bash
10
- npm i @celke/kole-react
11
- ```
12
-
13
- Requisitos: React 18.2+ ou 19. A fonte Inter já vem dentro do pacote (o
14
- `estilos.css` carrega só os alfabetos que a página usa). O pacote é só ESM, traz
15
- os tipos TypeScript e já vem marcado com `'use client'`, então funciona no App
16
- Router do Next.js.
17
-
18
- ## Uso
19
-
20
- ```tsx
21
- // main.tsx
22
- import { createRoot } from 'react-dom/client';
23
- import '@celke/kole-react/estilos.css';
24
- import { ProvedorUi } from '@celke/kole-react';
25
- import { App } from './App';
26
-
27
- createRoot(document.getElementById('root')!).render(
28
- <ProvedorUi>
29
- <App />
30
- </ProvedorUi>,
31
- );
32
- ```
33
-
34
- `ProvedorUi` liga tema/densidade (lembrados no navegador), toasts (`useToast`) e
35
- confirmação (`useConfirmacao`).
36
-
37
- ### Layout com React Router
38
-
39
- ```tsx
40
- import { Link, Outlet, useLocation, useNavigate } from 'react-router-dom';
41
- import { Estrutura } from '@celke/kole-react';
42
-
43
- export function Layout({ sair }: { sair: () => void }) {
44
- const { pathname } = useLocation();
45
- const navigate = useNavigate();
46
- return (
47
- <Estrutura
48
- marca={{ nome: 'Gestor', subtitulo: 'Gestão comercial', logo: '/logo.svg' }}
49
- nav={[
50
- { itens: [{ rotulo: 'Painel', icone: 'house', rota: '/' }] },
51
- {
52
- rotulo: 'Cadastros',
53
- itens: [
54
- { rotulo: 'Pedidos', icone: 'shopping-cart', rota: '/pedidos' },
55
- { rotulo: 'Tabelas', icone: 'table', filhos: [{ rotulo: 'Categorias', rota: '/categorias' }] },
56
- ],
57
- },
58
- ]}
59
- rotaAtual={pathname}
60
- aoNavegar={navigate}
61
- usuario={{ nome: 'Gabrielly Ribeiro', cargo: 'Gerente comercial' }}
62
- menuUsuario={[{ id: 'sair', rotulo: 'Sair', icone: 'log-out', destrutivo: true }]}
63
- aoEscolherMenuUsuario={(id) => id === 'sair' && sair()}
64
- >
65
- <Outlet />
66
- </Estrutura>
67
- );
68
- }
69
- ```
70
-
71
- Para links de verdade do roteador (ctrl+clique abre em nova aba), passe
72
- `renderLink={(p) => <Link to={p.href} className={p.className} onClick={p.onClick} aria-current={p['aria-current']}>{p.children}</Link>}`.
73
-
74
- ## Componentes
75
-
76
- | Grupo | Componentes |
77
- |---|---|
78
- | Layout | `Estrutura`, `Busca`, `CabecalhoPagina`, `BoasVindas`, `TelaLogin`, `Abas`/`Aba`, `Card` |
79
- | Ações | `Botao`, `AcaoLinha`, `Dica` |
80
- | Formulário | `Form` (página ou modal, `entidade`/`modo`), `FormSecao`, `Campo`, `CampoTexto`, `CampoTextarea`, `CampoSenha`, `CampoSelect`, `CampoSelectMultiplo`, `CampoMarcacao`, `Escolha`, `Picklist`, `Filtros` |
81
- | Campos prontos | `CampoCpf`, `CampoCnpj`, `CampoCpfCnpj`, `CampoCep`, `CampoTelefone`, `CampoPlaca`, `CampoRenavam`, `CampoChassi`, `CampoCnh`, `CampoImei`, `CampoEmail`, `CampoData`, `CampoHora`, `CampoDataHora`, `CampoMoeda`, `CampoInteiro`, `CampoUf`, `CampoUfMultiplo`, `CampoTipoPessoa` |
82
- | Busca remota | `CampoBusca`, `CampoCidade`, `useBuscaAssincrona` |
83
- | Arquivos | `CampoAnexo`, `VisualizadorArquivo`, `DialogoArquivo`, `Foto` |
84
- | Dados | `Tabela`, `ListaCards`, `Paginacao`, `Indicador`/`Indicadores`, `Detalhes`, `Status`, `Chip`, `Avatar`, `Placa` |
85
- | Feedback | `Alerta`, `Dialogo` (central ou `lateral`), `useConfirmacao` (+ `.remover()`, `.avisar()`), `useToast`, `Vazio`, `Skeleton`, `Carregando` |
86
- | Conversa | `Conversa`, `Mensagem`, `CampoMensagem`, `Referencias` |
87
-
88
- ### Conversa (chat)
89
-
90
- `Conversa` é a área rolável (acompanha o fim durante o streaming e para de
91
- puxar se a pessoa rolar para cima); `Mensagem` é a bolha; `CampoMensagem` é o
92
- campo de envio (Enter envia, Shift+Enter quebra a linha); `Referencias` lista
93
- as fontes de uma resposta. A conversa ocupa a altura do contêiner pai, e a
94
- busca da resposta (rede, streaming, Markdown) fica com o app.
95
-
96
- ```tsx
97
- import { useState } from 'react';
98
- import {
99
- CampoMensagem,
100
- Conversa,
101
- Mensagem,
102
- Referencias,
103
- type AutorMensagem,
104
- type EstadoMensagem,
105
- type ItemReferencia,
106
- } from '@celke/kole-react';
107
-
108
- interface ItemChat {
109
- id: string;
110
- autor: AutorMensagem;
111
- estado: EstadoMensagem;
112
- texto: string;
113
- hora: Date;
114
- fontes?: ItemReferencia[]; // { id, titulo, detalhe?, trecho?, href? }
115
- }
116
-
117
- interface ChatProps {
118
- mensagens: ItemChat[];
119
- gerando: boolean;
120
- enviar: (texto: string) => void;
121
- parar: () => void;
122
- }
123
-
124
- export function Chat({ mensagens, gerando, enviar, parar }: ChatProps) {
125
- const [texto, setTexto] = useState('');
126
- return (
127
- <div style={{ height: '32rem' }}>
128
- <Conversa
129
- campo={
130
- <CampoMensagem
131
- valor={texto}
132
- aoMudar={setTexto}
133
- aoEnviar={(t) => {
134
- enviar(t);
135
- setTexto('');
136
- }}
137
- gerando={gerando}
138
- aoParar={parar}
139
- />
140
- }
141
- >
142
- {mensagens.map((m) => (
143
- <Mensagem
144
- key={m.id}
145
- autor={m.autor} // 'usuario' | 'assistente' | 'sistema'
146
- estado={m.estado} // 'enviando' | 'gerando' | 'concluida' | 'erro'
147
- hora={m.hora}
148
- copiavel={m.autor === 'assistente'}
149
- rodape={m.fontes && <Referencias itens={m.fontes} />}
150
- >
151
- {m.texto}
152
- </Mensagem>
153
- ))}
154
- </Conversa>
155
- </div>
156
- );
157
- }
158
- ```
159
-
160
- Utilitários (lógica pura, também exportados): validadores BR (`isCpf`, `isCnpj`,
161
- `isCnh`, `isImei`, `validar(tipo, valor)`…), `TIPOS_CAMPO` (máscara +
162
- placeholder + regra por tipo), `ESTADOS`/`TIPOS_PESSOA`, por extenso
163
- (`numeroPorExtenso`, `valorMonetarioPorExtenso`, `listaPorExtenso`), texto
164
- (`normalizar`, `nomeProprio`, `nomeCurto`, `iniciais`, `formatCpfCnpj`), datas
165
- pt-BR (`parseDataBr`, `formatDataBr`…), `tituloDeEntidade`/`nomeDeArquivo`,
166
- anexos (`formatBytes`, `tipoDeArquivo`, `iconeArquivo`), senha
167
- (`validarSenha`, `forcaSenha`), picklist, JWT (`decodificarJwt`, `jwtExpirado`…)
168
- e `severidadeCor`. A demo do repositório tem uma página interativa de cada um
169
- (`#/utilitarios`).
170
-
171
- Convenções:
172
-
173
- - Campos são controlados por `valor` + `aoMudar`; aceitam `rotulo`, `dica`,
174
- `erro`, `aviso`, `obrigatorio` e `variante="inline"` (pílula com rótulo dentro,
175
- para barras de filtro).
176
- - Severidades: `ok`, `info`, `warn`, `err`, `neutral` (botão: `pri`, `secundario`,
177
- `ok`, `warn`, `err`).
178
- - Ícones: [Lucide](https://lucide.dev/icons) (SVG, já incluso no pacote). Passe o
179
- nome (`icone="save"`, `icone="trash-2"`) ou o componente
180
- (`import { Rocket } from 'lucide-react'` → `icone={<Rocket />}`). Só os ícones
181
- registrados entram no bundle; para usar outro pelo nome, registre uma vez:
182
- `registrarIcones({ rocket: Rocket })`. Um nome não registrado avisa no console
183
- em desenvolvimento.
184
- - Pendência de campo: o erro aparece ao **sair** do campo depois de digitar, ou
185
- quando o `Form` tenta salvar (todos os campos acusam). Um valor carregado de
186
- fora que não atende ao formato não é recusado: vira aviso âmbar.
187
- - Grade do `FormSecao`: 4 colunas na página, 3 no modal; `className="lp-col-2"`,
188
- `lp-col-3` ou `lp-col-full` alarga o campo.
189
- - Cadastro com vários formulários: passe `menu` (itens com `id`, `rotulo`,
190
- `icone`, `href`) e `menuAtivo` ao `Form` de cada página; o menu lateral liga
191
- os formulários entre si, cada um com o próprio Salvar.
192
-
193
- ## Tema e tokens
194
-
195
- Toda cor/medida vem de variáveis CSS (os tokens). Para mudar a marca, redefina
196
- os tokens no CSS do app, carregado **depois** do `estilos.css` — por exemplo
197
- `--navy` (marinho da sidebar), `--pri` (azul de ação) e `--acento-claro` (laranja
198
- do item ativo). O tema escuro tem valores próprios, então redefina lá também:
199
-
200
- ```css
201
- :root {
202
- --pri: #0f766e;
203
- --pri-ink: #115e59;
204
- }
205
- [data-theme='dark'] {
206
- --pri: #2dd4bf;
207
- --pri-ink: #5eead4;
208
- }
209
- ```
210
-
211
- O tema escuro usa `<html data-theme="dark">`; a densidade, as classes
212
- `density-compact`, `density-comfortable` e `density-cozy` no `<body>` (o
213
- `ProvedorUi` cuida das duas). A lista completa de tokens, com os valores dos
214
- dois temas, está em `@celke/kole-react/tokens.css`.
215
-
216
- Para usar só os tokens fora do React: `@import '@celke/kole-react/tokens.css';`.
217
-
218
- ## CSS
219
-
220
- Classes CSS usam o prefixo `lp-`.
221
-
222
- ## Desenvolvimento
223
-
224
- ```bash
225
- npm install
226
- npm run dev # http://localhost:5173 — demo com todos os componentes
227
- npm run typecheck
228
- npm run build # dist/index.js + tipos (.d.ts) + dist/estilos.css + dist/tokens.css
229
- ```
230
-
231
- Para testar uma versão que ainda não está no npm, instale direto do GitHub
232
- (o `prepare` gera o `dist/` na instalação) ou de um pacote local:
233
-
234
- ```bash
235
- npm i github:celkecursos/kole-react
236
- # ou: gere o .tgz na pasta da biblioteca e instale no app
237
- npm pack # → celke-kole-react-<versão>.tgz
238
- npm i ../kole-react/celke-kole-react-<versão>.tgz
239
- ```
240
-
241
- Evite `npm i ../kole-react` (pasta): o npm cria um link e o bundler
242
- pega o React do `node_modules` da biblioteca — dois Reacts no app quebram os hooks
243
- (_Invalid hook call_). Se precisar do link durante o desenvolvimento, use
244
- `resolve: { dedupe: ['react', 'react-dom'] }` no `vite.config` do app.
245
-
246
- Publicar uma versão nova: `npm version patch` e `npm publish` (o `prepare` roda o
247
- build; confira o conteúdo antes com `npm pack --dry-run`).
248
-
249
- ## Autor
250
-
251
- Criado por **Cesar Szpak**.
252
-
253
- ## Licença
254
-
255
- MIT © 2026 Celke — veja o arquivo [LICENSE](https://github.com/celkecursos/kole-react/blob/main/LICENSE).
1
+ # @celke/kole-react
2
+
3
+ Biblioteca de componentes **React** para sistemas administrativos. Design tokens
4
+ próprios (cores, raios, densidade, tema claro/escuro), CSS puro e sem dependência
5
+ de Tailwind.
6
+
7
+ ## Instalação
8
+
9
+ ```bash
10
+ npm i @celke/kole-react
11
+ ```
12
+
13
+ Requisitos: React 18.2+ ou 19. A fonte Inter já vem dentro do pacote (o
14
+ `estilos.css` carrega só os alfabetos que a página usa). O pacote é só ESM, traz
15
+ os tipos TypeScript e já vem marcado com `'use client'`, então funciona no App
16
+ Router do Next.js.
17
+
18
+ ## Uso
19
+
20
+ ```tsx
21
+ // main.tsx
22
+ import { createRoot } from 'react-dom/client';
23
+ import '@celke/kole-react/estilos.css';
24
+ import { ProvedorUi } from '@celke/kole-react';
25
+ import { App } from './App';
26
+
27
+ createRoot(document.getElementById('root')!).render(
28
+ <ProvedorUi>
29
+ <App />
30
+ </ProvedorUi>,
31
+ );
32
+ ```
33
+
34
+ `ProvedorUi` liga tema/densidade (lembrados no navegador), toasts (`useToast`) e
35
+ confirmação (`useConfirmacao`).
36
+
37
+ ### Tema sem piscar ao abrir
38
+
39
+ O `ProvedorUi` só aplica o tema depois que o React monta, e quem salvou o tema
40
+ escuro vê a página clara piscar por um instante. Para evitar, aplique o tema no
41
+ `<head>`, antes do CSS da página pintar:
42
+
43
+ ```html
44
+ <!-- index.html -->
45
+ <head>
46
+ <script>(function(){var p={};try{p=JSON.parse(localStorage.getItem("lp-preferencias")||"{}")||{}}catch(e){}var t=p.tema||"sistema";var h=document.documentElement;h.setAttribute("data-theme",{"claro":"light","escuro":"dark","sistema":"system"}[t]||"light");var d={"compacta":"density-compact","confortavel":"density-comfortable","espacosa":"density-cozy"}[p.densidade||"confortavel"];if(d)h.classList.add(d)})();</script>
47
+ </head>
48
+ ```
49
+
50
+ Com Content-Security-Policy sem `'unsafe-inline'` em `script-src`, o script
51
+ inline é bloqueado: salve o mesmo conteúdo num arquivo (por exemplo,
52
+ `public/tema.js`) e carregue com `<script src="/tema.js"></script>` no
53
+ `<head>`, sem `type="module"` nem `defer`, para rodar antes da pintura.
54
+
55
+ Esse é o resultado de `scriptTemaInicial()`. Com SSR (Next.js, React Router em
56
+ modo framework), gere pela função, com o mesmo `temaInicial`/`densidadeInicial`
57
+ passado ao `ProvedorUi`:
58
+
59
+ ```tsx
60
+ import { scriptTemaInicial } from '@celke/kole-react';
61
+
62
+ <head>
63
+ <script dangerouslySetInnerHTML={{ __html: scriptTemaInicial({ temaInicial: 'sistema' }) }} />
64
+ </head>
65
+ ```
66
+
67
+ ### Layout com React Router
68
+
69
+ ```tsx
70
+ import { Link, Outlet, useLocation, useNavigate } from 'react-router-dom';
71
+ import { Estrutura } from '@celke/kole-react';
72
+
73
+ export function Layout({ sair }: { sair: () => void }) {
74
+ const { pathname } = useLocation();
75
+ const navigate = useNavigate();
76
+ return (
77
+ <Estrutura
78
+ marca={{ nome: 'Gestor', subtitulo: 'Gestão comercial', logo: '/logo.svg' }}
79
+ nav={[
80
+ { itens: [{ rotulo: 'Painel', icone: 'house', rota: '/' }] },
81
+ {
82
+ rotulo: 'Cadastros',
83
+ itens: [
84
+ { rotulo: 'Pedidos', icone: 'shopping-cart', rota: '/pedidos' },
85
+ { rotulo: 'Tabelas', icone: 'table', filhos: [{ rotulo: 'Categorias', rota: '/categorias' }] },
86
+ ],
87
+ },
88
+ ]}
89
+ rotaAtual={pathname}
90
+ aoNavegar={navigate}
91
+ usuario={{ nome: 'Gabrielly Ribeiro', cargo: 'Gerente comercial' }}
92
+ menuUsuario={[{ id: 'sair', rotulo: 'Sair', icone: 'log-out', destrutivo: true }]}
93
+ aoEscolherMenuUsuario={(id) => id === 'sair' && sair()}
94
+ >
95
+ <Outlet />
96
+ </Estrutura>
97
+ );
98
+ }
99
+ ```
100
+
101
+ Para links de verdade do roteador (ctrl+clique abre em nova aba), passe
102
+ `renderLink={(p) => <Link to={p.href} className={p.className} onClick={p.onClick} aria-current={p['aria-current']}>{p.children}</Link>}`.
103
+
104
+ ### Páginas fora do React no mesmo app (Inertia + Blade)
105
+
106
+ Num app Laravel com páginas Inertia e páginas Blade, o `<Link>` do Inertia só
107
+ serve para as páginas Inertia. Marque as outras com `recarregar: true`: o link
108
+ vira um `<a>` comum (sem `renderLink` nem `aoNavegar`) e abre com recarga
109
+ completa. Vale para o menu, a busca do menu e a trilha. Se a marca aponta para
110
+ uma página Blade, use `marca={{ …, recarregar: true }}`.
111
+
112
+ ```tsx
113
+ import { Link, router, usePage } from '@inertiajs/react';
114
+
115
+ <Estrutura
116
+ nav={[
117
+ {
118
+ itens: [
119
+ { rotulo: 'Painel', icone: 'house', rota: '/painel' }, // Inertia
120
+ { rotulo: 'Relatórios', icone: 'file-text', rota: '/relatorios', recarregar: true }, // Blade
121
+ ],
122
+ },
123
+ ]}
124
+ rotaAtual={usePage().url}
125
+ aoNavegar={(rota) => router.visit(rota)}
126
+ renderLink={(p) => <Link href={p.href} className={p.className} onClick={p.onClick} aria-current={p['aria-current']}>{p.children}</Link>}
127
+ …
128
+ />
129
+ ```
130
+
131
+ Do Blade para o Inertia não precisa de nada: um link comum abre a página
132
+ Inertia. Para as telas Blade com o mesmo layout, veja o pacote Composer
133
+ [`celke/kole-laravel`](https://github.com/celkecursos/kole-laravel).
134
+
135
+ ## Componentes
136
+
137
+ | Grupo | Componentes |
138
+ |---|---|
139
+ | Layout | `Estrutura`, `Busca`, `CabecalhoPagina`, `BoasVindas`, `TelaLogin`, `Abas`/`Aba`, `Card` |
140
+ | Ações | `Botao`, `AcaoLinha`, `Dica` |
141
+ | Formulário | `Form` (página ou modal, `entidade`/`modo`), `FormSecao`, `Campo`, `CampoTexto`, `CampoTextarea`, `CampoSenha`, `CampoSelect`, `CampoSelectMultiplo`, `CampoMarcacao`, `Escolha`, `Picklist`, `Filtros` |
142
+ | Campos prontos | `CampoCpf`, `CampoCnpj`, `CampoCpfCnpj`, `CampoCep`, `CampoTelefone`, `CampoPlaca`, `CampoRenavam`, `CampoChassi`, `CampoCnh`, `CampoImei`, `CampoEmail`, `CampoData`, `CampoHora`, `CampoDataHora`, `CampoMoeda`, `CampoInteiro`, `CampoUf`, `CampoUfMultiplo`, `CampoTipoPessoa` |
143
+ | Busca remota | `CampoBusca`, `CampoCidade`, `useBuscaAssincrona` |
144
+ | Arquivos | `CampoAnexo`, `VisualizadorArquivo`, `DialogoArquivo`, `Foto` |
145
+ | Dados | `Tabela`, `ListaCards`, `Paginacao`, `Indicador`/`Indicadores`, `Detalhes`, `Status`, `Chip`, `Avatar`, `Placa` |
146
+ | Feedback | `Alerta`, `Dialogo` (central ou `lateral`), `useConfirmacao` (+ `.remover()`, `.avisar()`), `useToast`, `Vazio`, `Skeleton`, `Carregando` |
147
+ | Conversa | `Conversa`, `Mensagem`, `CampoMensagem`, `Referencias` |
148
+
149
+ ### Conversa (chat)
150
+
151
+ `Conversa` é a área rolável (acompanha o fim durante o streaming e para de
152
+ puxar se a pessoa rolar para cima); `Mensagem` é a bolha; `CampoMensagem` é o
153
+ campo de envio (Enter envia, Shift+Enter quebra a linha); `Referencias` lista
154
+ as fontes de uma resposta. A conversa ocupa a altura do contêiner pai, e a
155
+ busca da resposta (rede, streaming, Markdown) fica com o app.
156
+
157
+ ```tsx
158
+ import { useState } from 'react';
159
+ import {
160
+ CampoMensagem,
161
+ Conversa,
162
+ Mensagem,
163
+ Referencias,
164
+ type AutorMensagem,
165
+ type EstadoMensagem,
166
+ type ItemReferencia,
167
+ } from '@celke/kole-react';
168
+
169
+ interface ItemChat {
170
+ id: string;
171
+ autor: AutorMensagem;
172
+ estado: EstadoMensagem;
173
+ texto: string;
174
+ hora: Date;
175
+ fontes?: ItemReferencia[]; // { id, titulo, detalhe?, trecho?, href? }
176
+ }
177
+
178
+ interface ChatProps {
179
+ mensagens: ItemChat[];
180
+ gerando: boolean;
181
+ enviar: (texto: string) => void;
182
+ parar: () => void;
183
+ }
184
+
185
+ export function Chat({ mensagens, gerando, enviar, parar }: ChatProps) {
186
+ const [texto, setTexto] = useState('');
187
+ return (
188
+ <div style={{ height: '32rem' }}>
189
+ <Conversa
190
+ campo={
191
+ <CampoMensagem
192
+ valor={texto}
193
+ aoMudar={setTexto}
194
+ aoEnviar={(t) => {
195
+ enviar(t);
196
+ setTexto('');
197
+ }}
198
+ gerando={gerando}
199
+ aoParar={parar}
200
+ />
201
+ }
202
+ >
203
+ {mensagens.map((m) => (
204
+ <Mensagem
205
+ key={m.id}
206
+ autor={m.autor} // 'usuario' | 'assistente' | 'sistema'
207
+ estado={m.estado} // 'enviando' | 'gerando' | 'concluida' | 'erro'
208
+ hora={m.hora}
209
+ copiavel={m.autor === 'assistente'}
210
+ rodape={m.fontes && <Referencias itens={m.fontes} />}
211
+ >
212
+ {m.texto}
213
+ </Mensagem>
214
+ ))}
215
+ </Conversa>
216
+ </div>
217
+ );
218
+ }
219
+ ```
220
+
221
+ Utilitários (lógica pura, também exportados): validadores BR (`isCpf`, `isCnpj`,
222
+ `isCnh`, `isImei`, `validar(tipo, valor)`…), `TIPOS_CAMPO` (máscara +
223
+ placeholder + regra por tipo), `ESTADOS`/`TIPOS_PESSOA`, por extenso
224
+ (`numeroPorExtenso`, `valorMonetarioPorExtenso`, `listaPorExtenso`), texto
225
+ (`normalizar`, `nomeProprio`, `nomeCurto`, `iniciais`, `formatCpfCnpj`), datas
226
+ pt-BR (`parseDataBr`, `formatDataBr`…), `tituloDeEntidade`/`nomeDeArquivo`,
227
+ anexos (`formatBytes`, `tipoDeArquivo`, `iconeArquivo`), senha
228
+ (`validarSenha`, `forcaSenha`), picklist, JWT (`decodificarJwt`, `jwtExpirado`…)
229
+ e `severidadeCor`. A demo do repositório tem uma página interativa de cada um
230
+ (`#/utilitarios`).
231
+
232
+ Convenções:
233
+
234
+ - Campos são controlados por `valor` + `aoMudar`; aceitam `rotulo`, `dica`,
235
+ `erro`, `aviso`, `obrigatorio` e `variante="inline"` (pílula com rótulo dentro,
236
+ para barras de filtro).
237
+ - Severidades: `ok`, `info`, `warn`, `err`, `neutral` (botão: `pri`, `secundario`,
238
+ `ok`, `warn`, `err`).
239
+ - Ícones: [Lucide](https://lucide.dev/icons) (SVG, já incluso no pacote). Passe o
240
+ nome (`icone="save"`, `icone="trash-2"`) ou o componente
241
+ (`import { Rocket } from 'lucide-react'` → `icone={<Rocket />}`). Só os ícones
242
+ registrados entram no bundle; para usar outro pelo nome, registre uma vez:
243
+ `registrarIcones({ rocket: Rocket })`. Um nome não registrado avisa no console
244
+ em desenvolvimento.
245
+ - Pendência de campo: o erro aparece ao **sair** do campo depois de digitar, ou
246
+ quando o `Form` tenta salvar (todos os campos acusam). Um valor carregado de
247
+ fora que não atende ao formato não é recusado: vira aviso âmbar.
248
+ - Grade do `FormSecao`: 4 colunas na página, 3 no modal; `className="lp-col-2"`,
249
+ `lp-col-3` ou `lp-col-full` alarga o campo.
250
+ - Cadastro com vários formulários: passe `menu` (itens com `id`, `rotulo`,
251
+ `icone`, `href`) e `menuAtivo` ao `Form` de cada página; o menu lateral liga
252
+ os formulários entre si, cada um com o próprio Salvar.
253
+
254
+ ## Tema e tokens
255
+
256
+ Toda cor/medida vem de variáveis CSS (os tokens). Para mudar a marca, redefina
257
+ os tokens no CSS do app (a ordem dos imports não importa, veja [CSS](#css)) — por exemplo
258
+ `--navy` (marinho da sidebar), `--pri` (azul de ação) e `--acento-claro` (laranja
259
+ do item ativo). O tema escuro tem valores próprios, então redefina lá também:
260
+
261
+ ```css
262
+ :root {
263
+ --pri: #0f766e;
264
+ --pri-ink: #115e59;
265
+ }
266
+ [data-theme='dark'] {
267
+ --pri: #2dd4bf;
268
+ --pri-ink: #5eead4;
269
+ }
270
+ ```
271
+
272
+ O tema vem do atributo `data-theme` no `<html>`: `light`, `dark` ou `system`
273
+ (segue o modo do sistema operacional, inclusive se ele mudar com a página
274
+ aberta). No `ProvedorUi`, são os temas `claro`, `escuro` e `sistema`
275
+ (`temaInicial`, `definirTema`). Enquanto a pessoa não escolhe, vale o
276
+ `temaInicial`, e sem ele o `sistema`. `escuro` no `usePreferencias()` diz o que
277
+ está na tela. A densidade usa as classes `density-compact`, `density-comfortable` e
278
+ `density-cozy` no `<body>`. O `ProvedorUi` cuida de tudo isso. A lista
279
+ completa de tokens, com os valores dos dois temas, está em
280
+ `@celke/kole-react/tokens.css`.
281
+
282
+ Para usar só os tokens fora do React: `@import '@celke/kole-react/tokens.css';`
283
+ e `<html data-theme="system">` (ou `light`/`dark`) para escolher o tema sem JS.
284
+
285
+ ## CSS
286
+
287
+ Classes CSS usam o prefixo `lp-`, e todo o CSS da biblioteca fica na camada
288
+ `@layer kole`. CSS fora de camada sempre vence CSS em camada, então o CSS do
289
+ app personaliza o kole sem disputar especificidade nem depender da ordem dos
290
+ imports. O lado oposto: uma regra global do app (`a { color: … }`,
291
+ `h1 { font-size: … }`) também atinge os componentes, por isso escope as regras
292
+ de elemento do app (por exemplo, `.conteudo-artigo h1`).
293
+
294
+ ### Com Tailwind 4
295
+
296
+ A ordem das camadas precisa ser declarada **antes** de qualquer CSS, então o
297
+ CSS do app (com o Tailwind) é importado antes do `estilos.css`:
298
+
299
+ ```css
300
+ /* app.css — esta linha vem antes do @import do Tailwind */
301
+ @layer theme, base, kole, components, utilities;
302
+ @import 'tailwindcss';
303
+ @import '@celke/kole-react/tailwind.css'; /* opcional: a ponte abaixo */
304
+ ```
305
+
306
+ ```tsx
307
+ // main.tsx
308
+ import './app.css';
309
+ import '@celke/kole-react/estilos.css';
310
+ ```
311
+
312
+ Assim o kole vence o preflight do Tailwind (botões e campos mantêm o estilo) e
313
+ os utilitários vencem o kole (`<Botao className="mt-4" />` funciona). Se o
314
+ `estilos.css` vier primeiro, a camada `kole` fica abaixo do preflight e os
315
+ componentes perdem o estilo.
316
+
317
+ A ponte `@celke/kole-react/tailwind.css` faz duas coisas:
318
+
319
+ - o `dark:` do Tailwind segue o tema do kole (`data-theme`), e não o do sistema
320
+ operacional, então uma tela com os dois não fica metade clara e metade escura;
321
+ - os tokens viram utilitários com o mesmo nome: `bg-surface`, `text-ink`,
322
+ `text-t3`, `border-border`, `bg-pri`, `text-ok-fg`, `bg-err-bg`,
323
+ `rounded-card`, `rounded-pill`… Como apontam para os tokens, trocam de tema
324
+ junto com o kole. `font-sans` e `font-mono` passam a ser as fontes do kole.
325
+
326
+ A densidade não chega aos utilitários: `p-4` e `h-10` são fixos, só os
327
+ componentes `lp-*` mudam com ela.
328
+
329
+ ## Desenvolvimento
330
+
331
+ ```bash
332
+ npm install
333
+ npm run dev # http://localhost:5173 — demo com todos os componentes
334
+ npm run typecheck
335
+ npm run build # dist/index.js + tipos (.d.ts) + dist/estilos.css + dist/tokens.css + dist/tailwind.css
336
+ ```
337
+
338
+ A demo usa o mesmo CSS do pacote (na camada `kole`, com o tema `sistema`), e o
339
+ `demo/demo.css` fica fora da camada, como o CSS de um app.
340
+
341
+ ### Teste visual
342
+
343
+ Captura cada página do menu da demo (`demo/nav.ts`) nos temas claro e escuro e
344
+ compara pixel a pixel com uma referência. Também confere que o tema `sistema`,
345
+ com o sistema operacional no escuro, sai igual ao tema escuro. Página nova no
346
+ menu entra no teste sozinha.
347
+
348
+ O print muda de um sistema operacional para outro, então a referência fica em
349
+ `tests/visual/__referencia__/<sistema>/`. Só a de Linux vai para o git: é a que
350
+ o CI usa (`.github/workflows/visual.yml`, na imagem Docker do Playwright), em
351
+ todo PR e na `main`.
352
+
353
+ **Mudança visual de propósito:** o CI do PR vai falhar apontando as páginas que
354
+ mudaram (o relatório com as diferenças fica nos artefatos do workflow). Confira
355
+ e grave a referência nova: Actions → Teste visual → Run workflow, na branch do
356
+ PR, com "atualizar" marcado. O workflow faz o commit da referência na branch.
357
+
358
+ No Windows ou no macOS, o teste usa uma referência local, fora do git:
359
+
360
+ ```bash
361
+ npx playwright install chromium # uma vez
362
+ npm run visual:referencia # ANTES de mexer no CSS: grava a referência
363
+ npm run visual # depois: aponta cada página que mudou
364
+ npx playwright show-report # diferenças lado a lado
365
+ ```
366
+
367
+ Para comparar com uma versão já publicada, sirva a demo dela noutra porta (por
368
+ exemplo, num `git worktree` da tag) e gere a referência com
369
+ `KOLE_URL=http://localhost:5181 npm run visual:referencia`.
370
+
371
+ Para testar uma versão que ainda não está no npm, instale direto do GitHub
372
+ (o `prepare` gera o `dist/` na instalação) ou de um pacote local:
373
+
374
+ ```bash
375
+ npm i github:celkecursos/kole-react
376
+ # ou: gere o .tgz na pasta da biblioteca e instale no app
377
+ npm pack # → celke-kole-react-<versão>.tgz
378
+ npm i ../kole-react/celke-kole-react-<versão>.tgz
379
+ ```
380
+
381
+ Evite `npm i ../kole-react` (pasta): o npm cria um link e o bundler
382
+ pega o React do `node_modules` da biblioteca — dois Reacts no app quebram os hooks
383
+ (_Invalid hook call_). Se precisar do link durante o desenvolvimento, use
384
+ `resolve: { dedupe: ['react', 'react-dom'] }` no `vite.config` do app.
385
+
386
+ Publicar uma versão nova: `npm version patch` (só correção) ou `npm version minor`
387
+ (muda a aparência ou a API — antes da 1.0, o `^0.x` dos apps não pega a minor
388
+ sozinho), registre no [CHANGELOG](CHANGELOG.md) e confira o conteúdo com
389
+ `npm pack --dry-run`. Depois do merge na `main`, publique pelo GitHub: Actions →
390
+ Publicar → Run workflow (`.github/workflows/publish.yml`). O npm confia nesse
391
+ workflow pela publicação confiável (Trusted Publisher, sem token nem segundo
392
+ fator) e o pacote sai com o atestado de procedência. O workflow recusa versão
393
+ que já está no npm.
394
+
395
+ ## Autor
396
+
397
+ Criado por **Cesar Szpak**.
398
+
399
+ ## Licença
400
+
401
+ MIT © 2026 Celke — veja o arquivo [LICENSE](https://github.com/celkecursos/kole-react/blob/main/LICENSE).