Interface TableColumnType<RecordType>

interface TableColumnType<RecordType> {
    align?: AlignType;
    className?: string;
    colSpan?: number;
    dataIndex?: DataIndex;
    defaultFilteredValue?: null | FilterValue;
    defaultSortOrder?: SortOrder;
    ellipsis?: CellEllipsisType;
    filterDropdown?: ReactNode | ((props) => ReactNode);
    filterDropdownOpen?: boolean;
    filterDropdownVisible?: boolean;
    filterIcon?: ReactNode | ((filtered) => ReactNode);
    filterMode?: "menu" | "tree";
    filterMultiple?: boolean;
    filterResetToDefaultFilteredValue?: boolean;
    filterSearch?: FilterSearchType<ColumnFilterItem>;
    filtered?: boolean;
    filteredValue?: null | FilterValue;
    filters?: ColumnFilterItem[];
    fixed?: FixedType;
    hidden?: boolean;
    key?: Key;
    onCell?: GetComponentProps<RecordType>;
    onCellClick?: ((record, e) => void);
    onFilter?: ((value, record) => boolean);
    onFilterDropdownOpenChange?: ((visible) => void);
    onFilterDropdownVisibleChange?: ((visible) => void);
    onHeaderCell?: GetComponentProps<ColumnType<RecordType> | ColumnGroupType<RecordType>>;
    render?: ((value, record, index) => ReactNode | RenderedCell<RecordType>);
    responsive?: Breakpoint[];
    rowScope?: RowScopeType;
    rowSpan?: number;
    shouldCellUpdate?: ((record, prevRecord) => boolean);
    showSorterTooltip?: boolean | TooltipProps;
    sortDirections?: SortOrder[];
    sortIcon?: ((props) => ReactNode);
    sortOrder?: SortOrder;
    sorter?: boolean | CompareFn<RecordType> | {
        compare?: CompareFn<RecordType>;
        multiple?: number;
    };
    title?: ColumnTitle<RecordType>;
    width?: string | number;
}

Type Parameters

  • RecordType

Hierarchy (view full)

Properties

align? className? colSpan? dataIndex? defaultFilteredValue? defaultSortOrder? ellipsis? filterDropdown? filterDropdownOpen? filterDropdownVisible? filterIcon? filterMode? filterMultiple? filterResetToDefaultFilteredValue? filterSearch? filtered? filteredValue? filters? fixed? hidden? key? onCell? onCellClick? onFilter? onFilterDropdownOpenChange? onFilterDropdownVisibleChange? onHeaderCell? render? responsive? rowScope? rowSpan? shouldCellUpdate? showSorterTooltip? sortDirections? sortIcon? sortOrder? sorter? title? width?

Properties

Optional align

align?: AlignType

Optional className

className?: string

Optional colSpan

colSpan?: number

Optional dataIndex

dataIndex?: DataIndex

Optional defaultFilteredValue

defaultFilteredValue?: null | FilterValue

Optional defaultSortOrder

defaultSortOrder?: SortOrder

Optional ellipsis

ellipsis?: CellEllipsisType

Optional filterDropdown

filterDropdown?: ReactNode | ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      • props: FilterDropdownProps

      Returns ReactNode

Optional filterDropdownOpen

filterDropdownOpen?: boolean

Optional filterDropdownVisible

filterDropdownVisible?: boolean

Deprecated

Please use filterDropdownOpen instead

Optional filterIcon

filterIcon?: ReactNode | ((filtered) => ReactNode)

Type declaration

    • (filtered): ReactNode

    • Parameters

      • filtered: boolean

      Returns ReactNode

Optional filterMode

filterMode?: "menu" | "tree"

Optional filterMultiple

filterMultiple?: boolean

Optional filterResetToDefaultFilteredValue

filterResetToDefaultFilteredValue?: boolean

Optional filterSearch

filterSearch?: FilterSearchType<ColumnFilterItem>

Optional filtered

filtered?: boolean

Optional filteredValue

filteredValue?: null | FilterValue

Optional filters

filters?: ColumnFilterItem[]

Optional fixed

fixed?: FixedType

Optional hidden

hidden?: boolean

Optional key

key?: Key

Optional onCell

onCell?: GetComponentProps<RecordType>

Optional onCellClick

onCellClick?: ((record, e) => void)

Type declaration

Deprecated

Please use onCell instead

Optional onFilter

onFilter?: ((value, record) => boolean)

Type declaration

    • (value, record): boolean

    • Parameters

      Returns boolean

Optional onFilterDropdownOpenChange

onFilterDropdownOpenChange?: ((visible) => void)

Type declaration

    • (visible): void

    • Parameters

      • visible: boolean

      Returns void

Optional onFilterDropdownVisibleChange

onFilterDropdownVisibleChange?: ((visible) => void)

Type declaration

    • (visible): void

    • Parameters

      • visible: boolean

      Returns void

      Deprecated

      Please use onFilterDropdownOpenChange instead

Deprecated

Please use onFilterDropdownOpenChange instead

Optional onHeaderCell

onHeaderCell?: GetComponentProps<ColumnType<RecordType> | ColumnGroupType<RecordType>>

Optional render

render?: ((value, record, index) => ReactNode | RenderedCell<RecordType>)

Type declaration

    • (value, record, index): ReactNode | RenderedCell<RecordType>

    • Parameters

      Returns ReactNode | RenderedCell<RecordType>

Optional responsive

responsive?: Breakpoint[]

Optional rowScope

rowScope?: RowScopeType

Optional rowSpan

rowSpan?: number

Optional shouldCellUpdate

shouldCellUpdate?: ((record, prevRecord) => boolean)

Type declaration

Optional showSorterTooltip

showSorterTooltip?: boolean | TooltipProps

Optional sortDirections

sortDirections?: SortOrder[]

Optional sortIcon

sortIcon?: ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      • props: {
            sortOrder: SortOrder;
        }
        • sortOrder: SortOrder

      Returns ReactNode

Optional sortOrder

sortOrder?: SortOrder

Optional sorter

sorter?: boolean | CompareFn<RecordType> | {
    compare?: CompareFn<RecordType>;
    multiple?: number;
}

Type declaration

  • Optional compare?: CompareFn<RecordType>
  • Optional multiple?: number

    Config multiple sorter order priority

Optional title

title?: ColumnTitle<RecordType>

Optional width

width?: string | number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc