GridCustomCellProps
The properties of the default Grid Cell.
Definition
Package:@progress/kendo-react-grid
Properties
ariaColumnIndex
number
The index applied to the aria-colindex attribute.
Defines a set of custom cell components that the Grid will render instead of the default cell.
children?
ReactNode | ReactNode[]
The default children of the table cell.
className?
string
Custom CSS classes for the cell.
colSpan?
number
The column span of the cell.
columnIndex?
number
The index of the column in the rendered columns collection. Optional.
columnsCount?
number
The total number of rendered columns in the Grid. Optional.
contentColumnSpan?
number
Pre-calculated column span for the content cell of this group column.
Applicable only when groupable.displayMode is 'multipleColumns' or 'singleColumn' and rowType is 'groupFooter' or 'groupHeader'.
Use this in the colSpan attribute of the cell containing the main group content.
undefined
dataIndex
number
The zero-based index of the data item in the data collection.
dataItem
any
The data item for the current row.
editor?
"boolean" | "text" | "numeric" | "date"
Specifies the type of editor to be used when the cell is in edit mode.
Supported values are text, numeric, boolean, and date.
expanded?
boolean
Indicates if the cell is expanded.
field?
string
The data field that the cell binds to.
format?
string
The format applied to the value before display.
Takes the {0:format} form where format is a standard number format, a custom number format,
a standard date format, or a custom date format.
Looks up the rendered column index of a leaf column by its field, among the columns
that come after this group column's own cell (the same columns covered by
trailingGroupColumnSpan). Use this to align filler/aggregate cells rendered by a
custom groupColumn.cells.groupHeader / groupColumn.cells.groupFooter template with
a specific data column, without hardcoding column counts or positions.
Applicable only when groupable.displayMode is 'multipleColumns' or 'singleColumn'
and rowType is 'groupFooter' or 'groupHeader'. Returns undefined if the
specified field is not among the rendered columns.
undefined | number
undefined
groupSelectionCheckbox?
ReactNode
The built-in group-level selection checkbox, when the Grid has a checkbox selection
column configured. Render this wherever you want the checkbox to appear inside a
custom groupColumn.cells.groupHeader component instead of reimplementing the
selection state and toggle handling yourself. undefined when there is no checkbox
selection column, or for groupFooter cells (which never render a checkbox).
undefined
isAlt?
boolean
Indicates if the cell is alt.
isSelected
boolean
Indicates if the cell is selected.
isSorted?
boolean
Indicates if the cell is sorted.
isSpacerCell?
boolean
Indicates that this invocation of the custom groupColumn.cells.groupHeader /
groupColumn.cells.groupFooter component is for a "filler" cell position that
carries no content of its own, rather than the level's real toggle/value content
cell — ancestor-level spacer columns when groupable.displayMode is
'multipleColumns', or (when displayMode is 'default') ancestor-level indent
cells on the group-header row and every cell on the group-footer row. Check this
flag to render simplified/blank content for such positions instead of the level's
normal group header/footer content.
false
leadingGroupColumnSpan?
number
Pre-calculated column span for ancestor-level group columns (columns before this group level).
Applicable only when groupable.displayMode is 'multipleColumns' or 'singleColumn' and rowType is 'groupFooter' or 'groupHeader'.
Use this in the colSpan attribute of ancestor-level spacer cells.
undefined
onChange?
(event: { dataItem: any; dataIndex: number; syntheticEvent: SyntheticEvent<any, Event>; field?: string; value?: any }) => void
Triggered when the cell value is changed. Provides details about the change event.
onContextMenu?
(event: MouseEvent<HTMLElement, MouseEvent>, dataItem: any, field: string) => void
Triggered when the ContextMenu is activated on the cell. Provides the event object, data item, and field name.
Specifies the type of the row (e.g., data row, group header, etc.). Optional.
selectionChange?
(event: { syntheticEvent: SyntheticEvent<any, Event> }) => void
Triggered when the cell is selected. Provides the event object.
style?
CSSProperties
Inline styles for the cell.
td2Props?
null | TdHTMLAttributes<HTMLTableCellElement>
The props and attributes that are applied to the second td. Such element is rendered in very rare cases when we have grouping and sticky columns.
tdProps?
null | TdHTMLAttributes<HTMLTableCellElement>
The props and attributes that are applied to the td element by default.
trailingGroupColumnSpan?
number
Pre-calculated column span for descendant-level group columns (columns after this group level).
Applicable only when groupable.displayMode is 'multipleColumns' or 'singleColumn' and rowType is 'groupFooter' or 'groupHeader'.
Use this in the colSpan attribute of descendant-level spacer cells.
undefined