Skip to main content

A single column in an admin table's server-driven catalog, returned by the table-config endpoint. Describes the column identity, how to sort it, and how to render its cell. See the "Table Configuration" guide for the full contract.

​
key
string
erforderlich

Stable column identifier (camelCase). Also the persisted view key and, for sortable columns, the JSON:API sort field. Never changes once shipped. A dotted key (e.g. customer.fullName) reads through a relationship.

Beispiele:

"givenName"

"customer.fullName"

​
cell
object
erforderlich

How to render the cell and where it reads its data off the row.

​
header
string

Localized column label.

Beispiel:

"First name"

​
type
enum<string>

Sort/format primitive for the table shell. Omitted for plain (alphabetical) columns.

Verfügbare Optionen:
date,
number,
dateRange
​
sortable
boolean

Whether the column is server-sortable via the JSON:API sort param.

​
defaultVisible
boolean

Present and true only for columns shown by default; absent means hidden by default.

​
group
string

Optional grouping bucket for the column picker.

Beispiel:

"customer"

​
icon
string[]

Optional FontAwesome icon for the header as [style, name].

Required array length: 2 elements
Beispiel:
​
align
enum<string>

Optional column alignment. right for numeric/currency columns; left is implied.

Verfügbare Optionen:
right