Interface TableProps<RecordType>

interface TableProps<RecordType> {
    bordered?: boolean;
    caption?: ReactNode;
    children?: ReactNode;
    childrenColumnName?: string;
    className?: string;
    columns?: TableColumnsType<RecordType>;
    components?: TableComponents<RecordType>;
    dataSource?: readonly RecordType[];
    defaultExpandAllRows?: boolean;
    defaultExpandedRowKeys?: Key[];
    direction?: Direction;
    dropdownPrefixCls?: string;
    expandIcon?: RenderExpandIcon<RecordType>;
    expandIconColumnIndex?: number;
    expandRowByClick?: boolean;
    expandable?: ExpandableConfig<RecordType>;
    expandedRowClassName?: RowClassName<RecordType>;
    expandedRowKeys?: Key[];
    expandedRowRender?: ExpandedRowRender<RecordType>;
    footer?: PanelRender<RecordType>;
    getContainerWidth?: ((ele, width) => number);
    getPopupContainer?: GetPopupContainer;
    id?: string;
    indentSize?: number;
    loading?: boolean | Antd.SpinProps;
    locale?: TableLocale;
    onChange?: ((pagination, filters, sorter, extra) => void);
    onExpand?: ((expanded, record) => void);
    onExpandedRowsChange?: ((expandedKeys) => void);
    onHeaderRow?: GetComponentProps<readonly ColumnType<RecordType>[]>;
    onRow?: GetComponentProps<RecordType>;
    pagination?: false | TablePaginationConfig;
    prefixCls?: string;
    rootClassName?: string;
    rowClassName?: string | RowClassName<RecordType>;
    rowKey?: string | keyof RecordType | GetRowKey<RecordType>;
    rowSelection?: TableRowSelection<RecordType>;
    scroll?: {
        x?: string | number | true;
        y?: string | number;
    } & {
        scrollToFirstRowOnChange?: boolean;
    };
    showHeader?: boolean;
    showSorterTooltip?: boolean | TooltipProps;
    size?: SizeType;
    sortDirections?: SortOrder[];
    sticky?: boolean | TableSticky;
    style?: CSSProperties;
    summary?: ((data) => ReactNode);
    tableLayout?: TableLayout;
    tailor?: boolean;
    title?: PanelRender<RecordType>;
    virtual?: boolean;
}

Type Parameters

  • RecordType = any

Hierarchy

  • Omit<RcTableProps<RecordType>, "transformColumns" | "internalHooks" | "internalRefs" | "data" | "columns" | "scroll" | "emptyText">
    • TableProps

Properties

bordered? caption? children? childrenColumnName? className? columns? components? dataSource? defaultExpandAllRows? defaultExpandedRowKeys? direction? dropdownPrefixCls? expandIcon? expandIconColumnIndex? expandRowByClick? expandable? expandedRowClassName? expandedRowKeys? expandedRowRender? footer? getContainerWidth? getPopupContainer? id? indentSize? loading? locale? onChange? onExpand? onExpandedRowsChange? onHeaderRow? onRow? pagination? prefixCls? rootClassName? rowClassName? rowKey? rowSelection? scroll? showHeader? showSorterTooltip? size? sortDirections? sticky? style? summary? tableLayout? tailor? title? virtual?

Properties

Optional bordered

bordered?: boolean

Optional caption

caption?: ReactNode

Optional children

children?: ReactNode

Optional childrenColumnName

childrenColumnName?: string

Deprecated

Use expandable.childrenColumnName instead

Optional className

className?: string

Optional columns

columns?: TableColumnsType<RecordType>

Optional components

components?: TableComponents<RecordType>

Optional dataSource

dataSource?: readonly RecordType[]

Optional defaultExpandAllRows

defaultExpandAllRows?: boolean

Deprecated

Use expandable.defaultExpandAllRows instead

Optional defaultExpandedRowKeys

defaultExpandedRowKeys?: Key[]

Deprecated

Use expandable.defaultExpandedRowKeys instead

Optional direction

