Cell

Cell objects are instances representing individual table cells. They are generated by the table and contain references to their associated row, column, and the cell's data value. Cells are used for rendering the <tbody> section of the table. See the Cells guide for usage examples.

API

Properties and methods for cell objects. Includes row and column references, cell value accessors, rendering context, and cell identifier information.

Prop	Type
column The associated Column object for the cell.	Column< TData, TValue, TColumnMeta >
getContext Returns the rendering context for cell-based components like cells and aggregated cells.	() => { cell: Cell< TData, TValue, TColumnMeta > column: Column< TData, TValue, TColumnMeta > getValue: () => TValue row: Row<TData> table: TableInstance<TData> }
getIsAggregated Returns whether the cell is currently aggregated.	() => boolean
getIsGrouped Returns whether the cell is currently grouped.	() => boolean
getIsPlaceholder Returns whether the cell is currently a placeholder cell.	() => boolean
getValue Returns the value for the cell, accessed via the associated column's accessor key or accessor function.	() => [ T, ][T extends any ? 0 : never]
id The unique ID for the cell across the entire table.	string
row The associated Row object for the cell.	Row<TData>

column

Type

Column<
  TData,
  TValue,
  TColumnMeta
>

Description

The associated Column object for the cell.

getContext

Type

() => {
  cell: Cell<
    TData,
    TValue,
    TColumnMeta
  >
  column: Column<
    TData,
    TValue,
    TColumnMeta
  >
  getValue: () => TValue
  row: Row<TData>
  table: TableInstance<TData>
}

Description

Returns the rendering context for cell-based components like cells and aggregated cells.

getIsAggregated

Type

() => boolean

Description

Returns whether the cell is currently aggregated.

getIsGrouped

Type

() => boolean

Description

Returns whether the cell is currently grouped.

getIsPlaceholder

Type

() => boolean

Description

Returns whether the cell is currently a placeholder cell.

getValue

Type

() => [
  T,
][T extends any ? 0 : never]

Description

Returns the value for the cell, accessed via the associated column's accessor key or accessor function.

Type

string

Description

The unique ID for the cell across the entire table.

row

Type

Row<TData>

Description

The associated Row object for the cell.

Visibility

Column