ColumnDef

Column definitions are plain objects that describe the configuration of columns in a table.

API Options

id

id: string
id: string

The unique identifier for the column.

A column ID is optional when:

  • An accessor column is created with an object key accessor
  • The column header is defined as a string

accessorKey

accessorKey?: string & typeof TData
accessorKey?: string & typeof TData

The key of the row object to use when extracting the value for the column.

accessorFn

accessorFn?: (originalRow: TData, index: number) => any
accessorFn?: (originalRow: TData, index: number) => any

The accessor function to use when extracting the value for the column from each row.

columns

columns?: ColumnDef<TData>[]
columns?: ColumnDef<TData>[]

The child column defs to include in a group column.

header

header?:
  | string
  | ((props: {
      table: Table<TData>
      header: Header<TData>
      column: Column<TData>
    }) => unknown)
header?:
  | string
  | ((props: {
      table: Table<TData>
      header: Header<TData>
      column: Column<TData>
    }) => unknown)

The header to display for the column. If a string is passed, it can be used as a default for the column ID. If a function is passed, it will be passed a props object for the header and should return the rendered header value (the exact type depends on the adapter being used).

footer

footer?:
  | string
  | ((props: {
      table: Table<TData>
      header: Header<TData>
      column: Column<TData>
    }) => unknown)
footer?:
  | string
  | ((props: {
      table: Table<TData>
      header: Header<TData>
      column: Column<TData>
    }) => unknown)

The footer to display for the column. If a function is passed, it will be passed a props object for the header and should return the rendered header value (the exact type depends on the adapter being used).

cell

cell?: ((props: {
  table: Table<TData>
  row: Row<TData>
  column: Column<TData>
  cell: Cell<TData>
  getValue: () => any
  renderValue: () => any
}) => unknown)
cell?: ((props: {
  table: Table<TData>
  row: Row<TData>
  column: Column<TData>
  cell: Cell<TData>
  getValue: () => any
  renderValue: () => any
}) => unknown)

The cell to display each row for the column. If a function is passed, it will be passed a props object for the cell and should return the rendered cell value (the exact type depends on the adapter being used).

meta

meta?: ColumnMeta // This interface is extensible via declaration merging. See below!
meta?: ColumnMeta // This interface is extensible via declaration merging. See below!

The meta data to associated with the column. We can access it anywhere when the column is available via column.columnDef.meta. This type is global to all tables and can be extended like so:

import "@tanstack/react-table"
 
declare module "@tanstack/table-core" {
  interface ColumnMeta<TData extends RowData, TValue> {
    foo: string
  }
}
import "@tanstack/react-table"
 
declare module "@tanstack/table-core" {
  interface ColumnMeta<TData extends RowData, TValue> {
    foo: string
  }
}

Credits

InstallationInstallation pageTableTable page