@massimo-cassandro/minimo 1.41.5 → 1.41.7

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.
@@ -1,730 +1,6 @@
1
1
  # `<json-table>` – datatable da JSON
2
2
 
3
- **json-table** costruisce una tabella HTML da un array di dati JSON (inline o caricato via fetch), a partire da una definizione delle colonne (`cols`) e da un insieme di tipi di dato predefiniti ed estendibili, con ordinamento, ricerca e paginazione (lato client oppure, con `serverSide: true`, delegati al server). È un web component light DOM senza dipendenze esterne: può quindi essere stilizzato direttamente dal CSS del progetto in cui è utilizzato.
3
+ **json-table** costruisce una tabella HTML da un array di dati JSON (inline o caricato via fetch), a partire da una definizione delle colonne (`cols`) e da un insieme di tipi di dato predefiniti ed estendibili, con ordinamento, ricerca e paginazione (lato client oppure, con `serverSide: true`, delegati al server). È un web component light DOM senza dipendenze esterne: può quindi essere personalizzato direttamente dal CSS del progetto in cui è utilizzato.
4
4
 
5
- ## Installazione
6
-
7
- È sufficiente importare il file del componente (registra il custom element):
8
-
9
- ```javascript
10
- // solo registrazione del tag
11
- import '@massimo-cassandro/minimo/json-table';
12
-
13
- // oppure, se necessario eseguire metodi della classe (es. `setDefaults`):
14
- import { JsonTable } from '@massimo-cassandro/minimo/json-table';
15
- ```
16
-
17
- Il CSS (`json-table-component.module.css`) è importato dal componente stesso; le custom
18
- properties `--jt-*` sono definite in `json-table.minimo.tokens.mjs` e compilate in
19
- `custom-properties.css` da `build-tokens`. Le icone di default (booleani, ordinamento e
20
- paginazione) sono SVG di minimo importati con il suffisso `?inline` (gestito dalla configurazione
21
- webpack dello starter-kit).
22
-
23
- ### Tipi per gli script consumer
24
-
25
- Il file `types/global.d.ts` di minimo dichiara il tipo globale `JsonTable` e registra il tag `json-table` in `HTMLElementTagNameMap`: aggiungendolo all'`include` del proprio `jsconfig.json`/`tsconfig.json` (`"node_modules/@massimo-cassandro/minimo/types/global.d.ts"`) si ottiene il completamento dei metodi senza cast né import di tipo:
26
-
27
- ```javascript
28
- const el = document.querySelector('json-table'); // → JsonTable
29
- el.init({ ... });
30
-
31
- /** @type {JsonTable} */
32
- const other = document.createElement('json-table');
33
- ```
34
-
35
- ## Utilizzo da markup
36
-
37
- ```html
38
- <json-table
39
- jsonurl="/api/rows.json"
40
- caption="Utenti"
41
- perpage="10"
42
- cols='[
43
- { "key": "id", "dataType": "id" },
44
- { "key": "name", "title": "Nome", "render": "<a href=\"/users/[[id]]\">[[name]]</a>" },
45
- { "key": "amount", "title": "Importo", "dataType": "euro", "tfootRender": "@sum" },
46
- { "key": "active", "title": "Attivo", "dataType": "bool" }
47
- ]'
48
- tfoot="true"
49
- serverSide="true"
50
- ></json-table>
51
-
52
- <!-- dati inline (JSON serializzato) al posto di jsonurl -->
53
- <json-table
54
- data='[{"name":"Mario","city":"Roma"}, ...]'
55
- cols='[{ "key": "name", "title": "Nome" }, { "key": "city", "title": "Città" }]'
56
- search="false"
57
- ></json-table>
58
- ```
59
-
60
- I nomi degli attributi sono case-insensitive (`jsonurl` e `jsonUrl` sono equivalenti).
61
- Gli attributi booleani accettano i formati HTML idiomatici: `search` (presente senza valore),
62
- `search="true"`, `search="1"` → true; `search="false"`, `search="0"` → false. Gli attributi
63
- numerici (`perpage`, `paginationdelta`, `searchdebounce`) vengono convertiti in numero.
64
- I valori che iniziano con `[` o `{` vengono interpretati come JSON (un JSON malformato viene
65
- segnalato in console e ignorato).
66
-
67
- Da attributo non è possibile passare funzioni: per il rendering delle celle è disponibile la
68
- sintassi mustache-like `[[key]]` (vedi [`render`](#render)), per il footer gli aggregati
69
- predefiniti (`"@sum"`, ...).
70
-
71
- ## Utilizzo da script
72
-
73
- ```javascript
74
- const el = document.querySelector('json-table');
75
- // oppure: const el = document.createElement('json-table');
76
-
77
- el.init({
78
- jsonUrl: '/api/rows.json',
79
- caption: 'Utenti',
80
- cols: [
81
- { key: 'id', dataType: 'id' },
82
- { key: 'name', title: 'Nome', render: row => `<a href="/users/${row.id}">${row.name}</a>` },
83
- { key: 'amount', title: 'Importo', dataType: 'euro', tfootRender: '@sum' },
84
- { key: 'active', title: 'Attivo', dataType: 'bool' }
85
- ],
86
- tfoot: true
87
- });
88
-
89
- // dati inline al posto di jsonUrl (se presenti entrambi, `data` prevale)
90
- el.init({
91
- data: [{ name: 'Mario', city: 'Roma' }, ...],
92
- cols: [...]
93
- });
94
-
95
- // se appena creato, appendere dopo init():
96
- document.body.appendChild(el);
97
- ```
98
-
99
- ### Con `domBuilder`
100
-
101
- ```javascript
102
- domBuilder([
103
- {
104
- tag: 'json-table',
105
- attrs: { caption: 'Utenti' },
106
- callback: el => el.init({ jsonUrl: '/api/rows.json', cols: [...] })
107
- }
108
- ], container);
109
- ```
110
-
111
- ## Utilizzo misto – attributi HTML + script
112
-
113
- I parametri non inclusi in `init()` vengono letti dall'attributo HTML corrispondente:
114
-
115
- ```html
116
- <json-table caption="Utenti" search="false" cols='[...]'></json-table>
117
- ```
118
-
119
- ```javascript
120
- el.init({ jsonUrl: '/api/rows.json' }); // jsonUrl da script, caption, search e cols da attributo
121
- ```
122
-
123
- **Ordine di precedenza:** `init()` > attributo HTML > `JsonTable.setDefaults()` > default interno.
124
-
125
- Per ignorare esplicitamente un attributo e utilizzare il valore di default, utilizzare `null` nel config:
126
-
127
- ```javascript
128
- el.init({ jsonUrl: '/api/rows.json', search: null }); // search == default (true)
129
- ```
130
-
131
- I parametri oggetto `classes`, `labels`, `dataTypes` e `serverParams` vengono **uniti** ai default
132
- (merge a un livello), quindi ogni sorgente deve indicare solo le chiavi da sovrascrivere:
133
-
134
- ```javascript
135
- el.init({ classes: { table: 'table' } }); // le altre classi restano quelle di default
136
- ```
137
-
138
- ## Default di progetto – `JsonTable.setDefaults()`
139
-
140
- Imposta valori validi per tutte le istanze create successivamente, evitando di ripetere gli
141
- stessi parametri. Da invocare una sola volta, in uno script condiviso eseguito prima degli altri.
142
- I valori vengono uniti a quelli impostati in chiamate precedenti.
143
-
144
- ```javascript
145
- import { JsonTable } from '.../json-table-component.js';
146
-
147
- JsonTable.setDefaults({
148
- perPage: 50,
149
- classes: { searchInput: 'form-control', table: 'table' },
150
- labels: { searchPlaceholder: 'Cerca…', noRows: 'Nessun elemento' },
151
- infoText: (start, end, totRec, filteredRec) => `${filteredRec} di ${totRec} record`
152
- });
153
-
154
- JsonTable.getDefaults(); // default interni + default di progetto
155
- JsonTable.resetDefaults(); // azzera i default di progetto
156
- ```
157
-
158
- ## API dell'istanza
159
-
160
- | Metodo | Descrizione |
161
- |---|---|
162
- | `init(config)` | Avvia il componente (prima o dopo l'inserimento nel DOM) |
163
- | `reload(overrides)` | Ricarica i dati e ricostruisce la struttura, con eventuali parametri sovrascritti (`Promise`); ricerca, ordinamento e pagina vengono azzerati |
164
- | `destroy()` | Svuota il componente; `init()` può essere richiamato in seguito |
165
- | `goToPage(page)` | Mostra la pagina indicata (limitata all'intervallo disponibile) |
166
- | `setSort(key, dir)` | Ordina per la colonna `key` (`'asc'`, `'desc'`, oppure `null` per rimuovere l'ordinamento) e torna alla prima pagina |
167
- | `setSearch(term)` | Filtra le righe con il termine indicato (stringa vuota = nessun filtro) e torna alla prima pagina; l'input di ricerca viene aggiornato |
168
-
169
- In modalità server-side `goToPage`, `setSort` e `setSearch` generano una nuova richiesta.
170
-
171
- Proprietà disponibili dopo il caricamento:
172
-
173
- | Proprietà | Descrizione |
174
- |---|---|
175
- | `params` | parametri risolti |
176
- | `data` | righe grezze (array di oggetti; in modalità server-side solo quelle della pagina corrente) |
177
- | `cols` | colonne dopo il parsing (solo quelle visibili, con classi e tipo di dato risolti) |
178
- | `dataTypes` | mappa dei tipi di dato (predefiniti + personalizzati) |
179
- | `state` | stato del rendering: `totRec`, `filteredRec`, `rows`, `filtered`, `pageRows`, `searchTerm`, `sort` (`{ key, dir }` o `null`), `page`, `totPages` |
180
- | `elements` | elementi generati: `wrapper`, `infoOuter`, `info`, `resultInfo`, `searchInput`, `tableWrapper`, `table`, `thead`, `tbody`, `tfoot`, `tableFooter`, `caption`, `pagination` |
181
-
182
- ```javascript
183
- await el.reload({ jsonUrl: '/api/rows.json?anno=2025' });
184
- await el.reload({ data: [...] });
185
- el.setSort('name', 'desc');
186
- el.goToPage(3);
187
- ```
188
-
189
- ## Eventi
190
-
191
- Entrambi vengono emessi sull'elemento con `bubbles: true`; `event.detail.jsonTable` è l'istanza.
192
-
193
- | Evento | Quando | `event.detail` |
194
- |---|---|---|
195
- | `jt:ready` | al termine della costruzione e del primo rendering (nel microtask successivo, quindi un listener registrato subito dopo `init()` lo intercetta comunque) | `{ jsonTable }` |
196
- | `jt:update` | dopo ogni cambio pagina, ordinamento o ricerca (anche via API) | `{ jsonTable, reason }` con `reason` = `'page'`, `'sort'` o `'search'` |
197
-
198
- ```javascript
199
- el.addEventListener('jt:ready', e => console.log(e.detail.jsonTable.data));
200
- el.addEventListener('jt:update', e => console.log(e.detail.reason, e.detail.jsonTable.state.page));
201
- el.init({ jsonUrl: '/api/rows.json', cols: [...] });
202
- ```
203
-
204
- ## Parametri
205
-
206
- Tutti i parametri sono impostabili sia da attributo HTML che come oggetto in `init({...})`. I valori di tipo funzione solo da `init()`.
207
-
208
- | Parametro | Tipo / default | Descrizione |
209
- |---|---|---|
210
- | `debug` | boolean (`false`) | Log in console di parametri, colonne, dati, stato ed elementi generati |
211
- | `jsonUrl` | string (`null`) | URL del JSON da caricare. Ignorato se `data` è presente |
212
- | `jqDatatableMode` | boolean (`false`) | Se `true` imposta come default i valori compatibili con il formato server-side di jQuery DataTables: `jsonDataField: 'data'`, `totRecField: 'recordsTotal'`, `filteredRecField: 'recordsFiltered'`, `serverSide: true` e i `serverParams` indicati in "Modalità jQuery DataTables". Ogni valore resta sovrascrivibile |
213
- | `jsonDataField` | string o null (`'data'`) | Chiave del JSON che contiene l'array delle righe (es. `'data'` per `{ data: [...] }`); `null` o `''` = la root del JSON è l'array stesso |
214
- | `totRecField` | string (`'totRec'`) | Chiave del JSON con il totale dei record (numerico); se assente o non numerico il totale è la lunghezza dell'array |
215
- | `filteredRecField` | string (`'filteredRec'`) | Solo server-side: chiave del JSON con il numero di record che soddisfano la ricerca corrente; se assente vale `totRecField` |
216
- | `data` | Array&lt;Object&gt; (`null`) | Righe inline; prevale su `jsonUrl`. Da attributo va passato come stringa JSON ed è sempre inteso come array delle righe (`jsonDataField` ignorato) |
217
- | `cols` | ColDefinition[] | **OBBLIGATORIO**: definizione delle colonne (vedi sotto). Se assente o vuoto viene segnalato un errore in console e la tabella non viene generata |
218
- | `dataTypes` | Object (`{}`) | Tipi di dato personalizzati, uniti a quelli predefiniti (vedi sotto) |
219
- | `caption` | string o Function (`null`) | Caption della tabella (testo o HTML), oppure funzione che restituisce stringa o Node. Mostrata sotto la tabella (vedi "Caption e paginazione") |
220
- | `search` | boolean (`true`) | Genera l'input di ricerca |
221
- | `searchDebounce` | number (`300`) | Millisecondi di attesa dopo l'ultimo tasto prima di eseguire la ricerca |
222
- | `perPage` | number (`25`) | Righe per pagina; `0` = nessuna paginazione (tutte le righe, nessuna navigazione) |
223
- | `paginationDelta` | number (`2`) | Pulsanti pagina mostrati a ciascun lato della pagina corrente |
224
- | `serverSide` | boolean (`false`) | Paginazione, ordinamento e ricerca delegati al server (vedi "Modalità server-side"). Richiede `jsonUrl` |
225
- | `serverParams` | Object | Nomi dei parametri di query string in modalità server-side, uniti ai default (vedi sotto) |
226
- | `initialSort` | { key, dir } o null (`null`) | Ordinamento applicato al caricamento, es. `{ key: 'name', dir: 'asc' }` |
227
- | `tfoot` | boolean (`false`) | Genera il tfoot (vedi `tfootRender` delle colonne). Non disponibile in modalità server-side |
228
- | `updateFooterOnPageChange` | boolean (`false`) | Se `true` `tfootRender` riceve solo i record della pagina corrente (subtotali di pagina) e il footer si aggiorna a ogni cambio pagina; se `false` riceve l'intero set filtrato e si aggiorna solo al cambio filtro |
229
- | `infoText` | string, Function o null (`null`) | Contenuto dell'area info: stringa mustache-like con i segnaposto `{start}`, `{end}`, `{totRec}`, `{filteredRec}`, `{page}`, `{totPages}`, oppure funzione `(start, end, totRec, filteredRec, page, totPages) => string\|Node`. `null` = viene usato `labels.info` |
230
- | `template` | Array (`[{ slot: 'infoSection' }, { slot: 'table' }]`) | Layout del contenitore principale (vedi "Template") |
231
- | `locale` | string (`'it-IT'`) | Locale per numeri, date e confronto stringhe nell'ordinamento |
232
- | `currency` | string (`'EUR'`) | Codice ISO 4217 usato dal tipo `currency` |
233
- | `datesLocaleOpts` | Intl.DateTimeFormatOptions (`{ year: 'numeric', month: 'short', day: 'numeric' }`) | Parte data dei tipi date/datetime |
234
- | `timesLocaleOpts` | Intl.DateTimeFormatOptions (`{ hour12: false, hour: '2-digit', minute: '2-digit' }`) | Parte ora del tipo datetime |
235
- | `numbersLocaleOpts` | Intl.NumberFormatOptions (`{ maximumFractionDigits: 2 }`) | Tipo `num` |
236
- | `currPercLocaleOpts` | Intl.NumberFormatOptions (`{ minimumFractionDigits: 2, maximumFractionDigits: 2 }`) | Tipi currency/euro/perc/percDecimal |
237
- | `renderNullAs` | string o null (`'—'`) | Contenuto per i valori null/undefined |
238
- | `renderZeroAs` | string o null (`null`) | Se non null, contenuto per i valori numerici pari a zero |
239
- | `renderNaNAs` | string o null (`'—'`) | Contenuto per i valori non numerici nei tipi numerici |
240
- | `boolTrueIcon` | icona, vedi nota (icona `check-bold` di minimo (Phosphor)) | Icona per i valori `true` (tipo bool) |
241
- | `boolFalseIcon` | icona, vedi nota (icona `x-bold`) | Icona per i valori `false` |
242
- | `sortAscArrowIcon` | icona, vedi nota (icona `arrow-up`) | Icona del pulsante di ordinamento, ordinamento asc attivo |
243
- | `sortDescArrowIcon` | icona, vedi nota (icona `arrow-down`) | Icona del pulsante di ordinamento, ordinamento desc attivo |
244
- | `sortNoneArrowIcon` | icona, vedi nota (icona `arrows-down-up`) | Icona del pulsante di ordinamento, nessun ordinamento |
245
- | `paginationPrevIcon` | icona, vedi nota (icona `caret-left`) | Icona del pulsante "pagina precedente" |
246
- | `paginationNextIcon` | icona, vedi nota (icona `caret-right`) | Icona del pulsante "pagina successiva" |
247
- | `trCallback` | (tr, row, params) => void (`null`) | Callback invocata dopo il rendering di ogni riga del body |
248
- | `tableId` | string (`null`) | Id del tag `<table>` |
249
- | `classes` | Object | Classi consumer (vedi sotto), unite ai default |
250
- | `labels` | Object | Testi (vedi sotto), uniti ai default |
251
-
252
- **Nota sulle icone**: ogni icona può essere una stringa SVG/HTML (es. import `?inline`), un Node, un oggetto domBuilder o una funzione che restituisce uno di questi valori.
253
-
254
- ### `classes`
255
-
256
- Nomi delle classi assegnate agli elementi generati. Le classi interne di layout (CSS module)
257
- vengono **sempre** applicate in aggiunta a queste; ogni valore sostituisce interamente il
258
- default della stessa chiave.
259
-
260
- ```javascript
261
- classes: {
262
- wrapper: null, // contenitore principale (<section>: info + tabella)
263
- infoOuter: null, // contenitore esterno della sezione info
264
- info: null, // sezione info (testo + ricerca)
265
- resultInfo: null, // contenitore del testo info
266
- search: null, // wrapper dell'input di ricerca
267
- searchInput: 'form-control form-control-sm', // input di ricerca
268
- tableWrapper: 'table-responsive', // div che racchiude la tabella
269
- table: 'table table-bordered', // tag <table>
270
- tableFooter: null, // barra sotto la tabella (caption + paginazione)
271
- caption: null, // contenitore della caption
272
- pagination: null, // <nav> della paginazione
273
- paginationBtn: 'btn-reset', // pulsanti della paginazione
274
- sortBtn: 'btn-reset', // pulsanti di ordinamento nei <th>
275
- empty: null, // cella unica mostrata in assenza di righe
276
- textStart: null, // allineamento inline-start (le celle minimo lo sono già)
277
- textCenter: 'text-center', // allineamento al centro
278
- textEnd: 'text-end', // allineamento inline-end
279
- nowrap: 'text-nowrap', // no-wrap
280
- numeric: 'text-numeric', // cifre tabulari (tipi numerici)
281
- boolCell: null, // classe aggiuntiva per tutte le celle di tipo bool
282
- boolTrue: null, // classe aggiuntiva per le celle bool con valore true
283
- boolFalse: null // classe aggiuntiva per le celle bool con valore false
284
- }
285
- ```
286
-
287
- Le classi di allineamento (`textEnd`, `textCenter`, `nowrap`, `numeric`) sono quelle usate dai
288
- tipi di dato predefiniti: modificandole si cambiano le classi di tutte le colonne di quel tipo.
289
-
290
- ### `labels`
291
-
292
- ```javascript
293
- labels: {
294
- loading: 'Caricamento dati…', // segnaposto di caricamento (visually hidden)
295
- searchPlaceholder: 'Cerca...', // placeholder dell'input di ricerca
296
- searchTitle: 'Cerca nella tabella', // attributo title dell'input
297
- searchAriaLabel: 'Filtra risultati', // aria-label dell'input
298
- info: 'Stai visualizzando le righe da {start} a {end}, su un totale di {filteredRec} record trovati',
299
- // template del testo info (vedi `infoText`)
300
- noRows: 'Nessun record trovato', // testo info e cella unica con set di dati vuoto
301
- noResults: 'Nessun risultato per la ricerca', // idem, con ricerca senza risultati
302
- sortAsc: 'Ordina questa colonna in senso ascendente (A → Z)', // title/aria-label del
303
- sortDesc: 'Ordina questa colonna in senso discendente (Z → A)', // pulsante di ordinamento:
304
- sortNone: 'Rimuovi l’ordinamento a questa colonna', // descrivono l'azione del
305
- // prossimo click
306
- paginationAriaLabel: 'Navigazione pagine', // aria-label del <nav>
307
- prevPage: 'Pagina precedente', // title/aria-label del pulsante precedente
308
- nextPage: 'Pagina successiva', // idem, successivo
309
- pageTitle: 'Vai a pagina {page}', // idem, pulsanti pagina
310
- currentPage: 'Pagina {page}, corrente' // idem, pagina corrente
311
- }
312
- ```
313
-
314
- I segnaposto di `labels.info` / `infoText`:
315
-
316
- | Segnaposto | Valore |
317
- |---|---|
318
- | `{start}` | indice (da 1) del primo record della pagina corrente, nel set filtrato |
319
- | `{end}` | indice dell'ultimo record della pagina corrente |
320
- | `{totRec}` | totale dei record non filtrati (dal JSON, vedi `totRecField`, o lunghezza dei dati) |
321
- | `{filteredRec}` | totale dei record dopo il filtro |
322
- | `{page}` | pagina corrente |
323
- | `{totPages}` | numero di pagine |
324
-
325
- I numeri vengono formattati secondo `locale`.
326
-
327
- ## Colonne – `cols`
328
-
329
- Parametro **obbligatorio**: array di oggetti, uno per colonna:
330
-
331
- ```javascript
332
- cols: [
333
- {
334
- key, // string – OBBLIGATORIO: chiave dell'oggetto riga (ammessa la notazione con
335
- // punto per valori annidati, es. 'owner.name')
336
- title, // contenuto del <th>: testo, HTML, Node, array domBuilder o funzione.
337
- // Nelle colonne ordinabili è il testo del pulsante. Default: la chiave
338
- dataType, // string – tipo di dato, una delle chiavi di `dataTypes`; `type` è un alias
339
- // equivalente. Default: 'string'
340
- render, // (row, tr, td) => contenuto | stringa mustache-like – vedi sotto. Default: null
341
- tfootRender, // (rows, td) => contenuto | aggregato '@…' | stringa statica – contenuto della
342
- // cella del tfoot (solo se `tfoot` è true). null = cella vuota. Default: null
343
- rowHeading, // boolean – se true la cella è un'intestazione di riga (th[scope=row]).
344
- // Default: false
345
- searchable, // boolean – abilita la ricerca sulla colonna. Default: true
346
- sortable, // boolean – abilita l'ordinamento sulla colonna. Default: true
347
- sortValue, // valore | row => valore – valore usato per l'ordinamento; prevale su quello
348
- // del tipo di dato. Default: non impostato (tipo di dato / valore grezzo)
349
- searchValue, // idem, per la ricerca. Default: non impostato
350
- condition, // boolean | params => boolean – se false la colonna non viene renderizzata.
351
- // Default: true
352
- headerClass, // string – classi del <th>, in sostituzione di quelle del tipo di dato
353
- cellClass // string – classi delle celle body/tfoot, in sostituzione di quelle del tipo.
354
- // Se solo una tra `headerClass` e `cellClass` è presente, l'altra assume lo
355
- // stesso valore. Default: null (classi del tipo di dato)
356
- },
357
- ...
358
- ]
359
- ```
360
-
361
- ### `render`
362
-
363
- Funzione con argomenti posizionali, tutti facoltativi:
364
-
365
- ```javascript
366
- render: (row, tr, td) => contenuto
367
- ```
368
-
369
- - `row` – l'oggetto dati della riga
370
- - `tr` – l'elemento `<tr>` della riga
371
- - `td` – l'elemento della cella (`<td>` o `<th scope="row">`)
372
-
373
- Il valore restituito è il contenuto della cella: testo, stringa HTML, numero, Node o array
374
- domBuilder. Casi particolari:
375
-
376
- - `undefined` (nessun `return`): la cella viene renderizzata dal tipo di dato, come se `render`
377
- non fosse definito. Utile per decorare soltanto `td`/`tr` (classi, attributi, `title`):
378
-
379
- ```javascript
380
- render: (row, tr, td) => { if (row.amount < 0) td.classList.add('text-danger'); }
381
- ```
382
-
383
- - `null`: viene mostrato `renderNullAs`
384
-
385
- Da attributo HTML (o da script, per i casi semplici) `render` può essere una stringa
386
- mustache-like: ogni segnaposto `[[key]]` viene sostituito con il valore corrispondente della
387
- riga (chiavi annidate ammesse; i valori null diventano `renderNullAs`):
388
-
389
- ```javascript
390
- render: '<a href="/users/[[id]]">[[owner.name]]</a>'
391
- ```
392
-
393
- Le stringhe HTML vengono inserite tramite la Sanitizer API (`Element.setHTML`, dove supportata):
394
- script, attributi handler di eventi e URL `javascript:` vengono rimossi, mentre `class`, `id`,
395
- `style` e `data-*` sono conservati.
396
-
397
- ### `tfootRender`
398
-
399
- Con `tfoot: true` ogni colonna produce una cella nel footer, il cui contenuto è dato da
400
- `tfootRender`:
401
-
402
- - funzione `(rows, td) => contenuto`, dove `rows` è l'intero set filtrato (oppure i soli record
403
- della pagina corrente se `updateFooterOnPageChange` è true)
404
- - uno degli aggregati predefiniti (vedi sotto)
405
- - qualsiasi altra stringa: contenuto statico (es. l'etichetta `'Totale'`)
406
- - `null`: cella vuota
407
-
408
- Aggregati predefiniti, calcolati sui valori **numerici** della colonna (i valori non numerici
409
- vengono ignorati) e, tranne `@count`, formattati dal tipo di dato della colonna (es. come valuta
410
- per `euro`, con `%` per `perc`):
411
-
412
- | Aggregato | Valore |
413
- |---|---|
414
- | `'@sum'` | somma |
415
- | `'@avg'` | media aritmetica |
416
- | `'@min'` | minimo |
417
- | `'@max'` | massimo |
418
- | `'@count'` | numero di valori numerici (formattato con `locale`, senza il tipo di dato) |
419
-
420
- Un aggregato non riconosciuto viene segnalato in console e produce una cella vuota. Le celle del
421
- footer ricevono le stesse classi (`cellClass`) delle celle del body.
422
-
423
- Il `tfoot` non è disponibile in modalità server-side (il componente riceve solo la pagina
424
- corrente, gli aggregati sarebbero parziali): se richiesto viene ignorato con un avviso in console.
425
-
426
- ## Tipi di dato – `dataTypes`
427
-
428
- Ogni colonna ha un tipo di dato (`dataType`, default `string`) che ne definisce classi, rendering
429
- e valori di ordinamento/ricerca. Tipi predefiniti:
430
-
431
- | Tipo | Descrizione | Classi delle celle |
432
- |---|---|---|
433
- | `string` | valore così com'è | – |
434
- | `num` | numero formattato con `numbersLocaleOpts` | `textEnd numeric nowrap` |
435
- | `id` | id numerico: valore grezzo, allineato a destra, non ricercabile | `textEnd numeric` |
436
- | `perc` | percentuale in scala 0–100, `currPercLocaleOpts` + `%` | `textEnd numeric nowrap` |
437
- | `percDecimal` | percentuale in scala 0–1 (moltiplicata per 100) | `textEnd numeric nowrap` |
438
- | `currency` | formato valuta `Intl` con `currency` | `textEnd numeric nowrap` |
439
- | `euro` | come `currency`, EUR forzato | `textEnd numeric nowrap` |
440
- | `date` | elemento `<time>`, `datesLocaleOpts`; accetta stringhe ISO, timestamp, `Date` e oggetti data Symfony | `textEnd nowrap` |
441
- | `datetime` | come `date`, con la parte ora (`timesLocaleOpts`): `<time><span class="[nowrap]">data</span> <small>ora</small></time>` | `textEnd nowrap` |
442
- | `bool` | icone `boolTrueIcon`/`boolFalseIcon` (accetta anche `1`/`0`, `'true'`/`'false'`); `null` → `renderNullAs`; non ordinabile né ricercabile | stili interni delle icone |
443
- | `email` | andate a capo facoltative attorno alla `@` | – |
444
-
445
- I tipi numerici applicano `renderNaNAs` ai valori non numerici e `renderZeroAs` (se impostato)
446
- agli zeri. Per tutti i tipi i valori `null`/`undefined` vengono resi come `renderNullAs`.
447
-
448
- ### Tipi personalizzati
449
-
450
- Il parametro `dataTypes` è unito ai tipi predefiniti: una chiave già esistente sovrascrive solo
451
- le proprietà indicate, una chiave nuova può estendere un tipo esistente con `inheritsFrom`.
452
-
453
- ```javascript
454
- dataTypes: {
455
- // modifica solo le classi del tipo predefinito `num`
456
- num: { cellClass: 'text-end fw-bold' },
457
-
458
- // nuovo tipo basato su `num` (stesse classi, ordinamento, ricerca e gestione NaN/zero)
459
- km: {
460
- inheritsFrom: 'num',
461
- render: (value, row, params) => `${value.toLocaleString(params.locale)} km`
462
- }
463
- }
464
- ```
465
-
466
- Proprietà di un tipo di dato (tutte facoltative):
467
-
468
- ```javascript
469
- {
470
- headerClass, // string – classi di default del <th>
471
- cellClass, // string – classi di default delle celle
472
- internalCellClass, // (value, row, params) => string – classi aggiunte sempre alle celle,
473
- // indipendentemente da `cellClass` (usato dal tipo `bool` per le icone)
474
- render, // (value, row, params) => contenuto – non invocato per i valori null
475
- sortValue, // (value, row, params) => valore per l'ordinamento
476
- searchValue, // (value, row, params) => stringa per la ricerca
477
- colDefaults, // Object – default forzati per le colonne di questo tipo
478
- // (es. { sortable: false }), comunque sovrascrivibili nella colonna
479
- inheritsFrom // string – solo tipi nuovi: tipo predefinito da estendere
480
- }
481
- ```
482
-
483
- A differenza del `render` di colonna (`(row, tr, td)`), il `render` del tipo di dato riceve per
484
- primo il **valore** della cella, perché il tipo è generico rispetto al campo.
485
-
486
- ## Ordinamento
487
-
488
- Ogni colonna con `sortable: true` (default; i tipi `bool` lo disattivano) ha un pulsante nel
489
- `<th>` che cicla tra nessun ordinamento → ascendente → discendente → nessuno; l'attributo
490
- `aria-sort` del `<th>` e l'icona riflettono lo stato, `title`/`aria-label` del pulsante
491
- descrivono l'azione del click successivo (`labels.sortAsc/sortDesc/sortNone`). È attivo un solo
492
- ordinamento per volta; il cambio di ordinamento riporta alla prima pagina.
493
-
494
- Lato client il confronto usa i valori precalcolati per ogni riga (`sortValue` di colonna, poi del
495
- tipo di dato, poi il valore grezzo): i valori vuoti (`null`, `''`, `NaN`) vanno sempre in coda,
496
- i numeri sono confrontati numericamente, il resto con `localeCompare` (`locale`, collazione
497
- numerica, insensibile a maiuscole e accenti). L'ordinamento è stabile.
498
-
499
- `initialSort: { key, dir }` applica un ordinamento al caricamento; `setSort(key, dir)` lo cambia
500
- via script.
501
-
502
- ## Ricerca
503
-
504
- L'input di ricerca (`search: true`) filtra le righe dopo `searchDebounce` ms dall'ultimo tasto:
505
- ogni parola del termine (separatore: spazi) deve essere contenuta nel testo di ricerca della riga,
506
- composto dai valori delle colonne `searchable` (`searchValue` di colonna, poi del tipo di dato,
507
- poi il valore grezzo), senza distinzione tra maiuscole e minuscole. La ricerca riporta alla prima
508
- pagina; `setSearch(term)` la imposta via script.
509
-
510
- ## Paginazione
511
-
512
- Con `perPage` > 0 (default 25) le righe vengono suddivise in pagine e sotto la tabella compare la
513
- navigazione: pulsanti precedente/successivo (icone `paginationPrevIcon`/`paginationNextIcon`),
514
- la prima e l'ultima pagina e `paginationDelta` pagine per lato della corrente, con puntini di
515
- sospensione per le pagine omesse. La navigazione è nascosta quando c'è una sola pagina.
516
- `perPage: 0` disattiva la paginazione (tutte le righe in un'unica pagina).
517
-
518
- `goToPage(page)` cambia pagina via script; `state.page`/`state.totPages` riportano lo stato.
519
-
520
- ### Caption e paginazione
521
-
522
- La caption è mostrata **sotto la tabella**, nella barra `tableFooter`, allineata a sinistra; a
523
- destra, nella stessa barra, la navigazione delle pagine. La caption non è un elemento
524
- `<caption>` (che dovrebbe stare dentro la tabella e non potrebbe ospitare la navigazione senza
525
- farla leggere come nome della tabella) ma un contenitore con id, collegato alla tabella tramite
526
- `aria-labelledby`: il nome accessibile della tabella è quindi lo stesso di una `<caption>`.
527
- Posizioni diverse si ottengono con gli slot `caption` e `pagination` del [template](#template).
528
-
529
- ## Modalità server-side
530
-
531
- Con `serverSide: true` il componente non elabora i dati in locale: a ogni cambio pagina,
532
- ordinamento o ricerca invia una nuova richiesta GET a `jsonUrl`, aggiungendo alla query string i
533
- parametri definiti in `serverParams` (quelli già presenti in `jsonUrl` vengono conservati):
534
-
535
- ```javascript
536
- serverParams: {
537
- page: 'page', // pagina richiesta (da 1)
538
- start: 'start', // indice (da 0) del primo record richiesto = (page - 1) * perPage,
539
- // comodo per `LIMIT start, perPage`
540
- perPage: 'perPage', // record per pagina
541
- sort: 'sort', // chiave della colonna ordinata (omesso senza ordinamento)
542
- dir: 'dir', // 'asc' | 'desc' (omesso senza ordinamento)
543
- search: 'search' // termine di ricerca (omesso se vuoto)
544
- }
545
- ```
546
-
547
- Un valore `null` omette il parametro (es. `serverParams: { start: null }` per inviare solo `page`).
548
- Richiesta di esempio, seconda pagina ordinata per nome con ricerca attiva:
549
-
550
- ```
551
- GET /api/rows.json?page=2&start=25&perPage=25&sort=name&dir=desc&search=mar
552
- ```
553
-
554
- Il JSON di risposta deve contenere le **sole righe della pagina richiesta** in `jsonDataField`,
555
- il totale dei record in `totRecField` e il numero di record che soddisfano la ricerca in
556
- `filteredRecField` (se assente vale il totale):
557
-
558
- ```json
559
- { "data": [ ...25 righe... ], "totRec": 1500, "filteredRec": 40 }
560
- ```
561
-
562
- Durante la richiesta il contenitore principale ha `aria-busy="true"` (la tabella viene resa
563
- semitrasparente); le risposte superate da una richiesta più recente vengono ignorate. Se la
564
- pagina richiesta non esiste più (il set di dati si è ridotto), viene richiesta l'ultima
565
- disponibile. In questa modalità `data`, `filtered` e `pageRows` dello stato contengono solo la
566
- pagina corrente e il `tfoot` non è disponibile. `serverSide` richiede `jsonUrl`: con `data` inline
567
- viene ignorato con un avviso in console.
568
-
569
- ### Modalità jQuery DataTables
570
-
571
- Con `jqDatatableMode: true` (o l'attributo `jqdatatablemode="true"`) i default dei parametri server-side diventano quelli del formato di jQuery DataTables, utile per riutilizzare endpoint già esistenti:
572
-
573
- | Parametro | Default con `jqDatatableMode` |
574
- |---|---|
575
- | `jsonDataField` | `'data'` |
576
- | `totRecField` | `'recordsTotal'` |
577
- | `filteredRecField` | `'recordsFiltered'` |
578
- | `serverSide` | `true` |
579
- | `serverParams` | `{ page: null, start: 'start', perPage: 'length', sort: 'order[0][column]', dir: 'order[0][dir]', search: 'search[value]' }` |
580
-
581
- Precedenza: `init()` > attributo HTML > `JsonTable.setDefaults()` > modalità jQuery DataTables > default predefiniti. Ogni parametro può quindi essere sovrascritto singolarmente, e `serverParams` viene unito chiave per chiave.
582
-
583
- Oltre ai `serverParams`, in questa modalità vengono inviati anche `draw=1` e, per ogni colonna visualizzata, `columns[i][name]` (la `key`), `columns[i][searchable]` e `columns[i][orderable]`. `order[0][column]` riceve l'**indice** della colonna ordinata (tra quelle visualizzate), non la chiave. È previsto un solo criterio di ordinamento (`order[0]`).
584
-
585
- ```html
586
- <json-table jsonurl="/api/rows" jqdatatablemode="true" cols='[{"key":"id"},{"key":"name"}]'></json-table>
587
- ```
588
-
589
- ```
590
- GET /api/rows?draw=1&columns[0][name]=id&columns[0][searchable]=true&columns[0][orderable]=true&columns[1][name]=name&…&start=25&length=25&order[0][column]=1&order[0][dir]=desc&search[value]=mar
591
- ```
592
-
593
- ## Template
594
-
595
- `template` definisce il contenuto del contenitore principale come array domBuilder, in cui gli
596
- elementi `{ slot: 'nome' }` vengono sostituiti dalle parti predefinite:
597
-
598
- | Slot | Contenuto |
599
- |---|---|
600
- | `infoSection` | sezione info completa (testo info + input di ricerca, in riga) |
601
- | `resultInfo` | solo il testo info |
602
- | `search` | solo l'input di ricerca (se `search` è true) |
603
- | `table` | wrapper + tabella (thead, tbody, tfoot) e barra `tableFooter` con caption e paginazione |
604
- | `caption` | solo la caption (se `caption` è impostata) |
605
- | `pagination` | solo la navigazione delle pagine (se `perPage` > 0) |
606
-
607
- `caption` e `pagination` fanno parte della barra sotto la tabella dello slot `table`; se il
608
- template li colloca esplicitamente altrove, vengono rimossi dalla barra (che sparisce se resta
609
- vuota).
610
-
611
- Il default `[{ slot: 'infoSection' }, { slot: 'table' }]` corrisponde alla struttura descritta
612
- in [Struttura generata](#struttura-generata). Esempio con ricerca e paginazione sopra la tabella
613
- e info sotto:
614
-
615
- ```javascript
616
- template: [
617
- { className: 'flex gap-2 mbe-sm', children: [{ slot: 'search' }, { slot: 'pagination' }] },
618
- { slot: 'table' }, // barra sotto la tabella con la sola caption
619
- { slot: 'resultInfo' }
620
- ]
621
- ```
622
-
623
- Da `init()` è accettata anche una funzione `(parts, params) => array`, dove `parts` contiene le
624
- parti predefinite (oggetti domBuilder) con le stesse chiavi degli slot. Gli slot non
625
- riconosciuti vengono segnalati in console e ignorati.
626
-
627
- ## Struttura generata
628
-
629
- ```html
630
- <json-table>
631
- <section class="[wrapper] [classes.wrapper]">
632
- <div class="[infoOuter] [classes.infoOuter]">
633
- <div class="[info] [classes.info]">
634
- <div class="[resultInfo] [classes.resultInfo]" aria-live="polite">Stai visualizzando le righe da 1 a 25, ...</div>
635
- <div class="[search] [classes.search]"> <!-- solo se search: true -->
636
- <input type="search" class="form-control form-control-sm" ...>
637
- </div>
638
- </div>
639
- </div>
640
- <div class="[tableOuter]">
641
- <div class="[tableWrapper] table-responsive"> <!-- classes.tableWrapper -->
642
- <table class="[table] table table-bordered" aria-labelledby="jt-1-caption"> <!-- classes.table; aria-labelledby solo se caption -->
643
- <thead>
644
- <tr>
645
- <th scope="col" data-key="name" data-sortable="true" class="[sortable] ..." aria-sort="ascending">
646
- <button type="button" class="[sortBtn] btn-reset" title="Ordina ..." aria-label="Nome: Ordina ...">
647
- <span class="[sortTitle]">Nome</span>
648
- <span class="[sortIcon]" aria-hidden="true"><svg ...></svg></span>
649
- </button>
650
- </th>
651
- <th scope="col" data-key="active" class="text-center">Attivo</th> <!-- non ordinabile -->
652
- </tr>
653
- </thead>
654
- <tbody>
655
- <tr data-jt-idx="0">
656
- <th scope="row" data-key="id" class="text-end text-numeric">1</th> <!-- rowHeading -->
657
- <td data-key="name">Mario</td>
658
- <td data-key="active" class="[boolCell] [boolTrue]"><svg ...></svg></td>
659
- </tr>
660
- <!-- oppure, senza righe: -->
661
- <tr><td colspan="3" class="[empty] [classes.empty]">Nessun record trovato</td></tr>
662
- </tbody>
663
- <tfoot> <!-- solo se tfoot: true -->
664
- <tr><td data-key="id"></td><td data-key="name">Totale</td>...</tr>
665
- </tfoot>
666
- </table>
667
- </div>
668
- <div class="[tableFooter] [classes.tableFooter]"> <!-- solo se caption o perPage > 0 -->
669
- <div class="[caption] [classes.caption]" id="jt-1-caption">Utenti</div> <!-- solo se caption -->
670
- <nav class="[pagination] [classes.pagination]" aria-label="Navigazione pagine"> <!-- solo se perPage > 0; hidden con una sola pagina -->
671
- <ul class="[paginationList]">
672
- <li class="[paginationItem]"><button type="button" class="[paginationBtn] btn-reset [paginationArrow]" data-page="prev" aria-label="Pagina precedente" disabled><svg ...></svg></button></li>
673
- <li class="[paginationItem]"><button type="button" class="[paginationBtn] btn-reset" data-page="1" aria-current="page" aria-label="Pagina 1, corrente">1</button></li>
674
- <li class="[paginationItem]"><button type="button" class="[paginationBtn] btn-reset" data-page="2" aria-label="Vai a pagina 2">2</button></li>
675
- <li class="[paginationItem]"><span class="[paginationEllipsis]" aria-hidden="true">…</span></li>
676
- <li class="[paginationItem]"><button type="button" class="[paginationBtn] btn-reset" data-page="10" aria-label="Vai a pagina 10">10</button></li>
677
- <li class="[paginationItem]"><button type="button" class="[paginationBtn] btn-reset [paginationArrow]" data-page="next" aria-label="Pagina successiva"><svg ...></svg></button></li>
678
- </ul>
679
- </nav>
680
- </div>
681
- </div>
682
- </section>
683
- </json-table>
684
- ```
685
-
686
- Le classi tra parentesi quadre sono quelle interne del CSS module. Nei `<th>` ordinabili
687
- l'attributo `aria-sort` (`ascending`/`descending`) è presente solo sulla colonna ordinata;
688
- `title` e `aria-label` del pulsante descrivono l'azione del click successivo.
689
-
690
- ## Custom properties CSS
691
-
692
- Definite in `json-table.minimo.tokens.mjs` (namespace `--jt-*`):
693
-
694
- | Proprietà | Default (token minimo) |
695
- |---|---|
696
- | `--jt-wrapper-margin-block` | `{size.md}` |
697
- | `--jt-busy-opacity` | `.5` |
698
- | `--jt-info-gap` | `{size.sm}` |
699
- | `--jt-info-font-size` | `{font.size.sm}` |
700
- | `--jt-info-color` | `{text.muted}` |
701
- | `--jt-info-outer-padding-block-end` | `{size.xs}` |
702
- | `--jt-search-max-width` | `20rem` |
703
- | `--jt-thead-hover-background-color` | `color-mix(in srgb, {table.thead.background.color} 90%, {accent})` |
704
- | `--jt-sort-btn-padding-block` | `{table.cell.padding.block}` |
705
- | `--jt-sort-btn-padding-inline` | `{table.cell.padding.inline}` |
706
- | `--jt-sort-btn-line-height` | `{table.cell.line-height}` |
707
- | `--jt-sort-icon-size` | `1em` |
708
- | `--jt-sort-icon-gap` | `.4em` |
709
- | `--jt-sort-icon-none-opacity` | `.4` |
710
- | `--jt-table-footer-padding-block-start` | `{size.xs}` |
711
- | `--jt-caption-font-size` | `{font.size.sm}` |
712
- | `--jt-caption-color` | `{text.muted}` |
713
- | `--jt-pagination-border-width` | `1px` |
714
- | `--jt-pagination-border-color` | `{table.border.color}` |
715
- | `--jt-pagination-radius` | `{radius.xxs}` |
716
- | `--jt-pagination-font-size` | `{font.size.sm}` |
717
- | `--jt-pagination-line-height` | `{table.cell.line-height}` |
718
- | `--jt-pagination-btn-min-width` | `2.2em` |
719
- | `--jt-pagination-btn-padding-block` | `{table.cell.padding.block}` |
720
- | `--jt-pagination-btn-padding-inline` | `{table.cell.padding.inline}` |
721
- | `--jt-pagination-icon-size` | `1em` |
722
- | `--jt-pagination-current-background-color` | `{table.thead.background.color}` |
723
- | `--jt-pagination-current-font-weight` | `{font.weight.semibold}` |
724
- | `--jt-pagination-hover-background-color` | `{table.body.tr.hover-bg-color}` |
725
- | `--jt-pagination-disabled-opacity` | `.5` |
726
- | `--jt-bool-icon-size` | `1.1em` |
727
- | `--jt-bool-true-color` | `{status.success.color}` |
728
- | `--jt-bool-false-color` | `{status.danger.color}` |
729
- | `--jt-empty-color` | `{text.muted}` |
730
- | `--jt-empty-padding-block` | `{size.sm}` |
5
+
6
+ [Documentazione](jt-docs.md)