DataGrid

Overview

Given the provided data, will provide a table of contents

Example : Default usage

import { DataGrid } from '@ska-telescope/ska-gui-components';

...

<DataGrid columns={DUMMY_COLUMNS} rows={DUMMY_ROWS} testId="testId" />

Properties

Property	Type	Required	default
ariaDescription	string	No		Used by Screen Readers
ariaTitle	string	No	AlertCard	Used by Screen Readers
checkboxSelection	boolean	No	false	Adds checkboxes as the first column
columns	number	Yes		Array containing the column specifics
columnVisibilityModel	any	No		Ability to dynamically show/hide columns
filterModeServer	boolean	No	false	Determines if te filtering mode is on the client (default) or server
getRowHeight	Function	No	auto	Ability to pass in a function to calculate the row height. Auto determined by default
height	number	No	264	Determines the height that the component will use
initialState	object	No		Sets the initial state of the DataGrid
onColumnVisibilityModelChange	any	No	Used to listen to the changes to the visible columns and update accordingly
onFilterModelChange	any	No	Used to listen to changes to the filters and update accordingly
onRowClick	function	No		Action if the row is clicked
onCellClick	function	No		Action if a cell is clicked
onRowSelectionModelChange	function	No		Used to obtain the selected rows from the dataGrid
rows	array	Yes		Data that is to be presented
rowSelectionModel	array	No		Used to populate the dataGrid with selected rows
showBorder	boolean	No		When active, the border for the component is displayed
showMild	boolean	No		When active, the selected colouring is restricted to a lower contrast
testId	string	No	dataGrid-testId	Identifier for testing purposes

Columns

Property	Type	Required	default
field	string	No		Identifies the data element to be displayed
headerName	string	No		Text displayed above the column
width	number	No		Width of the column

Constants

none

Testing Identifier

Provided by the property testId