|
| 1 | +import React from "react"; |
| 2 | +import { ColumnDef, ColumnFiltersState, SortingState, VisibilityState, Table as TanStackTable, RowSelectionState, ColumnResizeMode, PaginationState, ExpandedState, OnChangeFn, FilterFn, Row } from "@tanstack/react-table"; |
| 3 | +export type TableFeatures = { |
| 4 | + pagination?: boolean; |
| 5 | + sorting?: boolean; |
| 6 | + multiSort?: boolean; |
| 7 | + columnFilters?: boolean; |
| 8 | + globalFilter?: boolean; |
| 9 | + columnResizing?: boolean; |
| 10 | + rowSelection?: boolean; |
| 11 | + expanding?: boolean; |
| 12 | + columnOrdering?: boolean; |
| 13 | + pinning?: boolean; |
| 14 | + stickyHeader?: boolean; |
| 15 | + grouping?: boolean; |
| 16 | +}; |
| 17 | +export type TableStyling = { |
| 18 | + className?: string; |
| 19 | + tableClassName?: string; |
| 20 | + headerClassName?: string; |
| 21 | + bodyClassName?: string; |
| 22 | + rowClassName?: string | ((row: any) => string); |
| 23 | + cellClassName?: string | ((row: any, columnId: string) => string); |
| 24 | + columnResizeMode?: ColumnResizeMode; |
| 25 | +}; |
| 26 | +export type TableLoading = { |
| 27 | + isLoading?: boolean; |
| 28 | + isPaginationLoading?: boolean; |
| 29 | + showOverlayLoading?: boolean; |
| 30 | + loadingComponent?: React.ReactNode; |
| 31 | + paginationLoadingComponent?: React.ReactNode; |
| 32 | +}; |
| 33 | +export type TableServer = { |
| 34 | + manualPagination?: boolean; |
| 35 | + manualSorting?: boolean; |
| 36 | + manualFiltering?: boolean; |
| 37 | + manualGrouping?: boolean; |
| 38 | + pageCount?: number; |
| 39 | + autoResetPageIndex?: boolean; |
| 40 | +}; |
| 41 | +export type TableAccessibility = { |
| 42 | + ariaLabel?: string; |
| 43 | + ariaLabelledBy?: string; |
| 44 | + ariaDescribedBy?: string; |
| 45 | +}; |
| 46 | +export type TableRender<TData> = { |
| 47 | + tableHeader?: (table: TanStackTable<TData>) => React.ReactNode; |
| 48 | + tableFooter?: (table: TanStackTable<TData>) => React.ReactNode; |
| 49 | + pagination?: (props: { |
| 50 | + table: TanStackTable<TData>; |
| 51 | + totalRowCount?: number; |
| 52 | + isLoading?: boolean; |
| 53 | + pageSizeOptions?: number[]; |
| 54 | + }) => React.ReactNode; |
| 55 | + noResults?: (table: TanStackTable<TData>) => React.ReactNode; |
| 56 | + expanded?: (row: Row<TData>) => React.ReactNode; |
| 57 | + rowSubComponent?: (row: Row<TData>) => React.ReactNode; |
| 58 | + groupedCell?: (info: { |
| 59 | + row: Row<TData>; |
| 60 | + cell: any; |
| 61 | + groupedByKey: string; |
| 62 | + }) => React.ReactNode; |
| 63 | +}; |
| 64 | +export type TableAdapterProps<TData extends object> = { |
| 65 | + data: TData[]; |
| 66 | + columns: ColumnDef<TData, any>[]; |
| 67 | + totalRowCount?: number; |
| 68 | + id?: string; |
| 69 | + debugTable?: boolean; |
| 70 | + getRowId?: (row: TData, index: number, parent?: Row<TData>) => string; |
| 71 | + className?: string; |
| 72 | + tableClassName?: string; |
| 73 | + headerClassName?: string; |
| 74 | + bodyClassName?: string; |
| 75 | + rowClassName?: string | ((row: Row<TData>) => string); |
| 76 | + cellClassName?: string | ((row: Row<TData>, columnId: string) => string); |
| 77 | + columnResizeMode?: ColumnResizeMode; |
| 78 | + enablePagination?: boolean; |
| 79 | + enableSorting?: boolean; |
| 80 | + enableMultiSort?: boolean; |
| 81 | + enableColumnFilters?: boolean; |
| 82 | + enableGlobalFilter?: boolean; |
| 83 | + enableColumnResizing?: boolean; |
| 84 | + enableRowSelection?: boolean; |
| 85 | + enableExpanding?: boolean; |
| 86 | + enablePinning?: boolean; |
| 87 | + enableStickyHeader?: boolean; |
| 88 | + enableGrouping?: boolean; |
| 89 | + pageSize?: number; |
| 90 | + pageIndex?: number; |
| 91 | + sorting?: SortingState; |
| 92 | + columnFilters?: ColumnFiltersState; |
| 93 | + globalFilter?: string; |
| 94 | + columnVisibility?: VisibilityState; |
| 95 | + rowSelection?: RowSelectionState; |
| 96 | + expanded?: ExpandedState; |
| 97 | + columnOrder?: string[]; |
| 98 | + columnPinning?: { |
| 99 | + left: string[]; |
| 100 | + right: string[]; |
| 101 | + }; |
| 102 | + grouping?: string[]; |
| 103 | + onPaginationChange?: OnChangeFn<PaginationState>; |
| 104 | + onSortingChange?: OnChangeFn<SortingState>; |
| 105 | + onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>; |
| 106 | + onGlobalFilterChange?: OnChangeFn<string>; |
| 107 | + onColumnVisibilityChange?: OnChangeFn<VisibilityState>; |
| 108 | + onRowSelectionChange?: OnChangeFn<RowSelectionState>; |
| 109 | + onExpandedChange?: OnChangeFn<ExpandedState>; |
| 110 | + onColumnOrderChange?: OnChangeFn<string[]>; |
| 111 | + onColumnPinningChange?: OnChangeFn<{ |
| 112 | + left: string[]; |
| 113 | + right: string[]; |
| 114 | + }>; |
| 115 | + onGroupingChange?: OnChangeFn<string[]>; |
| 116 | + manualPagination?: boolean; |
| 117 | + manualSorting?: boolean; |
| 118 | + manualFiltering?: boolean; |
| 119 | + manualGrouping?: boolean; |
| 120 | + pageCount?: number; |
| 121 | + autoResetPageIndex?: boolean; |
| 122 | + globalFilterFn?: FilterFn<TData>; |
| 123 | + renderTableHeader?: (table: TanStackTable<TData>) => React.ReactNode; |
| 124 | + renderTableFooter?: (table: TanStackTable<TData>) => React.ReactNode; |
| 125 | + renderPagination?: (props: { |
| 126 | + table: TanStackTable<TData>; |
| 127 | + totalRowCount?: number; |
| 128 | + isLoading?: boolean; |
| 129 | + pageSizeOptions?: number[]; |
| 130 | + }) => React.ReactNode; |
| 131 | + renderNoResults?: (table: TanStackTable<TData>) => React.ReactNode; |
| 132 | + renderExpanded?: (row: Row<TData>) => React.ReactNode; |
| 133 | + renderRowSubComponent?: (row: Row<TData>) => React.ReactNode; |
| 134 | + renderGroupedCell?: (info: { |
| 135 | + row: Row<TData>; |
| 136 | + cell: any; |
| 137 | + groupedByKey: string; |
| 138 | + }) => React.ReactNode; |
| 139 | + onRowClick?: (row: Row<TData>) => void; |
| 140 | + onCellClick?: (row: Row<TData>, columnId: string) => void; |
| 141 | + onExportData?: (data: TData[]) => void; |
| 142 | + isLoading?: boolean; |
| 143 | + isPaginationLoading?: boolean; |
| 144 | + loadingComponent?: React.ReactNode; |
| 145 | + paginationLoadingComponent?: React.ReactNode; |
| 146 | + showOverlayLoading?: boolean; |
| 147 | + ariaLabel?: string; |
| 148 | + ariaLabelledBy?: string; |
| 149 | + ariaDescribedBy?: string; |
| 150 | + pageSizeOptions?: number[]; |
| 151 | + renderSortIcon?: (direction: "asc" | "desc" | false) => React.ReactNode; |
| 152 | + enableSortingRemoval?: boolean; |
| 153 | +}; |
0 commit comments