RUAL Documentation

advanced datatable

This block is part of the state ui group and was last modified in core v13.0.6.

advanced datatable v13.0.1

A pre-styled advanced table showing data using advanced tooling

Pin Pin Type Default
state key
The state to bind the datatable to. If it is updated, the component will re-render
value
columnsrequired
Choose the columns you want to show
fielddefinitions
overwrite column titles
Overwrite the title of a specific column.
array
columns width
Choose the widths of the columns in percentage, expects array of numbers. e.g. 5 for 5% in width.
array 100%
columns sortable
Choose which columns can be sorted, by default we will not do any sortable fields
fielddefinitions
overwrite column sort field
Overwrite which field will be sorted on column sort. With this function it is possible to sort on non existing columns / fields that are made up by combining multiple different values or are returned by the row render.
array
columns filterable
Choose which columns can be filtered, by default we will not do any filterable fields
fielddefinitions
search fields
Fields that will be searched on in addition to the column fields
fielddefinitions
return fields
Fields that will be returned during the search. Should be set if the data sent to the frontend should be limited due to confidential fields.
fielddefinitions *
row actions
Actions that are specific to the row like edit, detail, json, revision or inline edit
statedatatableconnection
query
Query used as a base for the datatable
query
rows per page
Number of results per page in the table
number 30
rows per page options
Options to show in the dropdown at the bottom right
array 10, 30, 50, 100
filters
Adds filtering to the datatable
statedatatablefilter
class
Assigns a CSS class to the element.
uiclass
style
Applies inline CSS style to the element
uistyle
attributes
Adds custom attributes to the element.
uiattributes
Pin Pin Type Example
state
Returns the element to the frontend state.
state
Map Row
The function will be executed for each row and state pins can be returned to overwrite whats visible.
execute_function
Row Component
The component will be executed for every row and replace the default values and columns. A tr should be returned. The available parameters are columns, row and index.
iteratestate

Core Releases

v13.0.1 This block was introduced in v13.0.1, click here to see the release notes. v13.0.6 This block was last modified in v13.0.6, click here to see the release notes.
Back to state ui Return to the main group to view all sub-groups Back to state elements Return to the group to view all blocks within this group