Skip to Content

ColDefAnt type

Tip

This API reference is automatically generated from the source code  of the @jsoc/react-grid-ant  package.

View Declaration

export type ColDefAnt = TableColumnProps<GridRow>;

Fields

NameTypeDefault
childrennull
titleColumnTitle<UJSONObject>
sorterboolean | CompareFn<UJSONObject> | { compare?: CompareFn<UJSONObject>; multiple?: number; }
sortOrderSortOrder
defaultSortOrderSortOrder
sortDirectionsSortOrder[]
sortIcon(props: { sortOrder: SortOrder; }) => ReactNode
showSorterTooltipboolean | SorterTooltipProps
filteredboolean
filtersColumnFilterItem[]
filterDropdownReactNode | ((props: FilterDropdownProps) => ReactNode)
filterOnCloseboolean
filterMultipleboolean
filteredValueFilterValue | null
defaultFilteredValueFilterValue | null
filterIconReactNode | ((filtered: boolean) => ReactNode)
filterMode"menu" | "tree"
filterSearchFilterSearchType<ColumnFilterItem>
onFilter(value: boolean | Key, record: UJSONObject) => boolean
filterDropdownPropsCoverableDropdownProps

Can cover <Dropdown> props

filterResetToDefaultFilteredValueboolean
responsive("xxxl" | "xxl" | "xl" | "lg" | "md" | "sm" | "xs")[]
filterDropdownOpenboolean

Deprecated: Please use filterDropdownProps.open instead.

onFilterDropdownOpenChange(visible: boolean) => void

Deprecated: Please use filterDropdownProps.onOpenChange instead.

colSpannumber
dataIndexDataIndex<UJSONObject>
render(value: any, record: UJSONObject, index: number) => ReactNode | RenderedCell<UJSONObject>
shouldCellUpdate(record: UJSONObject, prevRecord: UJSONObject) => boolean
rowSpannumber
widthstring | number
minWidthnumber
onCellGetComponentProps<UJSONObject>
onCellClick(record: UJSONObject, e: MouseEvent<HTMLElement, MouseEvent>) => void

Deprecated: Please use onCell instead

keyKey
classNamestring
hiddenboolean
fixedFixedType
onHeaderCellGetComponentProps<ColumnType<UJSONObject> | ColumnGroupType<UJSONObject>>
ellipsisCellEllipsisType
alignAlignType
rowScopeRowScopeType