antd-crud-table API
    Preparing search index...

    Interface CrudTableConfig<T, K>

    Everything needed to render a CrudTable.

    interface CrudTableConfig<T extends object, K extends keyof T> {
        columns: readonly CrudColumn<T>[];
        customActions?: (record: T, actions: CrudTableActions<T, K>) => ReactNode[];
        defaultPageSize?: number;
        enableBulkOperations?: boolean;
        enableColumnSettings?: boolean;
        enableExport?: boolean;
        enableImport?: boolean;
        exportScope?: "page" | "all";
        hookConfig: UseCrudTableOptions<T, K>;
        importConcurrency?: number;
        locale?: Partial<CrudTableLocale>;
        rowKey: K;
        title: string;
    }

    Type Parameters

    • T extends object
    • K extends keyof T
    Index
    columns customActions? defaultPageSize? enableBulkOperations? enableColumnSettings? enableExport? enableImport? exportScope? hookConfig importConcurrency? locale? rowKey title
    columns: readonly CrudColumn<T>[]

    Column definitions, each bound to a property of T.

    customActions?: (record: T, actions: CrudTableActions<T, K>) => ReactNode[]

    Extra per-row controls, appended after Edit and Delete.

    defaultPageSize?: number

    Rows per page. Defaults to 10.

    enableBulkOperations?: boolean

    Show row selection and the bulk delete control. Defaults to false.

    enableColumnSettings?: boolean

    Show ProTable's column visibility and density controls. Defaults to true.

    enableExport?: boolean

    Show the export entries in the toolbar menu. Defaults to true.

    enableImport?: boolean

    Show the import entry in the toolbar menu. Defaults to false.

    Import creates records through the data source's create (or createMany when available), so it is only meaningful for a writable source. Opt-in, mirroring how a consumer decides whether the table accepts bulk input.

    exportScope?: "page" | "all"

    Whether export covers the whole filtered result set or just the rows on screen. Defaults to 'all', falling back to 'page' when the data source cannot list without pagination.

    hookConfig: UseCrudTableOptions<T, K>

    Selects and configures the data strategy.

    importConcurrency?: number

    Max simultaneous single-row creates during import. Defaults to 5.

    locale?: Partial<CrudTableLocale>

    Overrides for the library's own wording.

    antd and ProTable chrome follow the surrounding ConfigProvider; this is for the strings the library itself produces. Anything omitted falls back to English.

    rowKey: K

    The property holding each record's identity.

    title: string

    Table header, also used to name exported files.

    Settings
    Member Visibility

    On This Page
    Properties