TanStack Table Adapter API - v0.1.0
    Preparing search index...

    Type Alias TableAdapterProps<TData, TValue>

    type TableAdapterProps<TData extends object, TValue = unknown> = {
        accessibility?: TableAccessibility;
        animations?: TableAnimations;
        ariaDescribedBy?: string;
        ariaLabel?: string;
        ariaLabelledBy?: string;
        autoResetPageIndex?: boolean;
        className?: string;
        classNames?: TableClassNames;
        columnFilters?: ColumnFiltersState;
        columnOrder?: string[];
        columnPinning?: ColumnPinningState;
        columnResizeMode?: ColumnResizeMode;
        columns: ColumnDef<TData, TValue>[];
        columnVisibility?: VisibilityState;
        data: TData[];
        debugTable?: boolean;
        enableColumnFilters?: boolean;
        enableColumnResizing?: boolean;
        enableExpanding?: boolean;
        enableGlobalFilter?: boolean;
        enableGrouping?: boolean;
        enableMultiRemove?: boolean;
        enableMultiSort?: boolean;
        enablePagination?: boolean;
        enablePinning?: boolean;
        enableRowSelection?: boolean;
        enableSorting?: boolean;
        enableSortingRemoval?: boolean;
        enableStickyHeader?: boolean;
        error?: Error | null;
        events?: TableEventHandlers<TData>;
        expanded?: ExpandedState;
        exportOptions?: TableExportOptions;
        features?: Partial<TableFeatures>;
        formIntegration?: TableFormIntegration<TData>;
        getRowId?: (row: TData, index: number, parent?: Row<TData>) => string;
        globalFilter?: string;
        globalFilterFn?: FilterFn<TData>;
        grouping?: string[];
        id?: string;
        isLoading?: boolean;
        isMultiSortEvent?: (e: unknown) => boolean;
        isPaginationLoading?: boolean;
        loading?: TableLoading;
        loadingComponent?: React.ReactNode;
        manualFiltering?: boolean;
        manualGrouping?: boolean;
        manualPagination?: boolean;
        manualSorting?: boolean;
        maxMultiSortColCount?: number;
        onCellClick?: (row: Row<TData>, columnId: string) => void;
        onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>;
        onColumnOrderChange?: OnChangeFn<string[]>;
        onColumnPinningChange?: OnChangeFn<ColumnPinningState>;
        onColumnVisibilityChange?: OnChangeFn<VisibilityState>;
        onExpandedChange?: OnChangeFn<ExpandedState>;
        onExportData?: (data: TData[]) => void;
        onGlobalFilterChange?: OnChangeFn<string>;
        onGroupingChange?: OnChangeFn<string[]>;
        onPaginationChange?: OnChangeFn<PaginationState>;
        onRowClick?: (row: Row<TData>) => void;
        onRowSelectionChange?: OnChangeFn<RowSelectionState>;
        onSortingChange?: OnChangeFn<SortingState>;
        onStateChange?: TableStateHandlers<TData>;
        pageCount?: number;
        pageIndex?: number;
        pageSize?: number;
        pageSizeOptions?: number[];
        paginationLoadingComponent?: React.ReactNode;
        render?: TableRender<TData>;
        renderExpanded?: (row: Row<TData>) => React.ReactNode;
        renderGroupedCell?: (
            info: { cell: any; groupedByKey: string; row: Row<TData> },
        ) => React.ReactNode;
        renderNoResults?: (table: TanStackTable<TData>) => React.ReactNode;
        renderPagination?: (
            props: {
                isLoading?: boolean;
                pageSizeOptions?: number[];
                table: TanStackTable<TData>;
                totalRowCount?: number;
            },
        ) => React.ReactNode;
        renderRowSubComponent?: (row: Row<TData>) => React.ReactNode;
        renderSortIcon?: (direction: "asc" | "desc" | false) => React.ReactNode;
        renderTableFooter?: (table: TanStackTable<TData>) => React.ReactNode;
        renderTableHeader?: (table: TanStackTable<TData>) => React.ReactNode;
        rowSelection?: RowSelectionState;
        server?: TableServer;
        showOverlayLoading?: boolean;
        sorting?: SortingState;
        state?: TableState;
        styling?: TableStyling;
        totalRowCount?: number;
        virtualization?: TableVirtualization;
    }

    Type Parameters

    • TData extends object
    • TValue = unknown
    Index

    Properties

    accessibility?: TableAccessibility
    animations?: TableAnimations
    ariaDescribedBy?: string
    ariaLabel?: string
    ariaLabelledBy?: string
    autoResetPageIndex?: boolean
    className?: string
    classNames?: TableClassNames
    columnFilters?: ColumnFiltersState
    columnOrder?: string[]
    columnPinning?: ColumnPinningState
    columnResizeMode?: ColumnResizeMode
    columns: ColumnDef<TData, TValue>[]
    columnVisibility?: VisibilityState
    data: TData[]
    debugTable?: boolean
    enableColumnFilters?: boolean
    enableColumnResizing?: boolean
    enableExpanding?: boolean
    enableGlobalFilter?: boolean
    enableGrouping?: boolean
    enableMultiRemove?: boolean
    enableMultiSort?: boolean
    enablePagination?: boolean
    enablePinning?: boolean
    enableRowSelection?: boolean
    enableSorting?: boolean
    enableSortingRemoval?: boolean
    enableStickyHeader?: boolean
    error?: Error | null
    events?: TableEventHandlers<TData>
    expanded?: ExpandedState
    exportOptions?: TableExportOptions
    features?: Partial<TableFeatures>
    formIntegration?: TableFormIntegration<TData>
    getRowId?: (row: TData, index: number, parent?: Row<TData>) => string
    globalFilter?: string
    globalFilterFn?: FilterFn<TData>
    grouping?: string[]
    id?: string
    isLoading?: boolean
    isMultiSortEvent?: (e: unknown) => boolean
    isPaginationLoading?: boolean
    loading?: TableLoading
    loadingComponent?: React.ReactNode
    manualFiltering?: boolean
    manualGrouping?: boolean
    manualPagination?: boolean
    manualSorting?: boolean
    maxMultiSortColCount?: number
    onCellClick?: (row: Row<TData>, columnId: string) => void
    onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
    onColumnOrderChange?: OnChangeFn<string[]>
    onColumnPinningChange?: OnChangeFn<ColumnPinningState>
    onColumnVisibilityChange?: OnChangeFn<VisibilityState>
    onExpandedChange?: OnChangeFn<ExpandedState>
    onExportData?: (data: TData[]) => void
    onGlobalFilterChange?: OnChangeFn<string>
    onGroupingChange?: OnChangeFn<string[]>
    onPaginationChange?: OnChangeFn<PaginationState>
    onRowClick?: (row: Row<TData>) => void
    onRowSelectionChange?: OnChangeFn<RowSelectionState>
    onSortingChange?: OnChangeFn<SortingState>
    onStateChange?: TableStateHandlers<TData>
    pageCount?: number
    pageIndex?: number
    pageSize?: number
    pageSizeOptions?: number[]
    paginationLoadingComponent?: React.ReactNode
    render?: TableRender<TData>
    renderExpanded?: (row: Row<TData>) => React.ReactNode
    renderGroupedCell?: (
        info: { cell: any; groupedByKey: string; row: Row<TData> },
    ) => React.ReactNode
    renderNoResults?: (table: TanStackTable<TData>) => React.ReactNode
    renderPagination?: (
        props: {
            isLoading?: boolean;
            pageSizeOptions?: number[];
            table: TanStackTable<TData>;
            totalRowCount?: number;
        },
    ) => React.ReactNode
    renderRowSubComponent?: (row: Row<TData>) => React.ReactNode
    renderSortIcon?: (direction: "asc" | "desc" | false) => React.ReactNode
    renderTableFooter?: (table: TanStackTable<TData>) => React.ReactNode
    renderTableHeader?: (table: TanStackTable<TData>) => React.ReactNode
    rowSelection?: RowSelectionState
    server?: TableServer
    showOverlayLoading?: boolean
    sorting?: SortingState
    state?: TableState
    styling?: TableStyling
    totalRowCount?: number
    virtualization?: TableVirtualization