@coveord/plasma-mantine 55.3.3 → 55.4.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.
- package/.turbo/turbo-build.log +3 -3
- package/.turbo/turbo-test.log +48 -45
- package/dist/.tsbuildinfo +1 -1
- package/dist/cjs/components/date-range-picker/DateRangePickerInlineCalendar.d.ts.map +1 -1
- package/dist/cjs/components/date-range-picker/DateRangePickerInlineCalendar.js +21 -3
- package/dist/cjs/components/date-range-picker/DateRangePickerInlineCalendar.js.map +1 -1
- package/dist/cjs/components/table/use-table.d.ts +10 -4
- package/dist/cjs/components/table/use-table.d.ts.map +1 -1
- package/dist/cjs/components/table/use-table.js +184 -12
- package/dist/cjs/components/table/use-table.js.map +1 -1
- package/dist/cjs/components/table/use-url-synced-state.d.ts +29 -0
- package/dist/cjs/components/table/use-url-synced-state.d.ts.map +1 -0
- package/dist/cjs/components/table/use-url-synced-state.js +58 -0
- package/dist/cjs/components/table/use-url-synced-state.js.map +1 -0
- package/dist/esm/components/date-range-picker/DateRangePickerInlineCalendar.d.ts.map +1 -1
- package/dist/esm/components/date-range-picker/DateRangePickerInlineCalendar.js +15 -2
- package/dist/esm/components/date-range-picker/DateRangePickerInlineCalendar.js.map +1 -1
- package/dist/esm/components/table/use-table.d.ts +10 -4
- package/dist/esm/components/table/use-table.d.ts.map +1 -1
- package/dist/esm/components/table/use-table.js +127 -8
- package/dist/esm/components/table/use-table.js.map +1 -1
- package/dist/esm/components/table/use-url-synced-state.d.ts +29 -0
- package/dist/esm/components/table/use-url-synced-state.d.ts.map +1 -0
- package/dist/esm/components/table/use-url-synced-state.js +41 -0
- package/dist/esm/components/table/use-url-synced-state.js.map +1 -0
- package/package.json +8 -8
- package/src/components/date-range-picker/DateRangePickerInlineCalendar.tsx +15 -1
- package/src/components/date-range-picker/__tests__/DateRangePickerInlineCalendar.spec.tsx +6 -4
- package/src/components/table/__tests__/TableColumnsSelector.spec.tsx +51 -0
- package/src/components/table/__tests__/TableDateRangePicker.spec.tsx +53 -1
- package/src/components/table/__tests__/TableFilter.spec.tsx +43 -0
- package/src/components/table/__tests__/TablePagination.spec.tsx +54 -0
- package/src/components/table/__tests__/TablePerPage.spec.tsx +55 -0
- package/src/components/table/__tests__/TablePredicate.spec.tsx +69 -0
- package/src/components/table/__tests__/Th.spec.tsx +35 -0
- package/src/components/table/__tests__/use-url-synced-state.unit.spec.ts +113 -0
- package/src/components/table/use-table.ts +120 -15
- package/src/components/table/use-url-synced-state.ts +70 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/components/date-range-picker/DateRangePickerInlineCalendar.tsx"],"sourcesContent":["import {Center, Group, Space} from '@mantine/core';\nimport {DatePicker, DatePickerBaseProps} from '@mantine/dates';\nimport {useForm} from '@mantine/form';\n\nimport {Button} from '../button';\nimport DateRangeClasses from './DateRange.module.css';\nimport {DateRangePickerPreset, DateRangePickerPresetSelect} from './DateRangePickerPresetSelect';\nimport {EditableDateRangePicker, EditableDateRangePickerProps} from './EditableDateRangePicker';\n\nexport type DateRangePickerValue = [Date | null, Date | null];\nexport interface DateRangePickerInlineCalendarProps\n extends Pick<EditableDateRangePickerProps, 'startProps' | 'endProps'> {\n /**\n * Initial selected range\n */\n initialRange: DateRangePickerValue;\n /**\n * Function called when the user applies the new date range\n *\n * @param range the newly selected dates\n */\n onApply: (range: DateRangePickerValue) => void;\n /**\n * Function called when the user click on the cancel button\n */\n onCancel: () => void;\n /**\n * The presets to display\n *\n * @default {}\n * @example\n * {\n * january: {label: 'January', range: [new Date(2022, 0, 1), new Date(2022, 0, 31)]},\n * february: {label: 'February', range: [new Date(2022, 1, 1), new Date(2022, 1, 28)]}\n * }\n */\n presets?: Record<string, DateRangePickerPreset>;\n /**\n * Props for RangeCalendar displayed in the popover\n */\n rangeCalendarProps?: Omit<\n DatePickerBaseProps,\n 'value' | 'onChange' | 'isDateInRange' | 'isDateFirstInRange' | 'isDateLastInRange'\n >;\n}\n\nexport const DateRangePickerInlineCalendar = ({\n initialRange,\n onApply,\n onCancel,\n presets,\n startProps,\n endProps,\n rangeCalendarProps,\n}: DateRangePickerInlineCalendarProps) => {\n const form = useForm({\n initialValues: {\n dates: initialRange,\n },\n });\n const calendarInputProps = form.getInputProps('dates');\n\n const onCalendarApply = () => {\n if (!form.values.dates[1]) {\n form.values.dates[1] = form.values.dates[0]
|
|
1
|
+
{"version":3,"sources":["../../../../src/components/date-range-picker/DateRangePickerInlineCalendar.tsx"],"sourcesContent":["import {Center, Group, Space} from '@mantine/core';\nimport {DatePicker, DatePickerBaseProps} from '@mantine/dates';\nimport {useForm} from '@mantine/form';\n\nimport dayjs from 'dayjs';\nimport {Button} from '../button';\nimport DateRangeClasses from './DateRange.module.css';\nimport {DateRangePickerPreset, DateRangePickerPresetSelect} from './DateRangePickerPresetSelect';\nimport {EditableDateRangePicker, EditableDateRangePickerProps} from './EditableDateRangePicker';\n\nexport type DateRangePickerValue = [Date | null, Date | null];\nexport interface DateRangePickerInlineCalendarProps\n extends Pick<EditableDateRangePickerProps, 'startProps' | 'endProps'> {\n /**\n * Initial selected range\n */\n initialRange: DateRangePickerValue;\n /**\n * Function called when the user applies the new date range\n *\n * @param range the newly selected dates\n */\n onApply: (range: DateRangePickerValue) => void;\n /**\n * Function called when the user click on the cancel button\n */\n onCancel: () => void;\n /**\n * The presets to display\n *\n * @default {}\n * @example\n * {\n * january: {label: 'January', range: [new Date(2022, 0, 1), new Date(2022, 0, 31)]},\n * february: {label: 'February', range: [new Date(2022, 1, 1), new Date(2022, 1, 28)]}\n * }\n */\n presets?: Record<string, DateRangePickerPreset>;\n /**\n * Props for RangeCalendar displayed in the popover\n */\n rangeCalendarProps?: Omit<\n DatePickerBaseProps,\n 'value' | 'onChange' | 'isDateInRange' | 'isDateFirstInRange' | 'isDateLastInRange'\n >;\n}\n\nconst isDateRangePickerValue = (value: unknown): value is DateRangePickerValue =>\n Array.isArray(value) && value.length === 2;\n\nconst endOfDay = (value: Date): Date => (value ? dayjs(value).endOf('day').toDate() : value);\n\nexport const DateRangePickerInlineCalendar = ({\n initialRange,\n onApply,\n onCancel,\n presets,\n startProps,\n endProps,\n rangeCalendarProps,\n}: DateRangePickerInlineCalendarProps) => {\n const form = useForm({\n initialValues: {\n dates: initialRange,\n },\n });\n const calendarInputProps = form.getInputProps('dates');\n\n const onCalendarChange = (range: Date | Date[] | DateRangePickerValue): void => {\n const normalized = isDateRangePickerValue(range) && range[1] ? [range[0], endOfDay(range[1])] : range;\n calendarInputProps.onChange(normalized);\n };\n\n const onCalendarApply = () => {\n // In case the user only clicked the start date, but not the end date,\n // assume a single day was meant to be selected.\n if (!form.values.dates[1]) {\n form.values.dates[1] = endOfDay(form.values.dates[0]);\n }\n onApply(form.values.dates);\n };\n\n return (\n <>\n <Group align=\"center\" gap=\"xs\" grow px=\"md\" py=\"sm\" className={DateRangeClasses.picker}>\n <EditableDateRangePicker\n value={calendarInputProps.value}\n {...calendarInputProps}\n startProps={startProps}\n endProps={endProps}\n />\n {presets ? (\n <>\n <Space w=\"sm\" />\n <DateRangePickerPresetSelect\n value={calendarInputProps.value}\n presets={presets}\n {...calendarInputProps}\n selectProps={{comboboxProps: {withinPortal: false}}}\n />\n </>\n ) : null}\n </Group>\n\n <Center py=\"sm\" px=\"md\">\n <DatePicker\n numberOfColumns={2}\n columnsToScroll={1}\n type=\"range\"\n styles={{day: {textAlign: 'center'}}}\n firstDayOfWeek={0}\n allowSingleDateInRange\n {...rangeCalendarProps}\n {...calendarInputProps}\n onChange={onCalendarChange}\n />\n </Center>\n\n <Group justify=\"right\" gap=\"xs\" px=\"md\" py=\"sm\" className={DateRangeClasses.save}>\n <Button variant=\"outline\" size=\"xs\" onClick={onCancel}>\n Cancel\n </Button>\n <Button size=\"xs\" onClick={onCalendarApply}>\n Apply\n </Button>\n </Group>\n </>\n );\n};\n"],"names":["Center","Group","Space","DatePicker","useForm","dayjs","Button","DateRangeClasses","DateRangePickerPresetSelect","EditableDateRangePicker","isDateRangePickerValue","value","Array","isArray","length","endOfDay","endOf","toDate","DateRangePickerInlineCalendar","initialRange","onApply","onCancel","presets","startProps","endProps","rangeCalendarProps","form","initialValues","dates","calendarInputProps","getInputProps","onCalendarChange","range","normalized","onChange","onCalendarApply","values","align","gap","grow","px","py","className","picker","w","selectProps","comboboxProps","withinPortal","numberOfColumns","columnsToScroll","type","styles","day","textAlign","firstDayOfWeek","allowSingleDateInRange","justify","save","variant","size","onClick"],"mappings":";AAAA,SAAQA,MAAM,EAAEC,KAAK,EAAEC,KAAK,QAAO,gBAAgB;AACnD,SAAQC,UAAU,QAA4B,iBAAiB;AAC/D,SAAQC,OAAO,QAAO,gBAAgB;AAEtC,OAAOC,WAAW,QAAQ;AAC1B,SAAQC,MAAM,QAAO,YAAY;AACjC,OAAOC,sBAAsB,yBAAyB;AACtD,SAA+BC,2BAA2B,QAAO,gCAAgC;AACjG,SAAQC,uBAAuB,QAAqC,4BAA4B;AAuChG,MAAMC,yBAAyB,CAACC,QAC5BC,MAAMC,OAAO,CAACF,UAAUA,MAAMG,MAAM,KAAK;AAE7C,MAAMC,WAAW,CAACJ,QAAuBA,QAAQN,MAAMM,OAAOK,KAAK,CAAC,OAAOC,MAAM,KAAKN;AAEtF,OAAO,MAAMO,gCAAgC,CAAC,EAC1CC,YAAY,EACZC,OAAO,EACPC,QAAQ,EACRC,OAAO,EACPC,UAAU,EACVC,QAAQ,EACRC,kBAAkB,EACe;IACjC,MAAMC,OAAOtB,QAAQ;QACjBuB,eAAe;YACXC,OAAOT;QACX;IACJ;IACA,MAAMU,qBAAqBH,KAAKI,aAAa,CAAC;IAE9C,MAAMC,mBAAmB,CAACC;QACtB,MAAMC,aAAavB,uBAAuBsB,UAAUA,KAAK,CAAC,EAAE,GAAG;YAACA,KAAK,CAAC,EAAE;YAAEjB,SAASiB,KAAK,CAAC,EAAE;SAAE,GAAGA;QAChGH,mBAAmBK,QAAQ,CAACD;IAChC;IAEA,MAAME,kBAAkB;QACpB,sEAAsE;QACtE,gDAAgD;QAChD,IAAI,CAACT,KAAKU,MAAM,CAACR,KAAK,CAAC,EAAE,EAAE;YACvBF,KAAKU,MAAM,CAACR,KAAK,CAAC,EAAE,GAAGb,SAASW,KAAKU,MAAM,CAACR,KAAK,CAAC,EAAE;QACxD;QACAR,QAAQM,KAAKU,MAAM,CAACR,KAAK;IAC7B;IAEA,qBACI;;0BACI,MAAC3B;gBAAMoC,OAAM;gBAASC,KAAI;gBAAKC,IAAI;gBAACC,IAAG;gBAAKC,IAAG;gBAAKC,WAAWnC,iBAAiBoC,MAAM;;kCAClF,KAAClC;wBACGE,OAAOkB,mBAAmBlB,KAAK;wBAC9B,GAAGkB,kBAAkB;wBACtBN,YAAYA;wBACZC,UAAUA;;oBAEbF,wBACG;;0CACI,KAACpB;gCAAM0C,GAAE;;0CACT,KAACpC;gCACGG,OAAOkB,mBAAmBlB,KAAK;gCAC/BW,SAASA;gCACR,GAAGO,kBAAkB;gCACtBgB,aAAa;oCAACC,eAAe;wCAACC,cAAc;oCAAK;gCAAC;;;yBAG1D;;;0BAGR,KAAC/C;gBAAOyC,IAAG;gBAAKD,IAAG;0BACf,cAAA,KAACrC;oBACG6C,iBAAiB;oBACjBC,iBAAiB;oBACjBC,MAAK;oBACLC,QAAQ;wBAACC,KAAK;4BAACC,WAAW;wBAAQ;oBAAC;oBACnCC,gBAAgB;oBAChBC,sBAAsB;oBACrB,GAAG9B,kBAAkB;oBACrB,GAAGI,kBAAkB;oBACtBK,UAAUH;;;0BAIlB,MAAC9B;gBAAMuD,SAAQ;gBAAQlB,KAAI;gBAAKE,IAAG;gBAAKC,IAAG;gBAAKC,WAAWnC,iBAAiBkD,IAAI;;kCAC5E,KAACnD;wBAAOoD,SAAQ;wBAAUC,MAAK;wBAAKC,SAASvC;kCAAU;;kCAGvD,KAACf;wBAAOqD,MAAK;wBAAKC,SAASzB;kCAAiB;;;;;;AAM5D,EAAE"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { type ExpandedState, type PaginationState, type SortingState } from '@tanstack/table-core';
|
|
2
2
|
import { Dispatch, SetStateAction } from 'react';
|
|
3
3
|
import { type DateRangePickerValue } from '../date-range-picker';
|
|
4
|
-
type
|
|
5
|
-
[P in keyof T]?:
|
|
6
|
-
}
|
|
4
|
+
type DeepPartial<T> = {
|
|
5
|
+
[P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
|
|
6
|
+
};
|
|
7
7
|
export interface TableState<TData = unknown> {
|
|
8
8
|
/**
|
|
9
9
|
* Current pagination state
|
|
@@ -156,7 +156,7 @@ export interface UseTableOptions<TData = unknown> {
|
|
|
156
156
|
/**
|
|
157
157
|
* Initial state of the table.
|
|
158
158
|
*/
|
|
159
|
-
initialState?:
|
|
159
|
+
initialState?: DeepPartial<TableState<TData>>;
|
|
160
160
|
/**
|
|
161
161
|
* Whether rows can be selected.
|
|
162
162
|
*
|
|
@@ -176,6 +176,12 @@ export interface UseTableOptions<TData = unknown> {
|
|
|
176
176
|
* @default false
|
|
177
177
|
*/
|
|
178
178
|
forceSelection?: boolean;
|
|
179
|
+
/**
|
|
180
|
+
* Whether to sync the table state with the URL.
|
|
181
|
+
*
|
|
182
|
+
* @default false
|
|
183
|
+
*/
|
|
184
|
+
syncWithUrl?: boolean;
|
|
179
185
|
}
|
|
180
186
|
export declare const useTable: <TData>(userOptions?: UseTableOptions<TData>) => TableStore<TData>;
|
|
181
187
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-table.d.ts","sourceRoot":"","sources":["../../../../src/components/table/use-table.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,KAAK,aAAa,EAAE,KAAK,eAAe,EAAE,KAAK,YAAY,EAAC,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAC,QAAQ,EAAE,cAAc,EAAiC,MAAM,OAAO,CAAC;AAC/E,OAAO,EAAC,KAAK,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"use-table.d.ts","sourceRoot":"","sources":["../../../../src/components/table/use-table.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,KAAK,aAAa,EAAE,KAAK,eAAe,EAAE,KAAK,YAAY,EAAC,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAC,QAAQ,EAAE,cAAc,EAAiC,MAAM,OAAO,CAAC;AAC/E,OAAO,EAAC,KAAK,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAI/D,KAAK,WAAW,CAAC,CAAC,IAAI;KACjB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,WAAW,UAAU,CAAC,KAAK,GAAG,OAAO;IACvC;;;;OAIG;IACH,UAAU,EAAE,eAAe,CAAC;IAC5B;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;;OAIG;IACH,OAAO,EAAE,YAAY,CAAC;IACtB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,EAAE,aAAa,CAAC;IACxB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;;;OAIG;IACH,SAAS,EAAE,oBAAoB,CAAC;IAChC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACpC;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,UAAU,CAAC,KAAK,GAAG,OAAO;IACvC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACzB;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACzE;;OAEG;IACH,eAAe,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7E;;OAEG;IACH,UAAU,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACnE;;OAEG;IACH,eAAe,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7E;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACrE;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACzE;;OAEG;IACH,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACjE;;OAEG;IACH,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IACvE;;OAEG;IACH,eAAe,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7E;;OAEG;IACH,mBAAmB,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IACrF;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,IAAI,CAAC;IAC9B;;OAEG;IACH,eAAe,EAAE,MAAM,KAAK,EAAE,CAAC;IAC/B;;OAEG;IACH,cAAc,EAAE,MAAM,KAAK,GAAG,IAAI,CAAC;IACnC;;OAEG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,OAAO;IAC5C;;OAEG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAwBD,eAAO,MAAM,QAAQ,GAAI,KAAK,gBAAe,eAAe,CAAC,KAAK,CAAC,KAAQ,UAAU,CAAC,KAAK,CAgN1F,CAAC"}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { useDidUpdate } from '@mantine/hooks';
|
|
2
2
|
import defaultsDeep from 'lodash.defaultsdeep';
|
|
3
3
|
import { useCallback, useMemo, useState } from 'react';
|
|
4
|
+
import { useUrlSyncedState } from './use-url-synced-state';
|
|
4
5
|
const defaultOptions = {
|
|
5
6
|
enableRowSelection: true,
|
|
6
7
|
enableMultiRowSelection: false,
|
|
7
|
-
forceSelection: false
|
|
8
|
+
forceSelection: false,
|
|
9
|
+
syncWithUrl: false
|
|
8
10
|
};
|
|
9
11
|
const defaultState = {
|
|
10
12
|
pagination: {
|
|
@@ -26,17 +28,134 @@ const defaultState = {
|
|
|
26
28
|
export const useTable = (userOptions = {})=>{
|
|
27
29
|
const options = defaultsDeep({}, userOptions, defaultOptions);
|
|
28
30
|
const initialState = defaultsDeep({}, options.initialState, defaultState);
|
|
29
|
-
|
|
31
|
+
// synced with url
|
|
32
|
+
const [pagination, setPagination] = useUrlSyncedState({
|
|
33
|
+
initialState: initialState.pagination,
|
|
34
|
+
serializer: ({ pageIndex, pageSize })=>[
|
|
35
|
+
[
|
|
36
|
+
'page',
|
|
37
|
+
(pageIndex + 1).toString()
|
|
38
|
+
],
|
|
39
|
+
[
|
|
40
|
+
'pageSize',
|
|
41
|
+
pageSize.toString()
|
|
42
|
+
]
|
|
43
|
+
],
|
|
44
|
+
deserializer: (params)=>defaultsDeep({
|
|
45
|
+
pageIndex: params.get('page') ? parseInt(params.get('page'), 10) - 1 : undefined,
|
|
46
|
+
pageSize: params.get('pageSize') ? parseInt(params.get('pageSize'), 10) : undefined
|
|
47
|
+
}, initialState.pagination),
|
|
48
|
+
sync: options.syncWithUrl
|
|
49
|
+
});
|
|
50
|
+
const [sorting, setSorting] = useUrlSyncedState({
|
|
51
|
+
initialState: initialState.sorting,
|
|
52
|
+
serializer: (_sorting)=>[
|
|
53
|
+
[
|
|
54
|
+
'sortBy',
|
|
55
|
+
_sorting.map(({ id, desc })=>`${id}.${desc ? 'desc' : 'asc'}`).join(',')
|
|
56
|
+
]
|
|
57
|
+
],
|
|
58
|
+
deserializer: (params)=>{
|
|
59
|
+
if (!params.has('sortBy')) {
|
|
60
|
+
return initialState.sorting;
|
|
61
|
+
}
|
|
62
|
+
const sorts = params.get('sortBy')?.split(',') ?? [];
|
|
63
|
+
return sorts.map((sort)=>{
|
|
64
|
+
const [id, order] = sort.split('.');
|
|
65
|
+
return {
|
|
66
|
+
id,
|
|
67
|
+
desc: order === 'desc'
|
|
68
|
+
};
|
|
69
|
+
});
|
|
70
|
+
},
|
|
71
|
+
sync: options.syncWithUrl
|
|
72
|
+
});
|
|
73
|
+
const [globalFilter, setGlobalFilter] = useUrlSyncedState({
|
|
74
|
+
initialState: initialState.globalFilter,
|
|
75
|
+
serializer: (filter)=>[
|
|
76
|
+
[
|
|
77
|
+
'filter',
|
|
78
|
+
filter
|
|
79
|
+
]
|
|
80
|
+
],
|
|
81
|
+
deserializer: (params)=>params.get('filter') ?? initialState.globalFilter,
|
|
82
|
+
sync: options.syncWithUrl
|
|
83
|
+
});
|
|
84
|
+
const [predicates, setPredicates] = useUrlSyncedState({
|
|
85
|
+
initialState: initialState.predicates,
|
|
86
|
+
serializer: (_predicates)=>Object.entries(_predicates).map(([key, value])=>[
|
|
87
|
+
key,
|
|
88
|
+
value
|
|
89
|
+
]),
|
|
90
|
+
deserializer: (params)=>Object.keys(initialState.predicates).reduce((acc, predicateKey)=>{
|
|
91
|
+
acc[predicateKey] = params.get(predicateKey) ?? initialState.predicates[predicateKey];
|
|
92
|
+
return acc;
|
|
93
|
+
}, {}),
|
|
94
|
+
sync: options.syncWithUrl
|
|
95
|
+
});
|
|
96
|
+
const [layout, setLayout] = useUrlSyncedState({
|
|
97
|
+
initialState: initialState.layout,
|
|
98
|
+
serializer: (_layout)=>[
|
|
99
|
+
[
|
|
100
|
+
'layout',
|
|
101
|
+
_layout
|
|
102
|
+
]
|
|
103
|
+
],
|
|
104
|
+
deserializer: (params)=>params.get('layout') ?? initialState.layout,
|
|
105
|
+
sync: options.syncWithUrl
|
|
106
|
+
});
|
|
107
|
+
const [dateRange, setDateRange] = useUrlSyncedState({
|
|
108
|
+
initialState: initialState.dateRange,
|
|
109
|
+
serializer: ([from, to])=>[
|
|
110
|
+
[
|
|
111
|
+
'from',
|
|
112
|
+
from?.toISOString() ?? ''
|
|
113
|
+
],
|
|
114
|
+
[
|
|
115
|
+
'to',
|
|
116
|
+
to?.toISOString() ?? ''
|
|
117
|
+
]
|
|
118
|
+
],
|
|
119
|
+
deserializer: (params)=>[
|
|
120
|
+
params.get('from') ? new Date(params.get('from')) : initialState.dateRange[0],
|
|
121
|
+
params.get('to') ? new Date(params.get('to')) : initialState.dateRange[1]
|
|
122
|
+
],
|
|
123
|
+
sync: options.syncWithUrl
|
|
124
|
+
});
|
|
125
|
+
const [columnVisibility, setColumnVisibility] = useUrlSyncedState({
|
|
126
|
+
initialState: initialState.columnVisibility,
|
|
127
|
+
serializer: (columns)=>[
|
|
128
|
+
[
|
|
129
|
+
'show',
|
|
130
|
+
Object.entries(columns).filter(([, visible])=>visible === true).map(([columnName])=>columnName).join(',')
|
|
131
|
+
],
|
|
132
|
+
[
|
|
133
|
+
'hide',
|
|
134
|
+
Object.entries(columns).filter(([, visible])=>visible === false).map(([columnName])=>columnName).join(',')
|
|
135
|
+
]
|
|
136
|
+
],
|
|
137
|
+
deserializer: (params)=>{
|
|
138
|
+
if (!params.has('show') && !params.has('hide')) {
|
|
139
|
+
return initialState.columnVisibility;
|
|
140
|
+
}
|
|
141
|
+
const visible = params.get('show')?.split(',') ?? [];
|
|
142
|
+
const invisible = params.get('hide')?.split(',') ?? [];
|
|
143
|
+
const columns = {};
|
|
144
|
+
visible.forEach((column)=>{
|
|
145
|
+
columns[column] = true;
|
|
146
|
+
});
|
|
147
|
+
invisible.forEach((column)=>{
|
|
148
|
+
columns[column] = false;
|
|
149
|
+
});
|
|
150
|
+
return columns;
|
|
151
|
+
},
|
|
152
|
+
sync: options.syncWithUrl
|
|
153
|
+
});
|
|
154
|
+
// unsynced
|
|
30
155
|
const [totalEntries, _setTotalEntries] = useState(initialState.totalEntries);
|
|
31
156
|
const [unfilteredTotalEntries, setUnfilteredTotalEntries] = useState(initialState.totalEntries);
|
|
32
|
-
const [sorting, setSorting] = useState(initialState.sorting);
|
|
33
|
-
const [globalFilter, setGlobalFilter] = useState(initialState.globalFilter);
|
|
34
157
|
const [expanded, setExpanded] = useState(initialState.expanded);
|
|
35
|
-
const [predicates, setPredicates] = useState(initialState.predicates);
|
|
36
|
-
const [layout, setLayout] = useState(initialState.layout);
|
|
37
|
-
const [dateRange, setDateRange] = useState(initialState.dateRange);
|
|
38
158
|
const [rowSelection, setRowSelection] = useState(initialState.rowSelection);
|
|
39
|
-
const [columnVisibility, setColumnVisibility] = useState(initialState.columnVisibility);
|
|
40
159
|
const isFiltered = !!globalFilter || Object.keys(predicates).some((predicate)=>!!predicates[predicate]) || !!dateRange?.[0] || !!dateRange?.[1];
|
|
41
160
|
const isVacant = unfilteredTotalEntries === 0;
|
|
42
161
|
const setTotalEntries = useCallback((updater)=>{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/components/table/use-table.ts"],"sourcesContent":["import {useDidUpdate} from '@mantine/hooks';\nimport {type ExpandedState, type PaginationState, type SortingState} from '@tanstack/table-core';\nimport defaultsDeep from 'lodash.defaultsdeep';\nimport {Dispatch, SetStateAction, useCallback, useMemo, useState} from 'react';\nimport {type DateRangePickerValue} from '../date-range-picker';\n\n// Create a deeply optional version of another type\ntype PartialDeep<T> = T extends object\n ? {\n [P in keyof T]?: PartialDeep<T[P]>;\n }\n : T;\n\nexport interface TableState<TData = unknown> {\n /**\n * Current pagination state\n *\n * @default { pageIndex: 0, pageSize: 50 }\n */\n pagination: PaginationState;\n /**\n * Total number of entries in the table.\n * This number is used to calculate the number of pages in the pagination.\n * When null, the number of pages is calculated using the current data length.\n *\n * @default null\n */\n totalEntries: number | null;\n /**\n * Current sorting state\n *\n * @default []\n */\n sorting: SortingState;\n /**\n * Current global filter value\n *\n * @default ''\n */\n globalFilter: string;\n\n /**\n * Current expanded state\n *\n * @default {}\n */\n expanded: ExpandedState;\n /**\n * Predicates and their current value\n *\n * @default {}\n */\n predicates: Record<string, string>;\n /**\n * Layout currently selected. When null, the first layout is used.\n *\n * @default null\n */\n layout: string | null;\n /**\n * Currently selected date range\n *\n * @default [null, null]\n */\n dateRange: DateRangePickerValue;\n /**\n * Currently selected rows\n *\n * @default {}\n */\n rowSelection: Record<string, TData>;\n /**\n * Columns that are currently visible\n *\n * @default {}\n */\n columnVisibility: Record<string, boolean>;\n}\n\nexport interface TableStore<TData = unknown> {\n /**\n * Current state of the table.\n */\n state: TableState<TData>;\n /**\n * Allows to change the pagination state.\n */\n setPagination: Dispatch<SetStateAction<TableState<TData>['pagination']>>;\n /**\n * Allows to change the total number of entries.\n */\n setTotalEntries: Dispatch<SetStateAction<TableState<TData>['totalEntries']>>;\n /**\n * Allows to change the sorting state.\n */\n setSorting: Dispatch<SetStateAction<TableState<TData>['sorting']>>;\n /**\n * Allows to change the global filter value.\n */\n setGlobalFilter: Dispatch<SetStateAction<TableState<TData>['globalFilter']>>;\n /**\n * Allows to change the rows expanded state.\n */\n setExpanded: Dispatch<SetStateAction<TableState<TData>['expanded']>>;\n /**\n * Allows to change the predicates values.\n */\n setPredicates: Dispatch<SetStateAction<TableState<TData>['predicates']>>;\n /**\n * Allows to change the selected layout.\n */\n setLayout: Dispatch<SetStateAction<TableState<TData>['layout']>>;\n /**\n * Allows to change the selected date range.\n */\n setDateRange: Dispatch<SetStateAction<TableState<TData>['dateRange']>>;\n /**\n * Allows to change the current row selection.\n */\n setRowSelection: Dispatch<SetStateAction<TableState<TData>['rowSelection']>>;\n /**\n * Allows to change the visible columns.\n */\n setColumnVisibility: Dispatch<SetStateAction<TableState<TData>['columnVisibility']>>;\n /**\n * Whether the table is currently filtered.\n */\n isFiltered: boolean;\n /**\n * Whether the table has data when unfiltered.\n *\n * This is derived from the totalEntries so make sure you set that number correctly, even if you're using a client side table.\n */\n isVacant: boolean;\n /**\n * Clear currently applied filters.\n */\n clearFilters: () => void;\n /**\n * Deselects all currently selected rows.\n */\n clearRowSelection: () => void;\n /**\n * Get currently selected rows.\n */\n getSelectedRows: () => TData[];\n /**\n * Get currently selected row\n */\n getSelectedRow: () => TData | null;\n /**\n * Whether the user can select multiple rows at the same time.\n */\n multiRowSelectionEnabled: boolean;\n /**\n * Whether rows can be selected.\n */\n rowSelectionEnabled: boolean;\n /**\n * Whether row selection is forced.\n */\n rowSelectionForced: boolean;\n}\n\nexport interface UseTableOptions<TData = unknown> {\n /**\n * Initial state of the table.\n */\n initialState?: PartialDeep<TableState<TData>>;\n /**\n * Whether rows can be selected.\n *\n * @default true\n */\n enableRowSelection?: boolean;\n /**\n * Whether multiple rows can be selected at the same time.\n *\n * @default false\n */\n enableMultiRowSelection?: boolean;\n /**\n * Forces the user to always have one row selected.\n * When activating that setting, a good practice is to have a row already selected in the initial state.\n *\n * @default false\n */\n forceSelection?: boolean;\n}\n\nconst defaultOptions: UseTableOptions = {\n enableRowSelection: true,\n enableMultiRowSelection: false,\n forceSelection: false,\n};\n\nconst defaultState: Partial<TableState> = {\n pagination: {\n pageIndex: 0,\n pageSize: 50,\n },\n totalEntries: null,\n sorting: [],\n globalFilter: '',\n predicates: {},\n layout: null,\n dateRange: [null, null],\n rowSelection: {},\n columnVisibility: {},\n};\n\nexport const useTable = <TData>(userOptions: UseTableOptions<TData> = {}): TableStore<TData> => {\n const options = defaultsDeep({}, userOptions, defaultOptions) as UseTableOptions<TData>;\n const initialState = defaultsDeep({}, options.initialState, defaultState) as TableState<TData>;\n\n const [pagination, setPagination] = useState<TableState<TData>['pagination']>(initialState.pagination);\n const [totalEntries, _setTotalEntries] = useState<TableState<TData>['totalEntries']>(initialState.totalEntries);\n const [unfilteredTotalEntries, setUnfilteredTotalEntries] = useState<TableState<TData>['totalEntries']>(\n initialState.totalEntries,\n );\n const [sorting, setSorting] = useState<TableState<TData>['sorting']>(initialState.sorting);\n const [globalFilter, setGlobalFilter] = useState<TableState<TData>['globalFilter']>(initialState.globalFilter);\n const [expanded, setExpanded] = useState<TableState<TData>['expanded']>(initialState.expanded);\n const [predicates, setPredicates] = useState<TableState<TData>['predicates']>(initialState.predicates);\n const [layout, setLayout] = useState<TableState<TData>['layout']>(initialState.layout);\n const [dateRange, setDateRange] = useState<TableState<TData>['dateRange']>(initialState.dateRange);\n const [rowSelection, setRowSelection] = useState<TableState<TData>['rowSelection']>(initialState.rowSelection);\n const [columnVisibility, setColumnVisibility] = useState<TableState<TData>['columnVisibility']>(\n initialState.columnVisibility,\n );\n\n const isFiltered =\n !!globalFilter ||\n Object.keys(predicates).some((predicate) => !!predicates[predicate]) ||\n !!dateRange?.[0] ||\n !!dateRange?.[1];\n\n const isVacant = unfilteredTotalEntries === 0;\n\n const setTotalEntries: typeof _setTotalEntries = useCallback(\n (updater) => {\n _setTotalEntries((old) => {\n const newTotalEntries = updater instanceof Function ? updater(old) : updater;\n if (!isFiltered) {\n setUnfilteredTotalEntries(newTotalEntries);\n }\n return newTotalEntries;\n });\n },\n [isFiltered],\n );\n\n const clearFilters = useCallback(() => {\n setPredicates(initialState.predicates);\n setGlobalFilter('');\n }, []);\n\n const clearRowSelection = useCallback(() => {\n setRowSelection({});\n }, []);\n\n const getSelectedRows = useCallback(() => Object.values(rowSelection), [rowSelection]);\n\n const getSelectedRow = () => getSelectedRows()[0] ?? null;\n\n useDidUpdate(() => {\n if (!options.enableMultiRowSelection) {\n clearRowSelection();\n }\n }, [globalFilter, pagination, sorting, dateRange, predicates]);\n\n const state = useMemo(\n () => ({\n pagination,\n totalEntries,\n sorting,\n globalFilter,\n expanded,\n predicates,\n layout,\n dateRange,\n rowSelection,\n columnVisibility,\n }),\n [\n pagination,\n totalEntries,\n sorting,\n globalFilter,\n expanded,\n predicates,\n layout,\n dateRange,\n rowSelection,\n columnVisibility,\n ],\n );\n\n return {\n state,\n setPagination,\n setTotalEntries,\n setSorting,\n setGlobalFilter,\n setExpanded,\n setPredicates,\n setLayout,\n setDateRange,\n setRowSelection,\n setColumnVisibility,\n isFiltered,\n isVacant,\n clearFilters,\n clearRowSelection,\n getSelectedRows,\n getSelectedRow,\n rowSelectionEnabled: options.enableRowSelection,\n rowSelectionForced: options.forceSelection,\n multiRowSelectionEnabled: options.enableMultiRowSelection,\n };\n};\n"],"names":["useDidUpdate","defaultsDeep","useCallback","useMemo","useState","defaultOptions","enableRowSelection","enableMultiRowSelection","forceSelection","defaultState","pagination","pageIndex","pageSize","totalEntries","sorting","globalFilter","predicates","layout","dateRange","rowSelection","columnVisibility","useTable","userOptions","options","initialState","setPagination","_setTotalEntries","unfilteredTotalEntries","setUnfilteredTotalEntries","setSorting","setGlobalFilter","expanded","setExpanded","setPredicates","setLayout","setDateRange","setRowSelection","setColumnVisibility","isFiltered","Object","keys","some","predicate","isVacant","setTotalEntries","updater","old","newTotalEntries","Function","clearFilters","clearRowSelection","getSelectedRows","values","getSelectedRow","state","rowSelectionEnabled","rowSelectionForced","multiRowSelectionEnabled"],"mappings":"AAAA,SAAQA,YAAY,QAAO,iBAAiB;AAE5C,OAAOC,kBAAkB,sBAAsB;AAC/C,SAAkCC,WAAW,EAAEC,OAAO,EAAEC,QAAQ,QAAO,QAAQ;AA2L/E,MAAMC,iBAAkC;IACpCC,oBAAoB;IACpBC,yBAAyB;IACzBC,gBAAgB;AACpB;AAEA,MAAMC,eAAoC;IACtCC,YAAY;QACRC,WAAW;QACXC,UAAU;IACd;IACAC,cAAc;IACdC,SAAS,EAAE;IACXC,cAAc;IACdC,YAAY,CAAC;IACbC,QAAQ;IACRC,WAAW;QAAC;QAAM;KAAK;IACvBC,cAAc,CAAC;IACfC,kBAAkB,CAAC;AACvB;AAEA,OAAO,MAAMC,WAAW,CAAQC,cAAsC,CAAC,CAAC;IACpE,MAAMC,UAAUtB,aAAa,CAAC,GAAGqB,aAAajB;IAC9C,MAAMmB,eAAevB,aAAa,CAAC,GAAGsB,QAAQC,YAAY,EAAEf;IAE5D,MAAM,CAACC,YAAYe,cAAc,GAAGrB,SAA0CoB,aAAad,UAAU;IACrG,MAAM,CAACG,cAAca,iBAAiB,GAAGtB,SAA4CoB,aAAaX,YAAY;IAC9G,MAAM,CAACc,wBAAwBC,0BAA0B,GAAGxB,SACxDoB,aAAaX,YAAY;IAE7B,MAAM,CAACC,SAASe,WAAW,GAAGzB,SAAuCoB,aAAaV,OAAO;IACzF,MAAM,CAACC,cAAce,gBAAgB,GAAG1B,SAA4CoB,aAAaT,YAAY;IAC7G,MAAM,CAACgB,UAAUC,YAAY,GAAG5B,SAAwCoB,aAAaO,QAAQ;IAC7F,MAAM,CAACf,YAAYiB,cAAc,GAAG7B,SAA0CoB,aAAaR,UAAU;IACrG,MAAM,CAACC,QAAQiB,UAAU,GAAG9B,SAAsCoB,aAAaP,MAAM;IACrF,MAAM,CAACC,WAAWiB,aAAa,GAAG/B,SAAyCoB,aAAaN,SAAS;IACjG,MAAM,CAACC,cAAciB,gBAAgB,GAAGhC,SAA4CoB,aAAaL,YAAY;IAC7G,MAAM,CAACC,kBAAkBiB,oBAAoB,GAAGjC,SAC5CoB,aAAaJ,gBAAgB;IAGjC,MAAMkB,aACF,CAAC,CAACvB,gBACFwB,OAAOC,IAAI,CAACxB,YAAYyB,IAAI,CAAC,CAACC,YAAc,CAAC,CAAC1B,UAAU,CAAC0B,UAAU,KACnE,CAAC,CAACxB,WAAW,CAAC,EAAE,IAChB,CAAC,CAACA,WAAW,CAAC,EAAE;IAEpB,MAAMyB,WAAWhB,2BAA2B;IAE5C,MAAMiB,kBAA2C1C,YAC7C,CAAC2C;QACGnB,iBAAiB,CAACoB;YACd,MAAMC,kBAAkBF,mBAAmBG,WAAWH,QAAQC,OAAOD;YACrE,IAAI,CAACP,YAAY;gBACbV,0BAA0BmB;YAC9B;YACA,OAAOA;QACX;IACJ,GACA;QAACT;KAAW;IAGhB,MAAMW,eAAe/C,YAAY;QAC7B+B,cAAcT,aAAaR,UAAU;QACrCc,gBAAgB;IACpB,GAAG,EAAE;IAEL,MAAMoB,oBAAoBhD,YAAY;QAClCkC,gBAAgB,CAAC;IACrB,GAAG,EAAE;IAEL,MAAMe,kBAAkBjD,YAAY,IAAMqC,OAAOa,MAAM,CAACjC,eAAe;QAACA;KAAa;IAErF,MAAMkC,iBAAiB,IAAMF,iBAAiB,CAAC,EAAE,IAAI;IAErDnD,aAAa;QACT,IAAI,CAACuB,QAAQhB,uBAAuB,EAAE;YAClC2C;QACJ;IACJ,GAAG;QAACnC;QAAcL;QAAYI;QAASI;QAAWF;KAAW;IAE7D,MAAMsC,QAAQnD,QACV,IAAO,CAAA;YACHO;YACAG;YACAC;YACAC;YACAgB;YACAf;YACAC;YACAC;YACAC;YACAC;QACJ,CAAA,GACA;QACIV;QACAG;QACAC;QACAC;QACAgB;QACAf;QACAC;QACAC;QACAC;QACAC;KACH;IAGL,OAAO;QACHkC;QACA7B;QACAmB;QACAf;QACAC;QACAE;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAK;QACAM;QACAC;QACAC;QACAE;QACAE,qBAAqBhC,QAAQjB,kBAAkB;QAC/CkD,oBAAoBjC,QAAQf,cAAc;QAC1CiD,0BAA0BlC,QAAQhB,uBAAuB;IAC7D;AACJ,EAAE"}
|
|
1
|
+
{"version":3,"sources":["../../../../src/components/table/use-table.ts"],"sourcesContent":["import {useDidUpdate} from '@mantine/hooks';\nimport {type ExpandedState, type PaginationState, type SortingState} from '@tanstack/table-core';\nimport defaultsDeep from 'lodash.defaultsdeep';\nimport {Dispatch, SetStateAction, useCallback, useMemo, useState} from 'react';\nimport {type DateRangePickerValue} from '../date-range-picker';\nimport {useUrlSyncedState} from './use-url-synced-state';\n\n// Create a deeply optional version of another type\ntype DeepPartial<T> = {\n [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];\n};\n\nexport interface TableState<TData = unknown> {\n /**\n * Current pagination state\n *\n * @default { pageIndex: 0, pageSize: 50 }\n */\n pagination: PaginationState;\n /**\n * Total number of entries in the table.\n * This number is used to calculate the number of pages in the pagination.\n * When null, the number of pages is calculated using the current data length.\n *\n * @default null\n */\n totalEntries: number | null;\n /**\n * Current sorting state\n *\n * @default []\n */\n sorting: SortingState;\n /**\n * Current global filter value\n *\n * @default ''\n */\n globalFilter: string;\n\n /**\n * Current expanded state\n *\n * @default {}\n */\n expanded: ExpandedState;\n /**\n * Predicates and their current value\n *\n * @default {}\n */\n predicates: Record<string, string>;\n /**\n * Layout currently selected. When null, the first layout is used.\n *\n * @default null\n */\n layout: string | null;\n /**\n * Currently selected date range\n *\n * @default [null, null]\n */\n dateRange: DateRangePickerValue;\n /**\n * Currently selected rows\n *\n * @default {}\n */\n rowSelection: Record<string, TData>;\n /**\n * Columns that are currently visible\n *\n * @default {}\n */\n columnVisibility: Record<string, boolean>;\n}\n\nexport interface TableStore<TData = unknown> {\n /**\n * Current state of the table.\n */\n state: TableState<TData>;\n /**\n * Allows to change the pagination state.\n */\n setPagination: Dispatch<SetStateAction<TableState<TData>['pagination']>>;\n /**\n * Allows to change the total number of entries.\n */\n setTotalEntries: Dispatch<SetStateAction<TableState<TData>['totalEntries']>>;\n /**\n * Allows to change the sorting state.\n */\n setSorting: Dispatch<SetStateAction<TableState<TData>['sorting']>>;\n /**\n * Allows to change the global filter value.\n */\n setGlobalFilter: Dispatch<SetStateAction<TableState<TData>['globalFilter']>>;\n /**\n * Allows to change the rows expanded state.\n */\n setExpanded: Dispatch<SetStateAction<TableState<TData>['expanded']>>;\n /**\n * Allows to change the predicates values.\n */\n setPredicates: Dispatch<SetStateAction<TableState<TData>['predicates']>>;\n /**\n * Allows to change the selected layout.\n */\n setLayout: Dispatch<SetStateAction<TableState<TData>['layout']>>;\n /**\n * Allows to change the selected date range.\n */\n setDateRange: Dispatch<SetStateAction<TableState<TData>['dateRange']>>;\n /**\n * Allows to change the current row selection.\n */\n setRowSelection: Dispatch<SetStateAction<TableState<TData>['rowSelection']>>;\n /**\n * Allows to change the visible columns.\n */\n setColumnVisibility: Dispatch<SetStateAction<TableState<TData>['columnVisibility']>>;\n /**\n * Whether the table is currently filtered.\n */\n isFiltered: boolean;\n /**\n * Whether the table has data when unfiltered.\n *\n * This is derived from the totalEntries so make sure you set that number correctly, even if you're using a client side table.\n */\n isVacant: boolean;\n /**\n * Clear currently applied filters.\n */\n clearFilters: () => void;\n /**\n * Deselects all currently selected rows.\n */\n clearRowSelection: () => void;\n /**\n * Get currently selected rows.\n */\n getSelectedRows: () => TData[];\n /**\n * Get currently selected row\n */\n getSelectedRow: () => TData | null;\n /**\n * Whether the user can select multiple rows at the same time.\n */\n multiRowSelectionEnabled: boolean;\n /**\n * Whether rows can be selected.\n */\n rowSelectionEnabled: boolean;\n /**\n * Whether row selection is forced.\n */\n rowSelectionForced: boolean;\n}\n\nexport interface UseTableOptions<TData = unknown> {\n /**\n * Initial state of the table.\n */\n initialState?: DeepPartial<TableState<TData>>;\n /**\n * Whether rows can be selected.\n *\n * @default true\n */\n enableRowSelection?: boolean;\n /**\n * Whether multiple rows can be selected at the same time.\n *\n * @default false\n */\n enableMultiRowSelection?: boolean;\n /**\n * Forces the user to always have one row selected.\n * When activating that setting, a good practice is to have a row already selected in the initial state.\n *\n * @default false\n */\n forceSelection?: boolean;\n /**\n * Whether to sync the table state with the URL.\n *\n * @default false\n */\n syncWithUrl?: boolean;\n}\n\nconst defaultOptions: UseTableOptions = {\n enableRowSelection: true,\n enableMultiRowSelection: false,\n forceSelection: false,\n syncWithUrl: false,\n};\n\nconst defaultState: Partial<TableState> = {\n pagination: {\n pageIndex: 0,\n pageSize: 50,\n },\n totalEntries: null,\n sorting: [],\n globalFilter: '',\n predicates: {},\n layout: null,\n dateRange: [null, null],\n rowSelection: {},\n columnVisibility: {},\n};\n\nexport const useTable = <TData>(userOptions: UseTableOptions<TData> = {}): TableStore<TData> => {\n const options = defaultsDeep({}, userOptions, defaultOptions) as UseTableOptions<TData>;\n const initialState = defaultsDeep({}, options.initialState, defaultState) as TableState<TData>;\n\n // synced with url\n const [pagination, setPagination] = useUrlSyncedState<TableState<TData>['pagination']>({\n initialState: initialState.pagination,\n serializer: ({pageIndex, pageSize}) => [\n ['page', (pageIndex + 1).toString()],\n ['pageSize', pageSize.toString()],\n ],\n deserializer: (params) =>\n defaultsDeep(\n {\n pageIndex: params.get('page') ? parseInt(params.get('page'), 10) - 1 : undefined,\n pageSize: params.get('pageSize') ? parseInt(params.get('pageSize'), 10) : undefined,\n },\n initialState.pagination,\n ),\n sync: options.syncWithUrl,\n });\n const [sorting, setSorting] = useUrlSyncedState<TableState<TData>['sorting']>({\n initialState: initialState.sorting,\n serializer: (_sorting) => [\n ['sortBy', _sorting.map(({id, desc}) => `${id}.${desc ? 'desc' : 'asc'}`).join(',')],\n ],\n deserializer: (params) => {\n if (!params.has('sortBy')) {\n return initialState.sorting;\n }\n const sorts = params.get('sortBy')?.split(',') ?? [];\n return sorts.map((sort) => {\n const [id, order] = sort.split('.');\n return {id, desc: order === 'desc'};\n });\n },\n sync: options.syncWithUrl,\n });\n const [globalFilter, setGlobalFilter] = useUrlSyncedState<TableState<TData>['globalFilter']>({\n initialState: initialState.globalFilter,\n serializer: (filter) => [['filter', filter]],\n deserializer: (params) => params.get('filter') ?? initialState.globalFilter,\n sync: options.syncWithUrl,\n });\n const [predicates, setPredicates] = useUrlSyncedState<TableState<TData>['predicates']>({\n initialState: initialState.predicates,\n serializer: (_predicates) => Object.entries(_predicates).map(([key, value]) => [key, value]),\n deserializer: (params) =>\n Object.keys(initialState.predicates).reduce(\n (acc, predicateKey) => {\n acc[predicateKey] = params.get(predicateKey) ?? initialState.predicates[predicateKey];\n return acc;\n },\n {} as TableState<TData>['predicates'],\n ),\n sync: options.syncWithUrl,\n });\n const [layout, setLayout] = useUrlSyncedState<TableState<TData>['layout']>({\n initialState: initialState.layout,\n serializer: (_layout) => [['layout', _layout]],\n deserializer: (params) => params.get('layout') ?? initialState.layout,\n sync: options.syncWithUrl,\n });\n const [dateRange, setDateRange] = useUrlSyncedState<TableState<TData>['dateRange']>({\n initialState: initialState.dateRange,\n serializer: ([from, to]) => [\n ['from', from?.toISOString() ?? ''],\n ['to', to?.toISOString() ?? ''],\n ],\n deserializer: (params) => [\n params.get('from') ? new Date(params.get('from') as string) : initialState.dateRange[0],\n params.get('to') ? new Date(params.get('to') as string) : initialState.dateRange[1],\n ],\n sync: options.syncWithUrl,\n });\n const [columnVisibility, setColumnVisibility] = useUrlSyncedState<TableState<TData>['columnVisibility']>({\n initialState: initialState.columnVisibility,\n serializer: (columns) => [\n [\n 'show',\n Object.entries(columns)\n .filter(([, visible]) => visible === true)\n .map(([columnName]) => columnName)\n .join(','),\n ],\n [\n 'hide',\n Object.entries(columns)\n .filter(([, visible]) => visible === false)\n .map(([columnName]) => columnName)\n .join(','),\n ],\n ],\n deserializer: (params) => {\n if (!params.has('show') && !params.has('hide')) {\n return initialState.columnVisibility;\n }\n const visible = params.get('show')?.split(',') ?? [];\n const invisible = params.get('hide')?.split(',') ?? [];\n const columns = {} as TableState<TData>['columnVisibility'];\n visible.forEach((column) => {\n columns[column] = true;\n });\n invisible.forEach((column) => {\n columns[column] = false;\n });\n return columns;\n },\n sync: options.syncWithUrl,\n });\n\n // unsynced\n const [totalEntries, _setTotalEntries] = useState<TableState<TData>['totalEntries']>(initialState.totalEntries);\n const [unfilteredTotalEntries, setUnfilteredTotalEntries] = useState<TableState<TData>['totalEntries']>(\n initialState.totalEntries,\n );\n const [expanded, setExpanded] = useState<TableState<TData>['expanded']>(initialState.expanded);\n const [rowSelection, setRowSelection] = useState<TableState<TData>['rowSelection']>(initialState.rowSelection);\n\n const isFiltered =\n !!globalFilter ||\n Object.keys(predicates).some((predicate) => !!predicates[predicate]) ||\n !!dateRange?.[0] ||\n !!dateRange?.[1];\n\n const isVacant = unfilteredTotalEntries === 0;\n\n const setTotalEntries: typeof _setTotalEntries = useCallback(\n (updater) => {\n _setTotalEntries((old) => {\n const newTotalEntries = updater instanceof Function ? updater(old) : updater;\n if (!isFiltered) {\n setUnfilteredTotalEntries(newTotalEntries);\n }\n return newTotalEntries;\n });\n },\n [isFiltered],\n );\n\n const clearFilters = useCallback(() => {\n setPredicates(initialState.predicates);\n setGlobalFilter('');\n }, []);\n\n const clearRowSelection = useCallback(() => {\n setRowSelection({});\n }, []);\n\n const getSelectedRows = useCallback(() => Object.values(rowSelection), [rowSelection]);\n\n const getSelectedRow = () => getSelectedRows()[0] ?? null;\n\n useDidUpdate(() => {\n if (!options.enableMultiRowSelection) {\n clearRowSelection();\n }\n }, [globalFilter, pagination, sorting, dateRange, predicates]);\n\n const state = useMemo(\n () => ({\n pagination,\n totalEntries,\n sorting,\n globalFilter,\n expanded,\n predicates,\n layout,\n dateRange,\n rowSelection,\n columnVisibility,\n }),\n [\n pagination,\n totalEntries,\n sorting,\n globalFilter,\n expanded,\n predicates,\n layout,\n dateRange,\n rowSelection,\n columnVisibility,\n ],\n );\n\n return {\n state,\n setPagination,\n setTotalEntries,\n setSorting,\n setGlobalFilter,\n setExpanded,\n setPredicates,\n setLayout,\n setDateRange,\n setRowSelection,\n setColumnVisibility,\n isFiltered,\n isVacant,\n clearFilters,\n clearRowSelection,\n getSelectedRows,\n getSelectedRow,\n rowSelectionEnabled: options.enableRowSelection,\n rowSelectionForced: options.forceSelection,\n multiRowSelectionEnabled: options.enableMultiRowSelection,\n };\n};\n"],"names":["useDidUpdate","defaultsDeep","useCallback","useMemo","useState","useUrlSyncedState","defaultOptions","enableRowSelection","enableMultiRowSelection","forceSelection","syncWithUrl","defaultState","pagination","pageIndex","pageSize","totalEntries","sorting","globalFilter","predicates","layout","dateRange","rowSelection","columnVisibility","useTable","userOptions","options","initialState","setPagination","serializer","toString","deserializer","params","get","parseInt","undefined","sync","setSorting","_sorting","map","id","desc","join","has","sorts","split","sort","order","setGlobalFilter","filter","setPredicates","_predicates","Object","entries","key","value","keys","reduce","acc","predicateKey","setLayout","_layout","setDateRange","from","to","toISOString","Date","setColumnVisibility","columns","visible","columnName","invisible","forEach","column","_setTotalEntries","unfilteredTotalEntries","setUnfilteredTotalEntries","expanded","setExpanded","setRowSelection","isFiltered","some","predicate","isVacant","setTotalEntries","updater","old","newTotalEntries","Function","clearFilters","clearRowSelection","getSelectedRows","values","getSelectedRow","state","rowSelectionEnabled","rowSelectionForced","multiRowSelectionEnabled"],"mappings":"AAAA,SAAQA,YAAY,QAAO,iBAAiB;AAE5C,OAAOC,kBAAkB,sBAAsB;AAC/C,SAAkCC,WAAW,EAAEC,OAAO,EAAEC,QAAQ,QAAO,QAAQ;AAE/E,SAAQC,iBAAiB,QAAO,yBAAyB;AA8LzD,MAAMC,iBAAkC;IACpCC,oBAAoB;IACpBC,yBAAyB;IACzBC,gBAAgB;IAChBC,aAAa;AACjB;AAEA,MAAMC,eAAoC;IACtCC,YAAY;QACRC,WAAW;QACXC,UAAU;IACd;IACAC,cAAc;IACdC,SAAS,EAAE;IACXC,cAAc;IACdC,YAAY,CAAC;IACbC,QAAQ;IACRC,WAAW;QAAC;QAAM;KAAK;IACvBC,cAAc,CAAC;IACfC,kBAAkB,CAAC;AACvB;AAEA,OAAO,MAAMC,WAAW,CAAQC,cAAsC,CAAC,CAAC;IACpE,MAAMC,UAAUxB,aAAa,CAAC,GAAGuB,aAAalB;IAC9C,MAAMoB,eAAezB,aAAa,CAAC,GAAGwB,QAAQC,YAAY,EAAEf;IAE5D,kBAAkB;IAClB,MAAM,CAACC,YAAYe,cAAc,GAAGtB,kBAAmD;QACnFqB,cAAcA,aAAad,UAAU;QACrCgB,YAAY,CAAC,EAACf,SAAS,EAAEC,QAAQ,EAAC,GAAK;gBACnC;oBAAC;oBAASD,CAAAA,YAAY,CAAA,EAAGgB,QAAQ;iBAAG;gBACpC;oBAAC;oBAAYf,SAASe,QAAQ;iBAAG;aACpC;QACDC,cAAc,CAACC,SACX9B,aACI;gBACIY,WAAWkB,OAAOC,GAAG,CAAC,UAAUC,SAASF,OAAOC,GAAG,CAAC,SAAS,MAAM,IAAIE;gBACvEpB,UAAUiB,OAAOC,GAAG,CAAC,cAAcC,SAASF,OAAOC,GAAG,CAAC,aAAa,MAAME;YAC9E,GACAR,aAAad,UAAU;QAE/BuB,MAAMV,QAAQf,WAAW;IAC7B;IACA,MAAM,CAACM,SAASoB,WAAW,GAAG/B,kBAAgD;QAC1EqB,cAAcA,aAAaV,OAAO;QAClCY,YAAY,CAACS,WAAa;gBACtB;oBAAC;oBAAUA,SAASC,GAAG,CAAC,CAAC,EAACC,EAAE,EAAEC,IAAI,EAAC,GAAK,GAAGD,GAAG,CAAC,EAAEC,OAAO,SAAS,OAAO,EAAEC,IAAI,CAAC;iBAAK;aACvF;QACDX,cAAc,CAACC;YACX,IAAI,CAACA,OAAOW,GAAG,CAAC,WAAW;gBACvB,OAAOhB,aAAaV,OAAO;YAC/B;YACA,MAAM2B,QAAQZ,OAAOC,GAAG,CAAC,WAAWY,MAAM,QAAQ,EAAE;YACpD,OAAOD,MAAML,GAAG,CAAC,CAACO;gBACd,MAAM,CAACN,IAAIO,MAAM,GAAGD,KAAKD,KAAK,CAAC;gBAC/B,OAAO;oBAACL;oBAAIC,MAAMM,UAAU;gBAAM;YACtC;QACJ;QACAX,MAAMV,QAAQf,WAAW;IAC7B;IACA,MAAM,CAACO,cAAc8B,gBAAgB,GAAG1C,kBAAqD;QACzFqB,cAAcA,aAAaT,YAAY;QACvCW,YAAY,CAACoB,SAAW;gBAAC;oBAAC;oBAAUA;iBAAO;aAAC;QAC5ClB,cAAc,CAACC,SAAWA,OAAOC,GAAG,CAAC,aAAaN,aAAaT,YAAY;QAC3EkB,MAAMV,QAAQf,WAAW;IAC7B;IACA,MAAM,CAACQ,YAAY+B,cAAc,GAAG5C,kBAAmD;QACnFqB,cAAcA,aAAaR,UAAU;QACrCU,YAAY,CAACsB,cAAgBC,OAAOC,OAAO,CAACF,aAAaZ,GAAG,CAAC,CAAC,CAACe,KAAKC,MAAM,GAAK;oBAACD;oBAAKC;iBAAM;QAC3FxB,cAAc,CAACC,SACXoB,OAAOI,IAAI,CAAC7B,aAAaR,UAAU,EAAEsC,MAAM,CACvC,CAACC,KAAKC;gBACFD,GAAG,CAACC,aAAa,GAAG3B,OAAOC,GAAG,CAAC0B,iBAAiBhC,aAAaR,UAAU,CAACwC,aAAa;gBACrF,OAAOD;YACX,GACA,CAAC;QAETtB,MAAMV,QAAQf,WAAW;IAC7B;IACA,MAAM,CAACS,QAAQwC,UAAU,GAAGtD,kBAA+C;QACvEqB,cAAcA,aAAaP,MAAM;QACjCS,YAAY,CAACgC,UAAY;gBAAC;oBAAC;oBAAUA;iBAAQ;aAAC;QAC9C9B,cAAc,CAACC,SAAWA,OAAOC,GAAG,CAAC,aAAaN,aAAaP,MAAM;QACrEgB,MAAMV,QAAQf,WAAW;IAC7B;IACA,MAAM,CAACU,WAAWyC,aAAa,GAAGxD,kBAAkD;QAChFqB,cAAcA,aAAaN,SAAS;QACpCQ,YAAY,CAAC,CAACkC,MAAMC,GAAG,GAAK;gBACxB;oBAAC;oBAAQD,MAAME,iBAAiB;iBAAG;gBACnC;oBAAC;oBAAMD,IAAIC,iBAAiB;iBAAG;aAClC;QACDlC,cAAc,CAACC,SAAW;gBACtBA,OAAOC,GAAG,CAAC,UAAU,IAAIiC,KAAKlC,OAAOC,GAAG,CAAC,WAAqBN,aAAaN,SAAS,CAAC,EAAE;gBACvFW,OAAOC,GAAG,CAAC,QAAQ,IAAIiC,KAAKlC,OAAOC,GAAG,CAAC,SAAmBN,aAAaN,SAAS,CAAC,EAAE;aACtF;QACDe,MAAMV,QAAQf,WAAW;IAC7B;IACA,MAAM,CAACY,kBAAkB4C,oBAAoB,GAAG7D,kBAAyD;QACrGqB,cAAcA,aAAaJ,gBAAgB;QAC3CM,YAAY,CAACuC,UAAY;gBACrB;oBACI;oBACAhB,OAAOC,OAAO,CAACe,SACVnB,MAAM,CAAC,CAAC,GAAGoB,QAAQ,GAAKA,YAAY,MACpC9B,GAAG,CAAC,CAAC,CAAC+B,WAAW,GAAKA,YACtB5B,IAAI,CAAC;iBACb;gBACD;oBACI;oBACAU,OAAOC,OAAO,CAACe,SACVnB,MAAM,CAAC,CAAC,GAAGoB,QAAQ,GAAKA,YAAY,OACpC9B,GAAG,CAAC,CAAC,CAAC+B,WAAW,GAAKA,YACtB5B,IAAI,CAAC;iBACb;aACJ;QACDX,cAAc,CAACC;YACX,IAAI,CAACA,OAAOW,GAAG,CAAC,WAAW,CAACX,OAAOW,GAAG,CAAC,SAAS;gBAC5C,OAAOhB,aAAaJ,gBAAgB;YACxC;YACA,MAAM8C,UAAUrC,OAAOC,GAAG,CAAC,SAASY,MAAM,QAAQ,EAAE;YACpD,MAAM0B,YAAYvC,OAAOC,GAAG,CAAC,SAASY,MAAM,QAAQ,EAAE;YACtD,MAAMuB,UAAU,CAAC;YACjBC,QAAQG,OAAO,CAAC,CAACC;gBACbL,OAAO,CAACK,OAAO,GAAG;YACtB;YACAF,UAAUC,OAAO,CAAC,CAACC;gBACfL,OAAO,CAACK,OAAO,GAAG;YACtB;YACA,OAAOL;QACX;QACAhC,MAAMV,QAAQf,WAAW;IAC7B;IAEA,WAAW;IACX,MAAM,CAACK,cAAc0D,iBAAiB,GAAGrE,SAA4CsB,aAAaX,YAAY;IAC9G,MAAM,CAAC2D,wBAAwBC,0BAA0B,GAAGvE,SACxDsB,aAAaX,YAAY;IAE7B,MAAM,CAAC6D,UAAUC,YAAY,GAAGzE,SAAwCsB,aAAakD,QAAQ;IAC7F,MAAM,CAACvD,cAAcyD,gBAAgB,GAAG1E,SAA4CsB,aAAaL,YAAY;IAE7G,MAAM0D,aACF,CAAC,CAAC9D,gBACFkC,OAAOI,IAAI,CAACrC,YAAY8D,IAAI,CAAC,CAACC,YAAc,CAAC,CAAC/D,UAAU,CAAC+D,UAAU,KACnE,CAAC,CAAC7D,WAAW,CAAC,EAAE,IAChB,CAAC,CAACA,WAAW,CAAC,EAAE;IAEpB,MAAM8D,WAAWR,2BAA2B;IAE5C,MAAMS,kBAA2CjF,YAC7C,CAACkF;QACGX,iBAAiB,CAACY;YACd,MAAMC,kBAAkBF,mBAAmBG,WAAWH,QAAQC,OAAOD;YACrE,IAAI,CAACL,YAAY;gBACbJ,0BAA0BW;YAC9B;YACA,OAAOA;QACX;IACJ,GACA;QAACP;KAAW;IAGhB,MAAMS,eAAetF,YAAY;QAC7B+C,cAAcvB,aAAaR,UAAU;QACrC6B,gBAAgB;IACpB,GAAG,EAAE;IAEL,MAAM0C,oBAAoBvF,YAAY;QAClC4E,gBAAgB,CAAC;IACrB,GAAG,EAAE;IAEL,MAAMY,kBAAkBxF,YAAY,IAAMiD,OAAOwC,MAAM,CAACtE,eAAe;QAACA;KAAa;IAErF,MAAMuE,iBAAiB,IAAMF,iBAAiB,CAAC,EAAE,IAAI;IAErD1F,aAAa;QACT,IAAI,CAACyB,QAAQjB,uBAAuB,EAAE;YAClCiF;QACJ;IACJ,GAAG;QAACxE;QAAcL;QAAYI;QAASI;QAAWF;KAAW;IAE7D,MAAM2E,QAAQ1F,QACV,IAAO,CAAA;YACHS;YACAG;YACAC;YACAC;YACA2D;YACA1D;YACAC;YACAC;YACAC;YACAC;QACJ,CAAA,GACA;QACIV;QACAG;QACAC;QACAC;QACA2D;QACA1D;QACAC;QACAC;QACAC;QACAC;KACH;IAGL,OAAO;QACHuE;QACAlE;QACAwD;QACA/C;QACAW;QACA8B;QACA5B;QACAU;QACAE;QACAiB;QACAZ;QACAa;QACAG;QACAM;QACAC;QACAC;QACAE;QACAE,qBAAqBrE,QAAQlB,kBAAkB;QAC/CwF,oBAAoBtE,QAAQhB,cAAc;QAC1CuF,0BAA0BvE,QAAQjB,uBAAuB;IAC7D;AACJ,EAAE"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export interface UseUrlSyncedStateOptions<T> {
|
|
2
|
+
/**
|
|
3
|
+
* The initial state
|
|
4
|
+
*/
|
|
5
|
+
initialState: T;
|
|
6
|
+
/**
|
|
7
|
+
* The serializer function is used to determine how the state is translated to url search parameters.
|
|
8
|
+
* Called each time the state changes.
|
|
9
|
+
* @param stateValue The new state value to serialize.
|
|
10
|
+
* @returns A list of [key, value] to set as url search parameters.
|
|
11
|
+
* @example (filterValue) => [['filter', filterValue]] // ?filter=filterValue
|
|
12
|
+
*/
|
|
13
|
+
serializer: (stateValue: T) => Array<[string, string]>;
|
|
14
|
+
/**
|
|
15
|
+
* The deserializer function is used to determine how the url parameters influence the initial state.
|
|
16
|
+
* Called only once when initializing the state.
|
|
17
|
+
* @param params All the search parameters of the current url.
|
|
18
|
+
* @returns The initial state based on the current url.
|
|
19
|
+
* @example (params) => params.get('filter') ?? '',
|
|
20
|
+
*/
|
|
21
|
+
deserializer: (params: URLSearchParams) => T;
|
|
22
|
+
/**
|
|
23
|
+
* Whether the state should be synced with the url.
|
|
24
|
+
* When set to false, the hook behaves just like a regular useState hook from react.
|
|
25
|
+
*/
|
|
26
|
+
sync?: boolean;
|
|
27
|
+
}
|
|
28
|
+
export declare const useUrlSyncedState: <T>({ initialState, serializer, deserializer, sync }: UseUrlSyncedStateOptions<T>) => readonly [T, import("react").Dispatch<import("react").SetStateAction<T>>];
|
|
29
|
+
//# sourceMappingURL=use-url-synced-state.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-url-synced-state.d.ts","sourceRoot":"","sources":["../../../../src/components/table/use-url-synced-state.ts"],"names":[],"mappings":"AAiBA,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACvC;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC;IAChB;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvD;;;;;;OAMG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,CAAC,CAAC;IAC7C;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,iBAAiB,GAAI,CAAC,oDAAkD,wBAAwB,CAAC,CAAC,CAAC,8EAwB/G,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { useMemo, useState } from 'react';
|
|
2
|
+
const setSearchParam = (key, value, initial)=>{
|
|
3
|
+
const url = new URL(window.location.href);
|
|
4
|
+
if (value === '' || value === initial) {
|
|
5
|
+
url.searchParams.delete(key);
|
|
6
|
+
} else {
|
|
7
|
+
url.searchParams.set(key, value);
|
|
8
|
+
}
|
|
9
|
+
window.history.replaceState(null, '', url.toString());
|
|
10
|
+
};
|
|
11
|
+
const getSearchParams = ()=>{
|
|
12
|
+
const url = new URL(window.location.href);
|
|
13
|
+
return url.searchParams;
|
|
14
|
+
};
|
|
15
|
+
export const useUrlSyncedState = ({ initialState, serializer, deserializer, sync })=>{
|
|
16
|
+
const [state, setState] = useState(sync ? deserializer(getSearchParams()) : initialState);
|
|
17
|
+
const enhancedSetState = useMemo(()=>{
|
|
18
|
+
if (sync) {
|
|
19
|
+
const initialSerialized = serializer(initialState).reduce((acc, [key, value])=>{
|
|
20
|
+
acc[key] = value;
|
|
21
|
+
return acc;
|
|
22
|
+
}, {});
|
|
23
|
+
return (updater)=>{
|
|
24
|
+
setState((old)=>{
|
|
25
|
+
const newValue = updater instanceof Function ? updater(old) : updater;
|
|
26
|
+
serializer(newValue).forEach(([key, value])=>setSearchParam(key, value, initialSerialized[key]));
|
|
27
|
+
return newValue;
|
|
28
|
+
});
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
return setState;
|
|
32
|
+
}, [
|
|
33
|
+
sync
|
|
34
|
+
]);
|
|
35
|
+
return [
|
|
36
|
+
state,
|
|
37
|
+
enhancedSetState
|
|
38
|
+
];
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
//# sourceMappingURL=use-url-synced-state.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../../src/components/table/use-url-synced-state.ts"],"sourcesContent":["import {useMemo, useState} from 'react';\n\nconst setSearchParam = (key: string, value: string, initial: string) => {\n const url = new URL(window.location.href);\n if (value === '' || value === initial) {\n url.searchParams.delete(key);\n } else {\n url.searchParams.set(key, value);\n }\n window.history.replaceState(null, '', url.toString());\n};\n\nconst getSearchParams = (): URLSearchParams => {\n const url = new URL(window.location.href);\n return url.searchParams;\n};\n\nexport interface UseUrlSyncedStateOptions<T> {\n /**\n * The initial state\n */\n initialState: T;\n /**\n * The serializer function is used to determine how the state is translated to url search parameters.\n * Called each time the state changes.\n * @param stateValue The new state value to serialize.\n * @returns A list of [key, value] to set as url search parameters.\n * @example (filterValue) => [['filter', filterValue]] // ?filter=filterValue\n */\n serializer: (stateValue: T) => Array<[string, string]>;\n /**\n * The deserializer function is used to determine how the url parameters influence the initial state.\n * Called only once when initializing the state.\n * @param params All the search parameters of the current url.\n * @returns The initial state based on the current url.\n * @example (params) => params.get('filter') ?? '',\n */\n deserializer: (params: URLSearchParams) => T;\n /**\n * Whether the state should be synced with the url.\n * When set to false, the hook behaves just like a regular useState hook from react.\n */\n sync?: boolean;\n}\n\nexport const useUrlSyncedState = <T>({initialState, serializer, deserializer, sync}: UseUrlSyncedStateOptions<T>) => {\n const [state, setState] = useState<T>(sync ? deserializer(getSearchParams()) : initialState);\n const enhancedSetState = useMemo(() => {\n if (sync) {\n const initialSerialized = serializer(initialState).reduce(\n (acc, [key, value]) => {\n acc[key] = value;\n return acc;\n },\n {} as Record<string, string>,\n );\n return (updater: T | ((old: T) => T)) => {\n setState((old) => {\n const newValue = updater instanceof Function ? updater(old) : updater;\n serializer(newValue).forEach(([key, value]) => setSearchParam(key, value, initialSerialized[key]));\n return newValue;\n });\n };\n }\n\n return setState;\n }, [sync]);\n\n return [state, enhancedSetState] as const;\n};\n"],"names":["useMemo","useState","setSearchParam","key","value","initial","url","URL","window","location","href","searchParams","delete","set","history","replaceState","toString","getSearchParams","useUrlSyncedState","initialState","serializer","deserializer","sync","state","setState","enhancedSetState","initialSerialized","reduce","acc","updater","old","newValue","Function","forEach"],"mappings":"AAAA,SAAQA,OAAO,EAAEC,QAAQ,QAAO,QAAQ;AAExC,MAAMC,iBAAiB,CAACC,KAAaC,OAAeC;IAChD,MAAMC,MAAM,IAAIC,IAAIC,OAAOC,QAAQ,CAACC,IAAI;IACxC,IAAIN,UAAU,MAAMA,UAAUC,SAAS;QACnCC,IAAIK,YAAY,CAACC,MAAM,CAACT;IAC5B,OAAO;QACHG,IAAIK,YAAY,CAACE,GAAG,CAACV,KAAKC;IAC9B;IACAI,OAAOM,OAAO,CAACC,YAAY,CAAC,MAAM,IAAIT,IAAIU,QAAQ;AACtD;AAEA,MAAMC,kBAAkB;IACpB,MAAMX,MAAM,IAAIC,IAAIC,OAAOC,QAAQ,CAACC,IAAI;IACxC,OAAOJ,IAAIK,YAAY;AAC3B;AA8BA,OAAO,MAAMO,oBAAoB,CAAI,EAACC,YAAY,EAAEC,UAAU,EAAEC,YAAY,EAAEC,IAAI,EAA8B;IAC5G,MAAM,CAACC,OAAOC,SAAS,GAAGvB,SAAYqB,OAAOD,aAAaJ,qBAAqBE;IAC/E,MAAMM,mBAAmBzB,QAAQ;QAC7B,IAAIsB,MAAM;YACN,MAAMI,oBAAoBN,WAAWD,cAAcQ,MAAM,CACrD,CAACC,KAAK,CAACzB,KAAKC,MAAM;gBACdwB,GAAG,CAACzB,IAAI,GAAGC;gBACX,OAAOwB;YACX,GACA,CAAC;YAEL,OAAO,CAACC;gBACJL,SAAS,CAACM;oBACN,MAAMC,WAAWF,mBAAmBG,WAAWH,QAAQC,OAAOD;oBAC9DT,WAAWW,UAAUE,OAAO,CAAC,CAAC,CAAC9B,KAAKC,MAAM,GAAKF,eAAeC,KAAKC,OAAOsB,iBAAiB,CAACvB,IAAI;oBAChG,OAAO4B;gBACX;YACJ;QACJ;QAEA,OAAOP;IACX,GAAG;QAACF;KAAK;IAET,OAAO;QAACC;QAAOE;KAAiB;AACpC,EAAE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@coveord/plasma-mantine",
|
|
3
|
-
"version": "55.
|
|
3
|
+
"version": "55.4.0",
|
|
4
4
|
"description": "A Plasma flavoured Mantine theme",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"plasma",
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"module": "./dist/esm/index.js",
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"@dnd-kit/core": "6.2.0",
|
|
31
|
-
"@dnd-kit/modifiers": "
|
|
32
|
-
"@dnd-kit/sortable": "
|
|
31
|
+
"@dnd-kit/modifiers": "9.0.0",
|
|
32
|
+
"@dnd-kit/sortable": "10.0.0",
|
|
33
33
|
"@dnd-kit/utilities": "3.2.2",
|
|
34
34
|
"@mantine/utils": "6.0.22",
|
|
35
35
|
"@monaco-editor/react": "4.6.0",
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"lodash.debounce": "4.0.8",
|
|
43
43
|
"lodash.defaultsdeep": "4.6.1",
|
|
44
44
|
"monaco-editor": "0.52.0",
|
|
45
|
-
"@coveord/plasma-react-icons": "55.
|
|
46
|
-
"@coveord/plasma-tokens": "55.
|
|
45
|
+
"@coveord/plasma-react-icons": "55.4.0",
|
|
46
|
+
"@coveord/plasma-tokens": "55.4.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@mantine/carousel": "7.14.3",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"@mantine/hooks": "7.14.3",
|
|
55
55
|
"@mantine/modals": "7.14.3",
|
|
56
56
|
"@mantine/notifications": "7.14.3",
|
|
57
|
-
"@swc/cli": "0.5.
|
|
57
|
+
"@swc/cli": "0.5.2",
|
|
58
58
|
"@swc/core": "1.9.3",
|
|
59
59
|
"@testing-library/dom": "10.4.0",
|
|
60
60
|
"@testing-library/jest-dom": "6.6.3",
|
|
@@ -74,10 +74,10 @@
|
|
|
74
74
|
"react": "18.3.1",
|
|
75
75
|
"react-dom": "18.3.1",
|
|
76
76
|
"rimraf": "6.0.1",
|
|
77
|
-
"sass": "1.81.
|
|
77
|
+
"sass": "1.81.1",
|
|
78
78
|
"tslib": "2.8.1",
|
|
79
79
|
"typescript": "5.7.2",
|
|
80
|
-
"vitest": "2.1.
|
|
80
|
+
"vitest": "2.1.8"
|
|
81
81
|
},
|
|
82
82
|
"peerDependencies": {
|
|
83
83
|
"@mantine/carousel": "^7.6.1",
|
|
@@ -2,6 +2,7 @@ import {Center, Group, Space} from '@mantine/core';
|
|
|
2
2
|
import {DatePicker, DatePickerBaseProps} from '@mantine/dates';
|
|
3
3
|
import {useForm} from '@mantine/form';
|
|
4
4
|
|
|
5
|
+
import dayjs from 'dayjs';
|
|
5
6
|
import {Button} from '../button';
|
|
6
7
|
import DateRangeClasses from './DateRange.module.css';
|
|
7
8
|
import {DateRangePickerPreset, DateRangePickerPresetSelect} from './DateRangePickerPresetSelect';
|
|
@@ -44,6 +45,11 @@ export interface DateRangePickerInlineCalendarProps
|
|
|
44
45
|
>;
|
|
45
46
|
}
|
|
46
47
|
|
|
48
|
+
const isDateRangePickerValue = (value: unknown): value is DateRangePickerValue =>
|
|
49
|
+
Array.isArray(value) && value.length === 2;
|
|
50
|
+
|
|
51
|
+
const endOfDay = (value: Date): Date => (value ? dayjs(value).endOf('day').toDate() : value);
|
|
52
|
+
|
|
47
53
|
export const DateRangePickerInlineCalendar = ({
|
|
48
54
|
initialRange,
|
|
49
55
|
onApply,
|
|
@@ -60,9 +66,16 @@ export const DateRangePickerInlineCalendar = ({
|
|
|
60
66
|
});
|
|
61
67
|
const calendarInputProps = form.getInputProps('dates');
|
|
62
68
|
|
|
69
|
+
const onCalendarChange = (range: Date | Date[] | DateRangePickerValue): void => {
|
|
70
|
+
const normalized = isDateRangePickerValue(range) && range[1] ? [range[0], endOfDay(range[1])] : range;
|
|
71
|
+
calendarInputProps.onChange(normalized);
|
|
72
|
+
};
|
|
73
|
+
|
|
63
74
|
const onCalendarApply = () => {
|
|
75
|
+
// In case the user only clicked the start date, but not the end date,
|
|
76
|
+
// assume a single day was meant to be selected.
|
|
64
77
|
if (!form.values.dates[1]) {
|
|
65
|
-
form.values.dates[1] = form.values.dates[0];
|
|
78
|
+
form.values.dates[1] = endOfDay(form.values.dates[0]);
|
|
66
79
|
}
|
|
67
80
|
onApply(form.values.dates);
|
|
68
81
|
};
|
|
@@ -99,6 +112,7 @@ export const DateRangePickerInlineCalendar = ({
|
|
|
99
112
|
allowSingleDateInRange
|
|
100
113
|
{...rangeCalendarProps}
|
|
101
114
|
{...calendarInputProps}
|
|
115
|
+
onChange={onCalendarChange}
|
|
102
116
|
/>
|
|
103
117
|
</Center>
|
|
104
118
|
|
|
@@ -3,6 +3,8 @@ import dayjs from 'dayjs';
|
|
|
3
3
|
|
|
4
4
|
import {DateRangePickerInlineCalendar} from '../DateRangePickerInlineCalendar';
|
|
5
5
|
|
|
6
|
+
const endOfDay = (year: number, month: number, day: number): Date => new Date(year, month, day, 23, 59, 59, 999);
|
|
7
|
+
|
|
6
8
|
describe('DateRangePickerInlineCalendar', () => {
|
|
7
9
|
it('calls onApply when the user clicks on the apply button', async () => {
|
|
8
10
|
const user = userEvent.setup({delay: null});
|
|
@@ -37,7 +39,7 @@ describe('DateRangePickerInlineCalendar', () => {
|
|
|
37
39
|
render(
|
|
38
40
|
<DateRangePickerInlineCalendar
|
|
39
41
|
presets={{
|
|
40
|
-
year2k: {label: 'select me', range: [new Date(1999, 11, 31),
|
|
42
|
+
year2k: {label: 'select me', range: [new Date(1999, 11, 31), endOfDay(2000, 0, 1)]},
|
|
41
43
|
}}
|
|
42
44
|
initialRange={[null, null]}
|
|
43
45
|
onApply={onApply}
|
|
@@ -53,7 +55,7 @@ describe('DateRangePickerInlineCalendar', () => {
|
|
|
53
55
|
await user.click(screen.getByRole('option', {name: 'select me'}));
|
|
54
56
|
await user.click(screen.getByRole('button', {name: 'Apply'}));
|
|
55
57
|
|
|
56
|
-
expect(onApply).toHaveBeenCalledWith([new Date(1999, 11, 31),
|
|
58
|
+
expect(onApply).toHaveBeenCalledWith([new Date(1999, 11, 31), endOfDay(2000, 0, 1)]);
|
|
57
59
|
});
|
|
58
60
|
|
|
59
61
|
it('calls onApply with the selected dates when clicking in the calendar', async () => {
|
|
@@ -68,7 +70,7 @@ describe('DateRangePickerInlineCalendar', () => {
|
|
|
68
70
|
|
|
69
71
|
await user.click(screen.getByRole('button', {name: 'Apply'}));
|
|
70
72
|
|
|
71
|
-
expect(onApply).toHaveBeenCalledWith([new Date(2022, 0, 8),
|
|
73
|
+
expect(onApply).toHaveBeenCalledWith([new Date(2022, 0, 8), endOfDay(2022, 0, 14)]);
|
|
72
74
|
|
|
73
75
|
vi.useRealTimers();
|
|
74
76
|
});
|
|
@@ -81,7 +83,7 @@ describe('DateRangePickerInlineCalendar', () => {
|
|
|
81
83
|
await user.click(screen.getAllByRole('button', {name: /8 january 2022/i})[0]);
|
|
82
84
|
await user.click(screen.getByRole('button', {name: 'Apply'}));
|
|
83
85
|
|
|
84
|
-
expect(onApply).toHaveBeenCalledWith([new Date(2022, 0, 8),
|
|
86
|
+
expect(onApply).toHaveBeenCalledWith([new Date(2022, 0, 8), endOfDay(2022, 0, 8)]);
|
|
85
87
|
|
|
86
88
|
vi.useRealTimers();
|
|
87
89
|
});
|
|
@@ -298,4 +298,55 @@ describe('TableColumnsSelector', () => {
|
|
|
298
298
|
await waitFor(() => expect(screen.getByText('You can display so many patate')).toBeVisible());
|
|
299
299
|
});
|
|
300
300
|
});
|
|
301
|
+
|
|
302
|
+
describe('when url sync is activated', () => {
|
|
303
|
+
afterEach(() => {
|
|
304
|
+
window.history.replaceState(null, '', '/');
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
it('sets the current visible column ids in the url', async () => {
|
|
308
|
+
const user = userEvent.setup();
|
|
309
|
+
const Fixture = () => {
|
|
310
|
+
const store = useTable<RowData>({
|
|
311
|
+
syncWithUrl: true,
|
|
312
|
+
initialState: {columnVisibility: {email: false, phone: true}},
|
|
313
|
+
});
|
|
314
|
+
return (
|
|
315
|
+
<Table store={store} data={mockData} columns={baseColumns}>
|
|
316
|
+
<Table.Header>
|
|
317
|
+
<TableColumnsSelector />
|
|
318
|
+
</Table.Header>
|
|
319
|
+
</Table>
|
|
320
|
+
);
|
|
321
|
+
};
|
|
322
|
+
render(<Fixture />);
|
|
323
|
+
await user.click(screen.getByRole('button', {name: 'Edit columns'}));
|
|
324
|
+
const emailCheckBox = await screen.findByRole('checkbox', {name: /email/i});
|
|
325
|
+
await user.click(emailCheckBox);
|
|
326
|
+
await user.click(screen.getByRole('checkbox', {name: /phone/i}));
|
|
327
|
+
expect(window.location.search).toBe('?show=email&hide=phone');
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
it('determines the initial visible columns from the url', async () => {
|
|
331
|
+
window.history.replaceState(null, '', '?show=email%2Cphone');
|
|
332
|
+
const user = userEvent.setup();
|
|
333
|
+
const Fixture = () => {
|
|
334
|
+
const store = useTable<RowData>({
|
|
335
|
+
syncWithUrl: true,
|
|
336
|
+
initialState: {columnVisibility: {email: false, phone: false}},
|
|
337
|
+
});
|
|
338
|
+
return (
|
|
339
|
+
<Table store={store} data={mockData} columns={baseColumns}>
|
|
340
|
+
<Table.Header>
|
|
341
|
+
<TableColumnsSelector />
|
|
342
|
+
</Table.Header>
|
|
343
|
+
</Table>
|
|
344
|
+
);
|
|
345
|
+
};
|
|
346
|
+
render(<Fixture />);
|
|
347
|
+
await user.click(screen.getByRole('button', {name: 'Edit columns'}));
|
|
348
|
+
expect(await screen.findByRole('checkbox', {name: /email/i})).toBeChecked();
|
|
349
|
+
expect(screen.getByRole('checkbox', {name: /phone/i})).toBeChecked();
|
|
350
|
+
});
|
|
351
|
+
});
|
|
301
352
|
});
|