datatable
This block is part of the Component UI group and was last modified in core v12.0.3.
datatable
v12.0.3
A complete data table including filters, sorting, and searchbar.
| Pin | Pin | Type | Default |
|---|---|---|---|
StoragerequiredFrom which storage do you want the data to be loaded |
storage |
|
|
ColumnsrequiredChoose the columns you want to show |
fielddefinitions |
|
|
| Search Fields Fields that will be searched on in addition to the column fields |
fielddefinitions |
|
|
| Filters Choose the filters you want to expose to the user |
datatablefilter |
|
|
| Row Render Accepts a function that returns a row |
inpinfunction |
|
|
| Query Query used as a base for the datatable |
query |
|
|
| rows per page Number of results per page in the table |
number |
30 |
|
| infinite scroll Will load new rows as soon as the last row is visible |
condition |
system setting || false |
|
| Hide controls Hides the datatable controls (filters button, search bar, pagination). |
condition |
false |
|
| Hide Search Bar Hides the datatable search bar. |
condition |
false |
|
| Show reload button If set to true, the reload button will be shown on the top of the datatable |
condition |
|
|
| Minimize filters By default all filters will be visible, setting this to true will minimize the filters on datatable load. |
condition |
false |
|
| Hide custom filter If set to true, the custom filter button will be hidden in the datatable |
condition |
|
|
| Filter field search scope The scope needed for searching through fields in datatable filters. |
scope |
*public |
|
| Inline Edit Columns that will be used for inline editing. Only basic text, number or date editing is allowed. For every advanced implementation an extra modal or page should be used. |
fielddefinitions |
|
|
| Inline Edit Scope The scope needed for inline editing. |
scope |
* |
|
| Mass inline edit Adds a button in the header, onclick will enable the inline edit for all the rows in that column |
fielddefinitions |
|
|
| Remove scope Exact scope the user needs to match with to be able to remove items within this datatable. |
scope |
* |
|
| JSON scope Scope the user needs to have to be able to view the JSON of a document, Admin is always allowed |
scope |
* |
|
| Revisions scope Scope the user needs to have to be able to view the revisions of a document, Admin is always allowed |
scope |
* |
|
| Hide Checkbox If set to true, the checkbox will be removed from the datatable |
condition |
|
|
| Hide Remove If set to true, the remove button will be removed from the datatable, even for admins |
condition |
|
|
| Detail Button If given, a detail button will show which runs the connected function on click. |
inpinfunction |
|
|
| Edit Button If given, an edit button will show which runs the connected function on click. |
inpinfunction |
|
|
| Search Input Outlet This makes it possible to prefill an input with the search result or update it via the blueprints when searching in a datatable |
value |
|
|
| No results message If value given, it will show that message when no results are found |
value |
No results found |
|
| On change Function will execute every time the content of the datatable changes (on search or on filter). |
inpinfunction |
|
|
| Show export |
condition |
|
|
| Columns Choose the columns you want to show in the export |
fielddefinitions |
|
|
| quotes Quotes to use for the csv |
value |
" |
|
| separator Delimiter to use for the csv |
value |
, |
|
| Export row render Accepts a function that returns a row. Only used for the export |
inpinfunction |
|
| Pin | Pin | Type | Example |
|---|---|---|---|
| uicomponent |
uicomponent |
Core Releases
v12.0.3 This block was introduced inv12.0.3, click here to see the release notes.
Back to
Component UI
Return to the main group to view all sub-groups
Back to advanced table
Return to the group to view all blocks within this group