gdev-datatable
Una estensione del componente <b-table> di bootstrap-vue
Disponibili tutte le funzionalità e props del componente originale:
https://bootstrap-vue.org/docs/components/table#tables
Le funzionalità aggiuntive sono descritte in seguito (Vedere capitolo)
Tabella dei contenuti
[TOC]
Utilizzo
Installazione
yarn install
Test del componente
I file src/main.js e src/Test.vue non vengono inclusi nella build, servono al solo scopo di poter testare il
componente senza dover creare un progetto di test esterno.
Apportare le modifiche che si vogliono testare al file Test.vue, poi lanciare il comando:
yarn serve
Compilazione del progetto per successiva pubblicazione su npm
yarn build
Vengono generati i file all'interno della directory dist
Pubblicazione del pacchetto su npm
npm publish
Se viene generato errore di login, occorre prima lanciare:
npm adduser
Props e funzionalita
Props
| Prop | Descrizione | Tipo | Default | Obbligatoria |
|---|---|---|---|---|
| Tutte quelle del componente b-table | Link | |||
| id | Identificativo univoco del componente | String | 'gdev-data-table' | Yes |
| table-class | Classe applicata al componente table | String | ||
| loading | Per visualizzazione del messaggio (prop loadingMessage) durante caricamento | Boolean | false | |
| loading-message | Messaggio da visualizzare durante caricamento | String | ||
| draggable-columns | Attiva la funzionalità di drag delle colonne | Boolean | false | |
| draggable-column-moved | Evento che viene chiamato quando viene draggata una colonna | Function | ||
| columns | Corrisponde alla prop fields del componente originale | Array | [] | Yes |
| items | Corrisponde alla prop items del componente originale | Array | [] | Yes |
| selectable | Attiva la funzionalità di selezione multipla delle righe e la prima colonna con checkbox di selezione | Boolean | false | |
| selected-items | Restituisce un array delle righe selezionate ad ogni selezione effettuata | Array | [] | |
| pagination | Mostra i controlli di paginazione | Boolean | false | |
| pagination-per-page | Il valore di righe per pagina di default | Integer | 10 | |
| pagination-per-page-options | Array contenente i possibili valori di righe per pagina selezionabili | Array | [10, 20, 50, 100] | |
| pagination-total-pages-label | Etichetta da mostrare a fianco del numero totale di pagine | String | Tot: | |
| pagination-rows-per-page-label | Etichetta da mostrare a fianco della selezione del numero di righe per pagina | String | Per page: | |
| action-column | Attiva la visualizzazione della colonna azioni riga, customizzabile con slot 'action-1','action-2','action-3' | Boolean | false | |
| action-column-label | Etichetta per header colonna azioni riga | String | 'Actions' | |
| action-column-content-width | La colonna actions non verrà estesa a seconda della larghezza totale della tabella ma rimane larga quanto il contenuto | Boolean | false | |
| empty-message | Messaggio da visualizzare se non sono presenti record | String | ||
| loading-message | Messaggio da visualizzare durante il caricamento dei dati | String | ||
| use-internal-filter | Visualizza il controllo in alto a destra per ricerca. Il controllo avrà ID uguale a <id_tabella>-filterInternal.Se si vuole invece utilizzare un controllo esterno, utilizzare la prop filter come da docs b-table |
Boolean | ||
| internal-filter-placeholder | Placeholder all'interno del controllo di ricerca | String | 'Search' |
Slots
| Slot | Descrizione |
|---|---|
| Tutte quelle del componente b-table | Link |
| actions-cell | Interna ad ogni cella della colonna azioni riga (se attivata). Per default, gli elementi vengono posizionati centralmente con flexbox. Interponendo un div è possibile modificare a piacimento la disposizione. |
| bottom-right | Slot libera posizionata in basso a destra |
Eventi
| Evento | Descrizione |
|---|---|
| rows-per-page-changed | Chiamato su selezione di un altro valore di righe per pagina |
| page-changed | Chiamato su selezione di una pagina. Il valore inizia da 1. |