@chumsinc/sortable-tables 2.2.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/CHANGELOG.md +69 -52
  2. package/README.md +94 -4
  3. package/dist/DataTable.d.ts +6 -6
  4. package/dist/DataTableCell.d.ts +299 -295
  5. package/dist/DataTableCols.d.ts +5 -5
  6. package/dist/DataTableContext.d.ts +10 -0
  7. package/dist/DataTableProvider.d.ts +12 -0
  8. package/dist/DataTableTH.d.ts +6 -6
  9. package/dist/SortableTable.d.ts +6 -6
  10. package/dist/SortableTableHead.d.ts +6 -6
  11. package/dist/SortableTableHeadWrapper.d.ts +9 -0
  12. package/dist/SortableTableTH.d.ts +6 -6
  13. package/dist/StandaloneDataTable.d.ts +6 -0
  14. package/dist/StandaloneSortHelper.d.ts +5 -0
  15. package/dist/StandaloneSortableTable.d.ts +6 -0
  16. package/dist/Table.d.ts +6 -5
  17. package/dist/index.cjs.js +30 -34
  18. package/dist/index.cjs.js.map +1 -1
  19. package/dist/index.d.ts +20 -16
  20. package/dist/index.es.js +521 -471
  21. package/dist/index.es.js.map +1 -1
  22. package/dist/types.d.ts +104 -103
  23. package/dist/useField.d.ts +6 -0
  24. package/dist/useTableContext.d.ts +2 -0
  25. package/dist/useTableFields.d.ts +9 -0
  26. package/dist/useTableSort.d.ts +9 -0
  27. package/package.json +3 -3
  28. package/src/DataTable.tsx +34 -11
  29. package/src/DataTableCell.tsx +33 -28
  30. package/src/DataTableCols.tsx +11 -18
  31. package/src/DataTableContext.ts +13 -0
  32. package/src/DataTableHead.tsx +6 -7
  33. package/src/DataTableProvider.tsx +62 -0
  34. package/src/DataTableRow.tsx +8 -7
  35. package/src/DataTableTBody.tsx +1 -3
  36. package/src/DataTableTH.tsx +4 -3
  37. package/src/RowsPerPage.tsx +2 -4
  38. package/src/SortableTable.tsx +36 -12
  39. package/src/SortableTableHead.tsx +9 -9
  40. package/src/SortableTableHeadWrapper.tsx +20 -0
  41. package/src/SortableTableTH.tsx +4 -4
  42. package/src/StandaloneDataTable.tsx +16 -0
  43. package/src/StandaloneSortHelper.tsx +15 -0
  44. package/src/StandaloneSortableTable.tsx +21 -0
  45. package/src/Table.tsx +49 -44
  46. package/src/TablePagination.tsx +1 -3
  47. package/src/index.tsx +21 -15
  48. package/src/types.ts +127 -126
  49. package/src/useField.ts +19 -0
  50. package/src/useTableContext.ts +10 -0
  51. package/src/useTableFields.ts +20 -0
  52. package/src/useTableSort.ts +20 -0
  53. package/test/Main.tsx +37 -0
  54. package/test/TableColumnsHandler.tsx +9 -9
  55. package/test/TestTable.tsx +51 -46
  56. package/test/data.ts +232 -232
  57. package/test/index.tsx +11 -11
  58. package/test/tableFields.tsx +11 -3
  59. package/test/utils.ts +19 -0
  60. package/tsconfig.json +1 -0
  61. package/dist/DataTableWithContext.d.ts +0 -2
  62. package/dist/SortableTableWithContext.d.ts +0 -2
  63. package/dist/TableProvider.d.ts +0 -17
  64. package/src/DataTableWithContext.tsx +0 -41
  65. package/src/SortableTableWithContext.tsx +0 -44
  66. package/src/TableProvider.tsx +0 -77
@@ -1,77 +0,0 @@
1
- import {createContext, ReactNode, useCallback, useContext, useMemo, useState} from "react";
2
- import {DataTableField} from "./types";
3
-
4
- /* eslint-disable react-refresh/only-export-components */
5
-
6
- export interface TableContextData<T = unknown> {
7
- fields: DataTableField<T>[];
8
- setFields: (next: DataTableField<T>[] | ((prev: DataTableField<T>[]) => DataTableField<T>[])) => void;
9
- updateField: (key: string | number, arg: Partial<DataTableField<T>>) => void;
10
- getField: (key: string | number) => DataTableField<T> | undefined;
11
- }
12
-
13
- const DataTableContext = createContext<TableContextData<unknown> | null>(null)
14
-
15
- export interface TableProviderProps<T = unknown> {
16
- initialFields: DataTableField<T>[];
17
- children: ReactNode;
18
- }
19
-
20
- export default function TableProvider<T = unknown>({children, initialFields = []}: TableProviderProps<T>) {
21
- const [fields, setFieldsState] = useState<DataTableField<T>[]>(initialFields);
22
-
23
- const setFields = useCallback((fields: DataTableField<T>[] | ((prev: DataTableField<T>[]) => DataTableField<T>[])) => {
24
- setFieldsState(fields)
25
- }, []);
26
- const updateField = useCallback((key: string | number, arg: Partial<DataTableField<T>>) => {
27
- const nextState = fields.map(field => {
28
- if (field.id === key) {
29
- return {...field, ...arg}
30
- }
31
- return field;
32
- });
33
- setFieldsState(nextState);
34
- }, [fields])
35
-
36
- const getField = useCallback((key: string | number) => fields.find(field => field.id === key), [fields]);
37
-
38
-
39
- const value = useMemo<TableContextData<T>>(
40
- () => ({
41
- fields, setFields, updateField, getField
42
- }),
43
- [fields, setFields, updateField, getField]
44
- )
45
-
46
- return (
47
- <DataTableContext.Provider value={value as unknown as TableContextData<unknown>}>
48
- {children}
49
- </DataTableContext.Provider>
50
- )
51
- }
52
-
53
-
54
- export function useTableContext<T = unknown>() {
55
- const context = useContext(DataTableContext) as TableContextData<T>;
56
- if (!context) {
57
- throw new Error('useTableContext must be used within a FieldsProvider');
58
- }
59
- return context;
60
- }
61
-
62
- export function useTableFields<T = unknown>() {
63
- return useTableContext<T>().fields;
64
- }
65
-
66
- export function useField<T = unknown>(key: string | number): DataTableField<T> | null {
67
- const context = useContext(DataTableContext) as TableContextData<T>;
68
- if (!context) {
69
- throw new Error('useTableContext must be used within a FieldsProvider');
70
- }
71
- const field = context.fields.find(field => field.id === key);
72
- return field ?? null
73
- }
74
-
75
- export function useHasTableFieldsContext() {
76
- return useContext(DataTableContext) !== null;
77
- }