Standard Columns

Documents the standard properties and templates available on most columns.

Properties

PropertyTypeDefault / OptionalDescription
namestringDefault: ""The unique name that identifies this column in the grid.
titlestringOptionalThe title of the column, this is displayed in the table header.
fieldstringOptionalThe name of the field on the row that will contain the data. Used by default columns and other features to automatically display the data. If building a completely custom column it is not required.
quickFilterValueFunction | stringOptionalOverrides the default method of obtaining the value to use when matching against the quick filter. Accepts a function or a Lava template string.
sortFieldstringOptionalField name to use when sorting. Defaults to value from field if not specified. Column must have a title to be sortable.
sortValueFunction | stringOptionalOverrides sortField with a custom sort value, either via function or Lava template.
filterObjectOptionalEnables filtering of this column and specifies the type of filtering to apply.
filterValueFunction | stringOptionalUsed in conjunction with filter, defines how to derive filter value via function or Lava template.
exportValueFunction | stringOptionalFunction or Lava template used for exporting the cell's data. Defaults to format template if not provided.
headerClassstringOptionalAdditional CSS class for the header cell.
itemClassstringOptionalAdditional CSS class for the data item cell.
formatComponentComponentOptionalCustom component to format and display the cell. Rarely needed if body template is used.
condensedComponentComponentOptionalCustom component to format the cell in condensed views. Falls back to formatComponent if not defined.
headerComponentComponentOptionalCustom component for rendering the header. Rarely needed if header template is used.
skeletonComponentComponentOptionalCustom component used during loading phase. Rarely needed if skeleton template is defined.
hideOnScreenbooleanDefault: falseHides the column from visual display but retains inclusion in exports or processing.
excludeFromExportbooleanDefault: falseExcludes this column from export operations.
visiblePriority"xs" | "sm" | ... | "xl"Default: "xs"Defines the minimum screen size for the column to appear.
widthstringOptionalWidth of column as percentage (e.g., "30%") or fixed pixels. Used to compute relative column widths.
disableSortbooleanDefault: falseDisables the built-in sorting feature for this column.

Templates

TemplaterowcolumngridDescription
formatrow: Record<string, unknown> - The row to be displayed.column: ColumnDefinition - The definition details about the column being displayed.grid: IGridState - Details about the current state of the grid.This template allows defining how the cell will be rendered on screen. Defining this template will override the formatComponent property.
condensedrow: Record<string, unknown> - The row to be displayed.column: ColumnDefinition - The definition details about the column being displayed.grid: IGridState - Details about the current state of the grid.This template allows defining how the cell should be rendered when it needs to be displayed in a condensed format. Additional information that is normally displayed, but not strictly required, should be excluded. For example, a cell that normally displays a person photo and their name might display just their name in condensed mode. Defining this template will override the condensedComponent property.
headerN/Acolumn: ColumnDefinition - The definition details about the column being displayed.grid: IGridState - Details about the current state of the grid.This template allows defining the way the header cell will be displayed. Defining this template will override the headerComponent property.
filterPrependN/Acolumn: ColumnDefinition - The definition details about the column being displayed.grid: IGridState - Details about the current state of the grid.This template allows defining content that will be displayed inside the column filter popup. It will be displayed above the actual filter component.
exportrow: Record<string, unknown> - The row to be displayed.column: ColumnDefinition - The definition details about the column being displayed.grid: IGridState - Details about the current state of the grid.This template allows defining text content that will be used when exporting cells to CSV or Excel. If the property exportValue is defined it will override this template (for performance reasons).
skeletonN/Acolumn: ColumnDefinition - The definition details about the column being displayed.grid: IGridState - Details about the current state of the grid.This template allows defining the way the skeleton cell will be displayed while waiting for grid data to load. Defining this template will override the skeletonComponent property.