Row customisation can be achieved in the following ways:
- Row Style: Providing a CSS style for the rows. Applied individually to each element.
- Row Class: Providing a CSS class for the rows. Not removed on data refresh.
- Row Class Rules: Providing rules for applying CSS classes. These styles are dynamic and applied in batches.
We recommend Row Class Rules for most use cases. See Refresh of Styles for more details.
Each of these approaches are presented in the following sections.
Some row styles may also be overridden with CSS variables. See the full variable reference.
Row Style
You can add CSS styles to each row in the following ways:
The style properties to apply to all rows. Set to an object of key (style names) and values (style values). |
Callback version of property rowStyle to set style for each row individually. Function should return an object of CSS values or undefined for no styles. |
const gridOptions = {
// set background colour on every row, this is probably bad, should be using CSS classes
rowStyle: { background: 'black' },
// set background colour on even rows again, this looks bad, should be using CSS classes
getRowStyle: params => {
if (params.node.rowIndex % 2 === 0) {
return { background: 'red' };
}
},
// other grid options ...
}
If your data is static, use row classes to apply styles for better performance.
Row Class
You can add CSS classes to each row in the following ways:
CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names). |
Callback version of property rowClass to set class(es) for each row individually. Function should return either a string (class name), array of strings (array of class names) or undefined for no class. |
const gridOptions = {
// all rows assigned CSS class 'my-green-class'
rowClass: 'my-green-class',
// all even rows assigned 'my-shaded-effect'
getRowClass: params => {
if (params.node.rowIndex % 2 === 0) {
return 'my-shaded-effect';
}
},
// other grid options ...
}
Row Class Rules
You can define rules which can be applied to include certain CSS classes via the grid option rowClassRules
. These rules are provided as a map where the keys are class names and the values are expressions that if evaluated to true
, the class gets used. The expression can either be a function, or a string which is treated as a shorthand for a function by the grid.
Rules which can be applied to include certain CSS classes. |
The following snippet shows rowClassRules
that use functions and the value from the year column:
const gridOptions = {
rowClassRules: {
// apply green to 2008
'rag-green-outer': (params) => { return params.data.year === 2008; },
// apply amber 2004
'rag-amber-outer': (params) => { return params.data.year === 2004; },
// apply red to 2000
'rag-red-outer': (params) => { return params.data.year === 2000; }
},
// other grid options ...
}
Row Style/Class Functions
All rowStyle, rowClass and rowClassRules functions take a RowClassParams
params object.
Properties available on the RowClassParams<TData = any, TContext = any>
interface.
The data associated with this row from rowData. Data is undefined for row groups.
|
The RowNode associated with this row |
The index of the row |
The grid api. |
Application context as set on gridOptions.context . |
As an alternative, you can also provide shorthands of the functions using an expression. An expression is evaluated by the grid by executing the string as if it were a Javascript expression. The expression has the following attributes available to it (mapping the the attributes of the equivalent params object):
ctx
: maps contextnode
: maps nodedata
: maps datarowIndex
: maps rowIndexapi
: maps the grid api
The following snippet shows rowClassRules
applying classes to rows using expressions on an age column value:
const gridOptions = {
rowClassRules: {
'rag-green': 'data.age < 20',
'rag-amber': 'data.age >= 20 && data.age < 25',
'rag-red': 'data.age >= 25',
},
// other grid options ...
}
Refresh of Styles
If you refresh a row, or a cell is updated due to editing, the rowStyle
, rowClass
and rowClassRules
are all applied again. This has the following effect:
- rowStyle: All new styles are applied. If a new style is the same as an old style, the new style overwrites the old style.
- rowClass: All new classes are applied. Old classes are not removed so be aware that classes will accumulate. If you want to remove old classes, then use rowClassRules.
- rowClassRules: Rules that return true will have the class applied the second time. Rules that return false will have the class removed second time.
Example Row Class Rules
The example below demonstrates rowClassRules
:
rowClassRules
are used to apply the classsick-days-warning
when the number of sick days > 5 and <= 7, and the classsick-days-breach
is applied when the number of sick days >= 8.The grid re-evaluates the rowClassRules and applies styles when the data is changed independent of mechanism. See Updating Data for details on methods to update data.
Highlighting Rows and Columns
The grid can highlight both Rows and Columns as the mouse hovers over them.
Highlighting Rows is on by default. To turn it off, set the grid property suppressRowHoverHighlight=true
.
Highlighting Columns is off by default. To turn it on, set the grid property columnHoverHighlight=true
.
const gridOptions = {
// turns OFF row hover, it's on by default
suppressRowHoverHighlight: true,
// turns ON column hover, it's off by default
columnHoverHighlight: true,
// other grid options ...
}
In this example Rows and Columns are highlighted.
Note if you hover over a header group, all columns in the group will be highlighted.
In this example Column highlighting is disabled by default and Row highlighting has been disabled using suppressRowHoverHighlight=true
.
Row Highlighting works by the grid adding the CSS class ag-row-hover
to the rows getting hovered. The grid cannot depend on using CSS :hover
selector as this will not highlight the entire row if Columns are pinned.
Column Highlighting works by the grid adding the CSS class ag-column-hover
to all Cells to be highlighted.
Styling the First and Last Rows
It's possible to style the first and last rows of the grid using CSS by targeting the .ag-row-first
and .ag-row-last
selectors as follows:
.ag-row.ag-row-first {
background-color: #2244CC44;
}
.ag-row.ag-row-last {
background-color: #CC333344;
}