Grid

Set to true to add default border around the table. Automatically set if grid is scrollable.

Set to true to render only visible rows on the screen. This greatly improves performance for grids with a lot of data. Works only if the grid is scrollable.

Set to true to enable row caching. This greatly improves grid performance on subsequent render operations, however, only changes on records are allowed. If grid rows display any data outside records, changes on that data will not be caught.

If set, clicking on the column header will loop between ASC, DESC and no sorting order, instead of ASC and DESC only.

An array of columns. Check column configuration options in the section below.

An array of grouping level definitions. Check allowed grouping level properties in the section below.

Determines header appearance. Supported values are plain and default. Default mode is used if some of the columns are sortable. Plain mode better suits reports and other scenarios in which users do not interact with the grid.

Used when rows have variable heights to improve buffered rendering by measuring and caching rendered row heights. Default value is false.

Page size used to fetch records during infinite scrolling. Default value is 100.

An array of records to be displayed in the grid.

Set to true to add a vertical scroll and a fixed header to the grid. Scrollable grids shoud have height or max-height set. Otherwise, the grid will grow to accomodate all rows.

Selection configuration. See Selections for more details.

A binding used to store the sort direction. Available only if sorters are not used.

A binding used to store the name of the field used for sorting grids. Available only if sorters are not used.

A binding used to store the sorting order list. Commonly used for server-side sorting.

Set to true to add vertical gridlines.

Set to true to allow the grid to receive drag and drop operations containing files.

Number of rendered rows in buffered grids. Default value is 60.

Number of rows to be scrolled before buffer adjustment. Default value is 15.

Additional CSS classes to be applied to the element. If an object is provided, all keys with a "truthy" value will be added to the CSS class list.

Whenever columnParams change, columns are recalculated using the onGetColumns callback.

Data adapter is used for converting data in a list of records. Used to enable grouping and tree operations. See TreeGrid for more details.

Default sort direction.

Default sort field. Used if neither sortField or sorters are set.

Text to be displayed instead of an empty table.

Parameters which will be passed to the onCreateFilter callback. Take a look at the example here.

Set to true to add a fixed footer at the bottom of the grid.

Set to true or false to explicitly define if grid is allowed to receive focus.

Whenever groupingParams change, columns are recalculated using the onGetGrouping callback.

A value used to identify the group of components participating in hover effect synchronization. See HoverSync.

Set to true to lock column widths after the first render. This is helpful in pagination scenarios to maintain consistent looks across pages.

Appearance modifier. For example, mod="big" will add the CSS class .cxm-big to the block element.

Callback function used to create a filter. The function accepts filterParams as an argument and it should return a predicate function used to filter the records. Take a look at the example here.

Callback function used to specify which row is draggable. It should return a predicate which accepts a record and returns a boolean indicating wheter that record is draggable or not.

Callback function used to specify which row is selectable and which not.

Callback function used to dynamically calculate columns. The function accepts resolved columnParams as a first argument and it should return either columns (array of column configurations) or row (grid row configuration) for multi-line scenarios.

Callback function to retrieve grouping data. Accepts groupingParams as a first argument and should return a grid grouping configuration.

Callback function to get grid component and instance references on component init.

Callback function to be executed when a row is clicked.

Callback function to be executed when a row is right-clicked.

Callback function to be executed when a row is double-clicked.

Callback function to be executed on key down. Accepts instance of the currently focused record as the second argument.

Callback function to track and retrieve displayed records. Accepts new records as a first argument. If onCreateFilter callback is defined, filtered records can be retrieved using this callback. See its usage in the example here.

Defines the outer layout which wraps the widget.

Additional sorters to be prepended to the actual list of sorters.

When enabled, groups are shown in the same order as the source records.

Used with outer layouts. Specifies the name of the content placeholder which should render the widget.

Set to true if sorting is done remotely, on the server-side. Default value is false.

A parameter that allows defining multiple lines in a row. Attributes of the row object: line1 - defines the first line, line2 - defines the second line, style - style object applied to the wrapper div, class - additional CSS classes to be applied to the element. If an object is provided, all keys with a "truthy" value will be added to the CSS class list.

A value used to uniquely identify the record within the hover sync group. See HoverSync.

Parameters whose change will cause the scroll to be reset.

Set to true to add ensure that selected record is automatically scrolled into the view on selection change.

Options for data sorting. See Intl.Collator options for more info.

Style object applied to the wrapper div. Used for setting the dimensions of the element.

Key that will be used as the key when rendering the React component.

Visibility of the widget. Defaults to true.