---
title: "datatable · RUAL Documentation"
description: "A complete data table including filters, sorting, and searchbar."
canonical: https://docs.rual.nl/block-types/Component%20UI/component_datatable
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# datatable

This block is part of the [`Component UI`](https://docs.rual.nl/block-types/Component%20UI) group and was last modified in core [`v12.0.3`](https://docs.rual.nl/core-versions/120003).

## Storage Selection Required

This block relies on a storage to perform its storage releated actions. You must manually select the storage you want to use in your flow using the storage selector modal. To access the modal, click the white button on the block.

A complete data table including filters, sorting, and searchbar.

- Storage required `storage` From which storage do you want the data to be loaded

- Columns required `fielddefinitions` Choose the columns you want to show

- Search Fields `fielddefinitions` Fields that will be searched on in addition to the column fields

- Filters `datatablefilter` Choose the filters you want to expose to the user • Hidden when other fields are filled

- Row Render `v10.4.46` `inpinfunction` Accepts a function that returns a row

- Query `query` Query used as a base for the datatable

- rows per page `v10.3.13` `number` Number of results per page in the table

Default `30`

- infinite scroll `v12.0.0` `condition` Will load new rows as soon as the last row is visible

Default `system setting || false`

- Hide controls `condition` Hides the datatable controls (filters button, search bar, pagination).

Default `false`

- Hide Search Bar `condition` Hides the datatable search bar. • Hidden when other fields are filled

Default `false`

- Show reload button `v10.5.2` `condition` If set to true, the reload button will be shown on the top of the datatable • Hidden when other fields are filled

- Minimize filters `v10.4.54` `condition` By default all filters will be visible, setting this to true will minimize the filters on datatable load. • Hidden when other fields are filled

Default `false`

- Hide custom filter `v10.6.2` `condition` If set to true, the custom filter button will be hidden in the datatable • Hidden when other fields are filled

- Filter field search scope `v10.6.2` `scope` The scope needed for searching through fields in datatable filters.

Default `*public`

- Inline Edit `fielddefinitions` 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.

- Inline Edit Scope `scope` The scope needed for inline editing.

Default `*`

- Mass inline edit `fielddefinitions` Adds a button in the header, onclick will enable the inline edit for all the rows in that column

- Remove scope `scope` Exact scope the user needs to match with to be able to remove items within this datatable. • Hidden when other fields are filled

Default `*`

- JSON scope `scope` Scope the user needs to have to be able to view the JSON of a document, Admin is always allowed

Default `*`

- Revisions scope `scope` Scope the user needs to have to be able to view the revisions of a document, Admin is always allowed

Default `*`

- Hide Checkbox `condition` If set to true, the checkbox will be removed from the datatable

- Hide Remove `v10.4.28` `condition` If set to true, the remove button will be removed from the datatable, even for admins

- Detail Button `inpinfunction` If given, a detail button will show which runs the connected function on click.

- Edit Button `inpinfunction` If given, an edit button will show which runs the connected function on click.

- Search Input Outlet `value` This makes it possible to prefill an input with the search result or update it via the blueprints when searching in a datatable

- No results message `value` If value given, it will show that message when no results are found

Default `No results found`

- On change `v10.4.51` `inpinfunction` Function will execute every time the content of the datatable changes (on search or on filter).

- Show export `condition`

- Columns `fielddefinitions` Choose the columns you want to show in the export

- quotes `v12.0.3` `value` Quotes to use for the csv

Default `"`

- separator `v12.0.3` `value` Delimiter to use for the csv

Default `,`

- Export row render `inpinfunction` Accepts a function that returns a row. Only used for the export

- uicomponent `uicomponent`

A typical wiring for [datatable](https://docs.rual.nl/block-types/Component%2520UI/component_datatable): [selector](https://docs.rual.nl/block-types/globals/storage) feeds the `co-storage` pin; [combine](https://docs.rual.nl/block-types/fields/fielddefinitions_multiple) feeds the `co-fields-columns` pin; the `uicomponent` out pin feeds [build PDF](https://docs.rual.nl/block-types/files/file_generate_pdf).

[![Studio canvas example for the datatable block: typical wiring for datatable.](https://docs.rual.nl/canvas-examples/component_datatable.png)](https://docs.rual.nl/canvas-examples/component_datatable.png?v=3)

## Version history

Introduced in [`v12.0.3`](https://docs.rual.nl/core-versions/120003).

- [v12.0.0](https://docs.rual.nl/core-versions/120000): This block or one of its pins was updated in `v12.0.0`, click here to see the release notes.

- [v10.6.2](https://docs.rual.nl/core-versions/100602): This block or one of its pins was updated in `v10.6.2`, click here to see the release notes.

- [v10.5.2](https://docs.rual.nl/core-versions/100502): This block or one of its pins was updated in `v10.5.2`, click here to see the release notes.

- [v10.4.54](https://docs.rual.nl/core-versions/100454): This block or one of its pins was updated in `v10.4.54`, click here to see the release notes.

- [v10.4.51](https://docs.rual.nl/core-versions/100451): This block or one of its pins was updated in `v10.4.51`, click here to see the release notes.

- [v10.4.46](https://docs.rual.nl/core-versions/100446): This block or one of its pins was updated in `v10.4.46`, click here to see the release notes.

- [v10.4.28](https://docs.rual.nl/core-versions/100428): This block or one of its pins was updated in `v10.4.28`, click here to see the release notes.

- [v10.3.13](https://docs.rual.nl/core-versions/100313): This block or one of its pins was updated in `v10.3.13`, click here to see the release notes.

- [Back to `Component UI`](https://docs.rual.nl/block-types/Component%20UI): Return to the main group to view all sub-groups

- [Back to `advanced table`](https://docs.rual.nl/block-types/Component%20UI?group=advanced%20table): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)
