@actionexec/dashboards 0.12.0 → 0.14.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 +38 -9
- package/dist/{ColorPaletteSelector-DJge9VhO.js → ColorPaletteSelector-CZP3HDNJ.js} +277 -271
- package/dist/ColorPaletteSelector-CZP3HDNJ.js.map +1 -0
- package/dist/Statement.d.ts +15 -0
- package/dist/api/fetcher.d.ts +11 -0
- package/dist/api/params.d.ts +18 -0
- package/dist/hooks/useStatementData.d.ts +13 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +715 -477
- package/dist/index.js.map +1 -1
- package/dist/internals.d.ts +1 -0
- package/dist/internals.js +16 -16
- package/dist/styles.css +1 -1
- package/dist/types/statement.d.ts +86 -0
- package/dist/utils/download.d.ts +9 -0
- package/package.json +1 -1
- package/dist/ColorPaletteSelector-DJge9VhO.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
# @actionexec/dashboards
|
|
2
2
|
|
|
3
|
-
Biblioteca React para consumo de dashboards servidos pela
|
|
4
|
-
Dedicada
|
|
3
|
+
Biblioteca React para consumo de dashboards e demonstrativos servidos pela
|
|
4
|
+
plataforma Action. Dedicada as APIs `/external/dashboards` e
|
|
5
|
+
`/external/statements` — zero configuracao, so passe o token.
|
|
5
6
|
|
|
6
7
|
## Instalacao
|
|
7
8
|
|
|
@@ -14,29 +15,57 @@ Peer deps: `react`, `react-dom`, `recharts`, `react-datepicker`.
|
|
|
14
15
|
## Uso
|
|
15
16
|
|
|
16
17
|
```tsx
|
|
17
|
-
import { Dashboard } from '@actionexec/dashboards';
|
|
18
|
+
import { Dashboard, Statement } from '@actionexec/dashboards';
|
|
18
19
|
import '@actionexec/dashboards/styles.css';
|
|
19
20
|
|
|
20
21
|
export function App() {
|
|
21
|
-
return
|
|
22
|
+
return (
|
|
23
|
+
<>
|
|
24
|
+
<Dashboard token="token-do-dashboard" />
|
|
25
|
+
<Statement token="token-do-demonstrativo" />
|
|
26
|
+
</>
|
|
27
|
+
);
|
|
22
28
|
}
|
|
23
29
|
```
|
|
24
30
|
|
|
31
|
+
Cada token responde por um recurso: o do dashboard nao abre um demonstrativo e
|
|
32
|
+
vice-versa.
|
|
33
|
+
|
|
25
34
|
## API publica
|
|
26
35
|
|
|
27
36
|
### `<Dashboard>`
|
|
28
37
|
|
|
29
|
-
|
|
38
|
+
Renderiza um dashboard completo com interatividade (filtros, variaveis, paleta).
|
|
30
39
|
|
|
31
40
|
| Prop | Tipo | Default | Descricao |
|
|
32
41
|
|---|---|---|---|
|
|
33
42
|
| `token` | `string` | — | Token Bearer do dashboard (obrigatorio) |
|
|
34
|
-
| `
|
|
35
|
-
| `
|
|
43
|
+
| `cellAspect` | `number` | `1` | Proporcao largura/altura da celula do grid |
|
|
44
|
+
| `stackBelow` | `number \| 'auto'` | — | Largura (px) abaixo da qual os widgets empilham em coluna unica; `'auto'` usa o limiar natural do layout; ausente nunca empilha |
|
|
45
|
+
| `onGeometryChange` | `(g: DashboardGeometry) => void` | — | Notificado a cada mudanca de medida — util para hosts de altura fixa |
|
|
46
|
+
| `silenceWarnings` | `boolean` | `false` | Desliga o aviso de corte emitido no console |
|
|
47
|
+
| `className` | `string` | — | Classe CSS adicional no container raiz |
|
|
48
|
+
|
|
49
|
+
### `<Statement>`
|
|
50
|
+
|
|
51
|
+
Renderiza um demonstrativo completo — linhas x colunas de periodo, com janela de
|
|
52
|
+
datas ajustavel e download em PDF.
|
|
53
|
+
|
|
54
|
+
| Prop | Tipo | Default | Descricao |
|
|
55
|
+
|---|---|---|---|
|
|
56
|
+
| `token` | `string` | — | Token Bearer do demonstrativo (obrigatorio) |
|
|
57
|
+
| `palette` | `string[]` | paleta Action | Paleta de 15 cores, no formato do dashboard — para quem embute os dois lado a lado |
|
|
58
|
+
| `showDownload` | `boolean` | `true` | Exibe o botao de download do PDF |
|
|
36
59
|
| `className` | `string` | — | Classe CSS adicional no container raiz |
|
|
37
60
|
|
|
61
|
+
Todos os valores sao computados no servidor: o componente nao agrega, nao
|
|
62
|
+
formata numero e nao avalia formula. E o que garante que o documento exibido aqui
|
|
63
|
+
seja identico ao do construtor da plataforma e ao PDF baixado.
|
|
64
|
+
|
|
65
|
+
A altura do documento acompanha o numero de linhas; a largura rola na horizontal
|
|
66
|
+
quando ha mais colunas de periodo do que cabem.
|
|
67
|
+
|
|
38
68
|
### `ApiError`
|
|
39
69
|
|
|
40
70
|
Erro lancado internamente quando a API retorna status != 2xx. Exposto para quem
|
|
41
|
-
quiser fazer error boundary customizada em torno
|
|
42
|
-
|
|
71
|
+
quiser fazer error boundary customizada em torno dos componentes.
|