direction?: Direction

Optional dropdownPrefixCls

dropdownPrefixCls?: string

Optional expandIcon

expandIcon?: RenderExpandIcon<RecordType>

Deprecated

Use expandable.expandIcon instead

Optional expandIconColumnIndex

expandIconColumnIndex?: number

Deprecated

Use expandable.expandIconColumnIndex instead

Optional expandRowByClick

expandRowByClick?: boolean

Deprecated

Use expandable.expandRowByClick instead

Optional expandable

expandable?: ExpandableConfig<RecordType>

Config expand rows

Optional expandedRowClassName

expandedRowClassName?: RowClassName<RecordType>

Deprecated

Use expandable.expandedRowClassName instead

Optional expandedRowKeys

expandedRowKeys?: Key[]

Deprecated

Use expandable.expandedRowKeys instead

Optional expandedRowRender

expandedRowRender?: ExpandedRowRender<RecordType>

Deprecated

Use expandable.expandedRowRender instead

Optional footer

footer?: PanelRender<RecordType>

Optional Private getContainerWidth

getContainerWidth?: ((ele, width) => number)

Internal usage, may remove by refactor.

!!! DO NOT USE IN PRODUCTION ENVIRONMENT !!!

Type declaration

    • (ele, width): number

    • Internal usage, may remove by refactor.

      !!! DO NOT USE IN PRODUCTION ENVIRONMENT !!!

      Parameters

      Returns number

Optional getPopupContainer

getPopupContainer?: GetPopupContainer

Optional id

id?: string

Optional indentSize

indentSize?: number

Optional loading

loading?: boolean | Antd.SpinProps

Optional locale

locale?: TableLocale

Optional onChange

onChange?: ((pagination, filters, sorter, extra) => void)

Type declaration

Optional onExpand

onExpand?: ((expanded, record) => void)

Type declaration

    • (expanded, record): void

    • Parameters

      Returns void

      Deprecated

      Use expandable.onExpand instead

Deprecated

Use expandable.onExpand instead

Optional onExpandedRowsChange

onExpandedRowsChange?: ((expandedKeys) => void)

Type declaration

    • (expandedKeys): void

    • Parameters

      • expandedKeys: Key[]

      Returns void

      Deprecated

      Use expandable.onExpandedRowsChange instead

Deprecated

Use expandable.onExpandedRowsChange instead

Optional onHeaderRow

onHeaderRow?: GetComponentProps<readonly ColumnType<RecordType>[]>

Optional onRow

onRow?: GetComponentProps<RecordType>

Optional pagination

pagination?: false | TablePaginationConfig

Optional prefixCls

prefixCls?: string

Optional rootClassName

rootClassName?: string

Optional rowClassName

rowClassName?: string | RowClassName<RecordType>

Optional rowKey

rowKey?: string | keyof RecordType | GetRowKey<RecordType>

Optional rowSelection

rowSelection?: TableRowSelection<RecordType>

Optional scroll

scroll?: {
    x?: string | number | true;
    y?: string | number;
} & {
    scrollToFirstRowOnChange?: boolean;
}

Type declaration

  • Optional x?: string | number | true
  • Optional y?: string | number

Type declaration

  • Optional scrollToFirstRowOnChange?: boolean

Optional showHeader

showHeader?: boolean

Optional showSorterTooltip

showSorterTooltip?: boolean | TooltipProps

Optional size

size?: SizeType

Optional sortDirections

sortDirections?: SortOrder[]

Optional sticky

sticky?: boolean | TableSticky

Optional style

style?: CSSProperties

Optional summary

summary?: ((data) => ReactNode)

Type declaration

    • (data): ReactNode

    • Parameters

      Returns ReactNode

Optional tableLayout

tableLayout?: TableLayout

Optional Private tailor

tailor?: boolean

Internal usage, may remove by refactor.

!!! DO NOT USE IN PRODUCTION ENVIRONMENT !!!

Optional title

title?: PanelRender<RecordType>

Optional virtual

virtual?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc