@hexclave/dashboard-ui-components 1.0.40 → 1.0.42
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/dist/analytics-chart-BUxntwQ3.d.ts +553 -0
- package/dist/analytics-chart-BUxntwQ3.d.ts.map +1 -0
- package/dist/components/alert.d.ts +1 -3
- package/dist/components/alert.d.ts.map +1 -1
- package/dist/components/alert.js +4 -7
- package/dist/components/alert.js.map +1 -1
- package/dist/components/analytics-chart/analytics-chart-pie.d.ts +3 -4
- package/dist/components/analytics-chart/analytics-chart-pie.d.ts.map +1 -1
- package/dist/components/analytics-chart/analytics-chart-pie.js +2 -4
- package/dist/components/analytics-chart/analytics-chart-pie.js.map +1 -1
- package/dist/components/analytics-chart/analytics-chart.d.ts +2 -554
- package/dist/components/analytics-chart/analytics-chart.js +2 -5
- package/dist/components/analytics-chart/analytics-chart.js.map +1 -1
- package/dist/components/analytics-chart/default-analytics-chart-tooltip.d.ts +2 -66
- package/dist/components/analytics-chart/default-analytics-chart-tooltip.js +2 -4
- package/dist/components/analytics-chart/default-analytics-chart-tooltip.js.map +1 -1
- package/dist/components/analytics-chart/format.d.ts +2 -13
- package/dist/components/analytics-chart/format.js +2 -3
- package/dist/components/analytics-chart/format.js.map +1 -1
- package/dist/components/analytics-chart/index.d.ts +7 -7
- package/dist/components/analytics-chart/index.js +175 -177
- package/dist/components/analytics-chart/palette.d.ts +2 -15
- package/dist/components/analytics-chart/palette.js +2 -3
- package/dist/components/analytics-chart/palette.js.map +1 -1
- package/dist/components/analytics-chart/render-data-series.d.ts +1 -1
- package/dist/components/analytics-chart/render-data-series.d.ts.map +1 -1
- package/dist/components/analytics-chart/render-data-series.js +2 -4
- package/dist/components/analytics-chart/render-data-series.js.map +1 -1
- package/dist/components/analytics-chart/state.d.ts +2 -54
- package/dist/components/analytics-chart/state.js +2 -4
- package/dist/components/analytics-chart/state.js.map +1 -1
- package/dist/components/analytics-chart/strings.d.ts +2 -33
- package/dist/components/analytics-chart/strings.js +2 -3
- package/dist/components/analytics-chart/strings.js.map +1 -1
- package/dist/components/analytics-chart/types.d.ts +2 -158
- package/dist/components/analytics-chart/types.js +2 -3
- package/dist/components/analytics-chart/types.js.map +1 -1
- package/dist/components/badge.d.ts +1 -3
- package/dist/components/badge.d.ts.map +1 -1
- package/dist/components/badge.js +4 -10
- package/dist/components/badge.js.map +1 -1
- package/dist/components/button.d.ts +6 -7
- package/dist/components/button.d.ts.map +1 -1
- package/dist/components/button.js +4 -5
- package/dist/components/button.js.map +1 -1
- package/dist/components/card.d.ts +2 -3
- package/dist/components/card.d.ts.map +1 -1
- package/dist/components/card.js +6 -8
- package/dist/components/card.js.map +1 -1
- package/dist/components/chart-card.d.ts +1 -2
- package/dist/components/chart-card.d.ts.map +1 -1
- package/dist/components/chart-card.js +5 -7
- package/dist/components/chart-card.js.map +1 -1
- package/dist/components/chart-container.d.ts +1 -2
- package/dist/components/chart-container.d.ts.map +1 -1
- package/dist/components/chart-container.js +5 -7
- package/dist/components/chart-container.js.map +1 -1
- package/dist/components/chart-legend.d.ts +1 -1
- package/dist/components/chart-legend.js +4 -6
- package/dist/components/chart-legend.js.map +1 -1
- package/dist/components/chart-theme.d.ts.map +1 -1
- package/dist/components/chart-theme.js +3 -5
- package/dist/components/chart-theme.js.map +1 -1
- package/dist/components/chart-tooltip.d.ts +10 -14
- package/dist/components/chart-tooltip.d.ts.map +1 -1
- package/dist/components/chart-tooltip.js +5 -7
- package/dist/components/chart-tooltip.js.map +1 -1
- package/dist/components/cursor-blast-effect.d.ts +1 -3
- package/dist/components/cursor-blast-effect.d.ts.map +1 -1
- package/dist/components/cursor-blast-effect.js +2 -5
- package/dist/components/cursor-blast-effect.js.map +1 -1
- package/dist/components/data-grid/data-grid-export-dialog.d.ts +2 -3
- package/dist/components/data-grid/data-grid-export-dialog.d.ts.map +1 -1
- package/dist/components/data-grid/data-grid-export-dialog.js +4 -6
- package/dist/components/data-grid/data-grid-export-dialog.js.map +1 -1
- package/dist/components/data-grid/data-grid-sizing.d.ts +2 -13
- package/dist/components/data-grid/data-grid-sizing.js +3 -4
- package/dist/components/data-grid/data-grid-sizing.js.map +1 -1
- package/dist/components/data-grid/data-grid-toolbar.d.ts +2 -31
- package/dist/components/data-grid/data-grid-toolbar.js +4 -6
- package/dist/components/data-grid/data-grid-toolbar.js.map +1 -1
- package/dist/components/data-grid/data-grid.d.ts +2 -47
- package/dist/components/data-grid/data-grid.js +6 -8
- package/dist/components/data-grid/data-grid.js.map +1 -1
- package/dist/components/data-grid/data-grid.test.js +1 -3
- package/dist/components/data-grid/data-grid.test.js.map +1 -1
- package/dist/components/data-grid/index.d.ts +8 -8
- package/dist/components/data-grid/index.js +139 -141
- package/dist/components/data-grid/state.d.ts +2 -34
- package/dist/components/data-grid/state.js +2 -4
- package/dist/components/data-grid/state.js.map +1 -1
- package/dist/components/data-grid/strings.d.ts +2 -8
- package/dist/components/data-grid/strings.js +2 -3
- package/dist/components/data-grid/strings.js.map +1 -1
- package/dist/components/data-grid/types.d.ts +2 -308
- package/dist/components/data-grid/use-data-source.d.ts +2 -85
- package/dist/components/data-grid/use-data-source.js +2 -4
- package/dist/components/data-grid/use-data-source.js.map +1 -1
- package/dist/components/data-grid/use-url-state.d.ts +2 -38
- package/dist/components/data-grid/use-url-state.js +2 -5
- package/dist/components/data-grid/use-url-state.js.map +1 -1
- package/dist/components/data-grid/use-url-state.test.js +1 -3
- package/dist/components/data-grid/use-url-state.test.js.map +1 -1
- package/dist/components/dialog.d.ts +2 -71
- package/dist/components/dialog.js +6 -8
- package/dist/components/dialog.js.map +1 -1
- package/dist/components/edit-mode.d.ts +1 -3
- package/dist/components/edit-mode.d.ts.map +1 -1
- package/dist/components/edit-mode.js +2 -5
- package/dist/components/edit-mode.js.map +1 -1
- package/dist/components/empty-state.d.ts +1 -2
- package/dist/components/empty-state.d.ts.map +1 -1
- package/dist/components/empty-state.js +4 -6
- package/dist/components/empty-state.js.map +1 -1
- package/dist/components/input.js +4 -6
- package/dist/components/input.js.map +1 -1
- package/dist/components/metric-card.d.ts +1 -2
- package/dist/components/metric-card.d.ts.map +1 -1
- package/dist/components/metric-card.js +5 -7
- package/dist/components/metric-card.js.map +1 -1
- package/dist/components/pill-toggle.d.ts +1 -3
- package/dist/components/pill-toggle.d.ts.map +1 -1
- package/dist/components/pill-toggle.js +4 -7
- package/dist/components/pill-toggle.js.map +1 -1
- package/dist/components/progress-bar.d.ts +1 -3
- package/dist/components/progress-bar.d.ts.map +1 -1
- package/dist/components/progress-bar.js +3 -6
- package/dist/components/progress-bar.js.map +1 -1
- package/dist/components/separator.d.ts +1 -3
- package/dist/components/separator.d.ts.map +1 -1
- package/dist/components/separator.js +2 -5
- package/dist/components/separator.js.map +1 -1
- package/dist/components/skeleton.d.ts +1 -2
- package/dist/components/skeleton.d.ts.map +1 -1
- package/dist/components/skeleton.js +2 -5
- package/dist/components/skeleton.js.map +1 -1
- package/dist/components/table.js +4 -6
- package/dist/components/table.js.map +1 -1
- package/dist/components/tabs.d.ts +1 -2
- package/dist/components/tabs.d.ts.map +1 -1
- package/dist/components/tabs.js +4 -7
- package/dist/components/tabs.js.map +1 -1
- package/dist/dashboard-ui-components.global.js +5136 -5147
- package/dist/dashboard-ui-components.global.js.map +4 -4
- package/dist/data-grid-AJi1TNDa.d.ts +46 -0
- package/dist/data-grid-AJi1TNDa.d.ts.map +1 -0
- package/dist/data-grid-sizing-S1ixcZKo.d.ts +13 -0
- package/dist/data-grid-sizing-S1ixcZKo.d.ts.map +1 -0
- package/dist/data-grid-toolbar-BGSNGDpT.d.ts +30 -0
- package/dist/data-grid-toolbar-BGSNGDpT.d.ts.map +1 -0
- package/dist/default-analytics-chart-tooltip-PrLoMaC1.d.ts +65 -0
- package/dist/default-analytics-chart-tooltip-PrLoMaC1.d.ts.map +1 -0
- package/dist/dialog-CCtTH7s6.d.ts +131 -0
- package/dist/dialog-CCtTH7s6.d.ts.map +1 -0
- package/dist/esm/components/alert.d.ts +1 -3
- package/dist/esm/components/alert.d.ts.map +1 -1
- package/dist/esm/components/alert.js +3 -5
- package/dist/esm/components/alert.js.map +1 -1
- package/dist/esm/components/analytics-chart/analytics-chart-pie.d.ts +3 -4
- package/dist/esm/components/analytics-chart/analytics-chart-pie.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/analytics-chart-pie.js +1 -2
- package/dist/esm/components/analytics-chart/analytics-chart-pie.js.map +1 -1
- package/dist/esm/components/analytics-chart/analytics-chart.d.ts +4 -5
- package/dist/esm/components/analytics-chart/analytics-chart.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/analytics-chart.js +1 -3
- package/dist/esm/components/analytics-chart/analytics-chart.js.map +1 -1
- package/dist/esm/components/analytics-chart/default-analytics-chart-tooltip.d.ts +4 -5
- package/dist/esm/components/analytics-chart/default-analytics-chart-tooltip.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/default-analytics-chart-tooltip.js +1 -2
- package/dist/esm/components/analytics-chart/default-analytics-chart-tooltip.js.map +1 -1
- package/dist/esm/components/analytics-chart/format.d.ts +1 -1
- package/dist/esm/components/analytics-chart/format.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/format.js +1 -1
- package/dist/esm/components/analytics-chart/format.js.map +1 -1
- package/dist/esm/components/analytics-chart/index.d.ts +7 -7
- package/dist/esm/components/analytics-chart/index.js +1 -2
- package/dist/esm/components/analytics-chart/palette.d.ts +1 -1
- package/dist/esm/components/analytics-chart/palette.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/palette.js +1 -1
- package/dist/esm/components/analytics-chart/palette.js.map +1 -1
- package/dist/esm/components/analytics-chart/render-data-series.d.ts +1 -1
- package/dist/esm/components/analytics-chart/render-data-series.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/render-data-series.js +1 -2
- package/dist/esm/components/analytics-chart/render-data-series.js.map +1 -1
- package/dist/esm/components/analytics-chart/state.d.ts +1 -1
- package/dist/esm/components/analytics-chart/state.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/state.js +1 -2
- package/dist/esm/components/analytics-chart/state.js.map +1 -1
- package/dist/esm/components/analytics-chart/strings.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/strings.js +1 -1
- package/dist/esm/components/analytics-chart/strings.js.map +1 -1
- package/dist/esm/components/analytics-chart/types.d.ts.map +1 -1
- package/dist/esm/components/analytics-chart/types.js +1 -1
- package/dist/esm/components/analytics-chart/types.js.map +1 -1
- package/dist/esm/components/badge.d.ts +1 -3
- package/dist/esm/components/badge.d.ts.map +1 -1
- package/dist/esm/components/badge.js +3 -8
- package/dist/esm/components/badge.js.map +1 -1
- package/dist/esm/components/button.d.ts +6 -7
- package/dist/esm/components/button.d.ts.map +1 -1
- package/dist/esm/components/button.js +2 -3
- package/dist/esm/components/button.js.map +1 -1
- package/dist/esm/components/card.d.ts +2 -3
- package/dist/esm/components/card.d.ts.map +1 -1
- package/dist/esm/components/card.js +3 -5
- package/dist/esm/components/card.js.map +1 -1
- package/dist/esm/components/chart-card.d.ts +1 -2
- package/dist/esm/components/chart-card.d.ts.map +1 -1
- package/dist/esm/components/chart-card.js +3 -5
- package/dist/esm/components/chart-card.js.map +1 -1
- package/dist/esm/components/chart-container.d.ts +1 -2
- package/dist/esm/components/chart-container.d.ts.map +1 -1
- package/dist/esm/components/chart-container.js +1 -3
- package/dist/esm/components/chart-container.js.map +1 -1
- package/dist/esm/components/chart-legend.d.ts +1 -1
- package/dist/esm/components/chart-legend.js +1 -3
- package/dist/esm/components/chart-legend.js.map +1 -1
- package/dist/esm/components/chart-theme.d.ts.map +1 -1
- package/dist/esm/components/chart-theme.js +2 -3
- package/dist/esm/components/chart-theme.js.map +1 -1
- package/dist/esm/components/chart-tooltip.d.ts +10 -14
- package/dist/esm/components/chart-tooltip.d.ts.map +1 -1
- package/dist/esm/components/chart-tooltip.js +1 -3
- package/dist/esm/components/chart-tooltip.js.map +1 -1
- package/dist/esm/components/cursor-blast-effect.d.ts +1 -3
- package/dist/esm/components/cursor-blast-effect.d.ts.map +1 -1
- package/dist/esm/components/cursor-blast-effect.js +1 -3
- package/dist/esm/components/cursor-blast-effect.js.map +1 -1
- package/dist/esm/components/data-grid/data-grid-export-dialog.d.ts +2 -3
- package/dist/esm/components/data-grid/data-grid-export-dialog.d.ts.map +1 -1
- package/dist/esm/components/data-grid/data-grid-export-dialog.js +2 -4
- package/dist/esm/components/data-grid/data-grid-export-dialog.js.map +1 -1
- package/dist/esm/components/data-grid/data-grid-sizing.d.ts +1 -1
- package/dist/esm/components/data-grid/data-grid-sizing.d.ts.map +1 -1
- package/dist/esm/components/data-grid/data-grid-sizing.js +2 -2
- package/dist/esm/components/data-grid/data-grid-sizing.js.map +1 -1
- package/dist/esm/components/data-grid/data-grid-toolbar.d.ts +2 -3
- package/dist/esm/components/data-grid/data-grid-toolbar.d.ts.map +1 -1
- package/dist/esm/components/data-grid/data-grid-toolbar.js +1 -3
- package/dist/esm/components/data-grid/data-grid-toolbar.js.map +1 -1
- package/dist/esm/components/data-grid/data-grid.d.ts +2 -3
- package/dist/esm/components/data-grid/data-grid.d.ts.map +1 -1
- package/dist/esm/components/data-grid/data-grid.js +4 -6
- package/dist/esm/components/data-grid/data-grid.js.map +1 -1
- package/dist/esm/components/data-grid/data-grid.test.js +2 -3
- package/dist/esm/components/data-grid/data-grid.test.js.map +1 -1
- package/dist/esm/components/data-grid/index.d.ts +8 -8
- package/dist/esm/components/data-grid/index.js +1 -2
- package/dist/esm/components/data-grid/state.d.ts +1 -1
- package/dist/esm/components/data-grid/state.d.ts.map +1 -1
- package/dist/esm/components/data-grid/state.js +1 -2
- package/dist/esm/components/data-grid/state.js.map +1 -1
- package/dist/esm/components/data-grid/strings.d.ts +1 -1
- package/dist/esm/components/data-grid/strings.d.ts.map +1 -1
- package/dist/esm/components/data-grid/strings.js +1 -1
- package/dist/esm/components/data-grid/strings.js.map +1 -1
- package/dist/esm/components/data-grid/types.d.ts.map +1 -1
- package/dist/esm/components/data-grid/types.js +1 -1
- package/dist/esm/components/data-grid/use-data-source.d.ts +1 -1
- package/dist/esm/components/data-grid/use-data-source.d.ts.map +1 -1
- package/dist/esm/components/data-grid/use-data-source.js +1 -2
- package/dist/esm/components/data-grid/use-data-source.js.map +1 -1
- package/dist/esm/components/data-grid/use-url-state.d.ts +1 -1
- package/dist/esm/components/data-grid/use-url-state.d.ts.map +1 -1
- package/dist/esm/components/data-grid/use-url-state.js +1 -3
- package/dist/esm/components/data-grid/use-url-state.js.map +1 -1
- package/dist/esm/components/data-grid/use-url-state.test.js +2 -3
- package/dist/esm/components/data-grid/use-url-state.test.js.map +1 -1
- package/dist/esm/components/dialog.d.ts +6 -8
- package/dist/esm/components/dialog.d.ts.map +1 -1
- package/dist/esm/components/dialog.js +3 -5
- package/dist/esm/components/dialog.js.map +1 -1
- package/dist/esm/components/edit-mode.d.ts +1 -3
- package/dist/esm/components/edit-mode.d.ts.map +1 -1
- package/dist/esm/components/edit-mode.js +1 -3
- package/dist/esm/components/edit-mode.js.map +1 -1
- package/dist/esm/components/empty-state.d.ts +1 -2
- package/dist/esm/components/empty-state.d.ts.map +1 -1
- package/dist/esm/components/empty-state.js +2 -4
- package/dist/esm/components/empty-state.js.map +1 -1
- package/dist/esm/components/input.js +2 -4
- package/dist/esm/components/input.js.map +1 -1
- package/dist/esm/components/metric-card.d.ts +1 -2
- package/dist/esm/components/metric-card.d.ts.map +1 -1
- package/dist/esm/components/metric-card.js +3 -5
- package/dist/esm/components/metric-card.js.map +1 -1
- package/dist/esm/components/pill-toggle.d.ts +1 -3
- package/dist/esm/components/pill-toggle.d.ts.map +1 -1
- package/dist/esm/components/pill-toggle.js +3 -5
- package/dist/esm/components/pill-toggle.js.map +1 -1
- package/dist/esm/components/progress-bar.d.ts +1 -3
- package/dist/esm/components/progress-bar.d.ts.map +1 -1
- package/dist/esm/components/progress-bar.js +2 -4
- package/dist/esm/components/progress-bar.js.map +1 -1
- package/dist/esm/components/separator.d.ts +1 -3
- package/dist/esm/components/separator.d.ts.map +1 -1
- package/dist/esm/components/separator.js +1 -3
- package/dist/esm/components/separator.js.map +1 -1
- package/dist/esm/components/skeleton.d.ts +1 -2
- package/dist/esm/components/skeleton.d.ts.map +1 -1
- package/dist/esm/components/skeleton.js +1 -3
- package/dist/esm/components/skeleton.js.map +1 -1
- package/dist/esm/components/table.js +2 -4
- package/dist/esm/components/table.js.map +1 -1
- package/dist/esm/components/tabs.d.ts +1 -2
- package/dist/esm/components/tabs.d.ts.map +1 -1
- package/dist/esm/components/tabs.js +3 -5
- package/dist/esm/components/tabs.js.map +1 -1
- package/dist/esm/index.d.ts +23 -23
- package/dist/esm/index.js +3 -6
- package/dist/format-DdrrnMlc.d.ts +13 -0
- package/dist/format-DdrrnMlc.d.ts.map +1 -0
- package/dist/index.d.ts +17 -17
- package/dist/index.js +278 -277
- package/dist/palette-pqnuo5cq.d.ts +15 -0
- package/dist/palette-pqnuo5cq.d.ts.map +1 -0
- package/dist/{chunk-BE-pF4vm.js → rolldown-runtime-D6vf50IK.js} +12 -18
- package/dist/state-6LW8ACh5.d.ts +34 -0
- package/dist/state-6LW8ACh5.d.ts.map +1 -0
- package/dist/state-Hch3gYtt.d.ts +54 -0
- package/dist/state-Hch3gYtt.d.ts.map +1 -0
- package/dist/strings-CACVtKlq.d.ts +8 -0
- package/dist/strings-CACVtKlq.d.ts.map +1 -0
- package/dist/strings-D-t58Uol.d.ts +33 -0
- package/dist/strings-D-t58Uol.d.ts.map +1 -0
- package/dist/types-1-eOd1JF.d.ts +308 -0
- package/dist/types-1-eOd1JF.d.ts.map +1 -0
- package/dist/types-NyzRTEfi.d.ts +158 -0
- package/dist/types-NyzRTEfi.d.ts.map +1 -0
- package/dist/use-data-source-BVFynerX.d.ts +85 -0
- package/dist/use-data-source-BVFynerX.d.ts.map +1 -0
- package/dist/use-url-state-B4_wnBjm.d.ts +38 -0
- package/dist/use-url-state-B4_wnBjm.d.ts.map +1 -0
- package/package.json +3 -7
- package/dist/components/analytics-chart/analytics-chart.d.ts.map +0 -1
- package/dist/components/analytics-chart/default-analytics-chart-tooltip.d.ts.map +0 -1
- package/dist/components/analytics-chart/format.d.ts.map +0 -1
- package/dist/components/analytics-chart/palette.d.ts.map +0 -1
- package/dist/components/analytics-chart/state.d.ts.map +0 -1
- package/dist/components/analytics-chart/strings.d.ts.map +0 -1
- package/dist/components/analytics-chart/types.d.ts.map +0 -1
- package/dist/components/data-grid/data-grid-sizing.d.ts.map +0 -1
- package/dist/components/data-grid/data-grid-toolbar.d.ts.map +0 -1
- package/dist/components/data-grid/data-grid.d.ts.map +0 -1
- package/dist/components/data-grid/state.d.ts.map +0 -1
- package/dist/components/data-grid/strings.d.ts.map +0 -1
- package/dist/components/data-grid/types.d.ts.map +0 -1
- package/dist/components/data-grid/use-data-source.d.ts.map +0 -1
- package/dist/components/data-grid/use-url-state.d.ts.map +0 -1
- package/dist/components/dialog.d.ts.map +0 -1
|
@@ -1,308 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
//#region src/components/data-grid/types.d.ts
|
|
4
|
-
/** Every row must be uniquely identifiable. The grid resolves identity
|
|
5
|
-
* through the top-level `getRowId` prop. */
|
|
6
|
-
type RowId = string;
|
|
7
|
-
type DataGridColumnType = "string" | "number" | "date" | "dateTime" | "boolean" | "singleSelect" | "custom";
|
|
8
|
-
type DataGridColumnAlign = "left" | "center" | "right";
|
|
9
|
-
type DataGridColumnPin = "left" | "right" | false;
|
|
10
|
-
/** How `date` / `dateTime` cells render their value. `"relative"` shows
|
|
11
|
-
* "1 day ago"–style text with the full datetime in a tooltip; `"absolute"`
|
|
12
|
-
* shows the full datetime inline. */
|
|
13
|
-
type DataGridDateDisplay = "relative" | "absolute";
|
|
14
|
-
/** Per-column overrides for how a `date` / `dateTime` cell is formatted.
|
|
15
|
-
* If either function is omitted the grid falls back to its default
|
|
16
|
-
* (Intl.RelativeTimeFormat + `toLocaleString()`). */
|
|
17
|
-
type DataGridDateFormat = {
|
|
18
|
-
relative?: (date: Date) => string;
|
|
19
|
-
absolute?: (date: Date) => string;
|
|
20
|
-
};
|
|
21
|
-
/** Context passed to `renderCell`. */
|
|
22
|
-
type DataGridCellContext<TRow> = {
|
|
23
|
-
row: TRow;
|
|
24
|
-
rowId: RowId;
|
|
25
|
-
rowIndex: number;
|
|
26
|
-
value: unknown;
|
|
27
|
-
columnId: string;
|
|
28
|
-
isSelected: boolean;
|
|
29
|
-
/** Current date display mode — consumers writing custom `renderCell`
|
|
30
|
-
* for `date` / `dateTime` columns should branch on this to match the
|
|
31
|
-
* grid's built-in behaviour. */
|
|
32
|
-
dateDisplay: DataGridDateDisplay;
|
|
33
|
-
};
|
|
34
|
-
/** Context passed to `renderHeader`. */
|
|
35
|
-
type DataGridHeaderContext<TRow> = {
|
|
36
|
-
columnId: string;
|
|
37
|
-
columnDef: DataGridColumnDef<TRow>;
|
|
38
|
-
isSorted: false | "asc" | "desc";
|
|
39
|
-
sortIndex: number | null;
|
|
40
|
-
};
|
|
41
|
-
/** A single column's full configuration. Generic over the row type. */
|
|
42
|
-
type DataGridColumnDef<TRow> = {
|
|
43
|
-
/** Unique identifier for this column. */id: string; /** Display label. If a function is given it receives the header context. */
|
|
44
|
-
header: string | ((ctx: DataGridHeaderContext<TRow>) => ReactNode);
|
|
45
|
-
/** Accessor — either a key of TRow or a function. If omitted, `id` is
|
|
46
|
-
* used as the key. */
|
|
47
|
-
accessor?: keyof TRow | ((row: TRow) => unknown); /** Custom cell renderer. Falls back to plain text of the resolved value. */
|
|
48
|
-
renderCell?: (ctx: DataGridCellContext<TRow>) => ReactNode; /** Initial width in pixels. Defaults to 150. */
|
|
49
|
-
width?: number; /** Minimum width during resize. Defaults to 50. */
|
|
50
|
-
minWidth?: number; /** Maximum width during resize. Defaults to 800. */
|
|
51
|
-
maxWidth?: number;
|
|
52
|
-
/** Flex grow factor. When set, remaining space is distributed among flex
|
|
53
|
-
* columns proportionally. */
|
|
54
|
-
flex?: number;
|
|
55
|
-
sortable?: boolean;
|
|
56
|
-
resizable?: boolean;
|
|
57
|
-
hideable?: boolean; /** Pin position. Defaults to `false` (unpinned). */
|
|
58
|
-
pin?: DataGridColumnPin;
|
|
59
|
-
align?: DataGridColumnAlign; /** Column type affects default sorting. */
|
|
60
|
-
type?: DataGridColumnType; /** For `singleSelect` type — available value options. */
|
|
61
|
-
valueOptions?: readonly DataGridSelectOption[];
|
|
62
|
-
/** How cell content handles overflow.
|
|
63
|
-
* - `"truncate"` (default): single-line with text-overflow ellipsis.
|
|
64
|
-
* - `"wrap"`: content wraps naturally. When combined with
|
|
65
|
-
* `rowHeight="auto"` on the grid, the row grows to fit. With a
|
|
66
|
-
* fixed `rowHeight`, wrapped content is clipped at the row boundary. */
|
|
67
|
-
cellOverflow?: "truncate" | "wrap";
|
|
68
|
-
/** Custom sort comparator. Receives two resolved cell values.
|
|
69
|
-
* Return negative if a < b, positive if a > b, 0 if equal. */
|
|
70
|
-
sortComparator?: (a: unknown, b: unknown) => number;
|
|
71
|
-
/** Format a cell value to a plain string — used for export and
|
|
72
|
-
* clipboard copy. Defaults to `String(value)`. */
|
|
73
|
-
formatValue?: (value: unknown, row: TRow) => string;
|
|
74
|
-
/** Parse a raw cell value into a `Date`. Only consulted when `type` is
|
|
75
|
-
* `"date"` or `"dateTime"`. Defaults to `new Date(value)` with graceful
|
|
76
|
-
* handling of `null` / `undefined` / invalid dates. Override for
|
|
77
|
-
* non-standard formats (e.g. ClickHouse's space-separated UTC strings). */
|
|
78
|
-
parseValue?: (value: unknown) => Date | null; /** Per-column override for the relative / absolute date formatters. */
|
|
79
|
-
dateFormat?: DataGridDateFormat; /** Fired when a cell in this column is clicked. */
|
|
80
|
-
onCellClick?: (ctx: DataGridCellContext<TRow>, event: React.MouseEvent) => void; /** Fired when a cell in this column is double-clicked. */
|
|
81
|
-
onCellDoubleClick?: (ctx: DataGridCellContext<TRow>, event: React.MouseEvent) => void;
|
|
82
|
-
};
|
|
83
|
-
type DataGridSelectOption = {
|
|
84
|
-
value: string;
|
|
85
|
-
label: string;
|
|
86
|
-
};
|
|
87
|
-
type DataGridSortItem = {
|
|
88
|
-
columnId: string;
|
|
89
|
-
direction: "asc" | "desc";
|
|
90
|
-
};
|
|
91
|
-
type DataGridSortModel = readonly DataGridSortItem[];
|
|
92
|
-
type DataGridSelectionMode = "none" | "single" | "multiple";
|
|
93
|
-
type DataGridSelectionModel = {
|
|
94
|
-
selectedIds: ReadonlySet<RowId>; /** Tracks the last-clicked row for shift-range selection. */
|
|
95
|
-
anchorId: RowId | null;
|
|
96
|
-
};
|
|
97
|
-
type DataGridColumnVisibility = Record<string, boolean>;
|
|
98
|
-
type DataGridColumnPinning = {
|
|
99
|
-
left: readonly string[];
|
|
100
|
-
right: readonly string[];
|
|
101
|
-
};
|
|
102
|
-
/** UI display mode — "paginated" shows page controls, "infinite" shows scroll sentinel. */
|
|
103
|
-
type DataGridPaginationMode = "paginated" | "infinite";
|
|
104
|
-
/** Data-fetching strategy used by `useDataSource`. */
|
|
105
|
-
type DataGridDataPaginationMode = "client" | "server" | "infinite";
|
|
106
|
-
type DataGridPaginationModel = {
|
|
107
|
-
pageIndex: number;
|
|
108
|
-
pageSize: number;
|
|
109
|
-
};
|
|
110
|
-
type DataGridState = {
|
|
111
|
-
sorting: DataGridSortModel;
|
|
112
|
-
columnVisibility: DataGridColumnVisibility;
|
|
113
|
-
columnWidths: Record<string, number>;
|
|
114
|
-
columnPinning: DataGridColumnPinning;
|
|
115
|
-
columnOrder: readonly string[];
|
|
116
|
-
pagination: DataGridPaginationModel;
|
|
117
|
-
selection: DataGridSelectionModel;
|
|
118
|
-
/** How `date` / `dateTime` columns render. Defaults to `"relative"`
|
|
119
|
-
* via `createDefaultDataGridState`. Toggled from the Columns popover
|
|
120
|
-
* whenever the grid has at least one date column. */
|
|
121
|
-
dateDisplay: DataGridDateDisplay;
|
|
122
|
-
/** Current quick-search text. Written by the built-in search input in
|
|
123
|
-
* the toolbar. `useDataSource` in client mode auto-filters by this
|
|
124
|
-
* value (via `applyQuickSearch`); in async mode it's passed through
|
|
125
|
-
* to the generator as `params.quickSearch`, where the consumer owns
|
|
126
|
-
* the "how do I match?" decision (typically by modifying the backend
|
|
127
|
-
* query). Defaults to `""`. */
|
|
128
|
-
quickSearch: string;
|
|
129
|
-
};
|
|
130
|
-
/** Params sent to the async data source on each fetch. */
|
|
131
|
-
type DataGridFetchParams = {
|
|
132
|
-
sorting: DataGridSortModel;
|
|
133
|
-
pagination: DataGridPaginationModel;
|
|
134
|
-
/** Current quick-search text. Passed through from `state.quickSearch`
|
|
135
|
-
* so the async generator can fold it into its query (e.g. a SQL WHERE
|
|
136
|
-
* clause). Empty string when the search box is empty. A change in
|
|
137
|
-
* this value triggers a refetch, same mechanism as sorting. */
|
|
138
|
-
quickSearch: string; /** For cursor-based: the last row of the previous page. */
|
|
139
|
-
cursor: unknown;
|
|
140
|
-
};
|
|
141
|
-
/** Return type from a data source fetch. */
|
|
142
|
-
type DataGridFetchResult<TRow> = {
|
|
143
|
-
rows: TRow[]; /** Total row count if known. `-1` or `undefined` for unknown (infinite). */
|
|
144
|
-
totalRowCount?: number; /** Cursor for the next page (for cursor-based pagination). */
|
|
145
|
-
nextCursor?: unknown; /** If `false`, there are no more pages. */
|
|
146
|
-
hasMore?: boolean;
|
|
147
|
-
};
|
|
148
|
-
/** An async-generator data source yields pages of rows. The generator
|
|
149
|
-
* receives fetch params as its argument and yields pages. Yielding
|
|
150
|
-
* allows the grid to display partial results during loading. */
|
|
151
|
-
type DataGridDataSource<TRow> = (params: DataGridFetchParams) => AsyncGenerator<DataGridFetchResult<TRow>, void, undefined>;
|
|
152
|
-
type DataGridExportFormat = "csv" | "json";
|
|
153
|
-
type DataGridExportScope = "all" | "filtered";
|
|
154
|
-
type DataGridExportField<TRow> = {
|
|
155
|
-
key: string;
|
|
156
|
-
label: string;
|
|
157
|
-
enabled: boolean;
|
|
158
|
-
getValue: (row: TRow) => unknown;
|
|
159
|
-
};
|
|
160
|
-
type DataGridExportRowsOptions = {
|
|
161
|
-
scope: DataGridExportScope;
|
|
162
|
-
onProgress: (fetched: number) => void;
|
|
163
|
-
};
|
|
164
|
-
type DataGridExportOptions<TRow> = {
|
|
165
|
-
title?: string;
|
|
166
|
-
description?: ReactNode;
|
|
167
|
-
entityName?: string;
|
|
168
|
-
entityNamePlural?: string;
|
|
169
|
-
filenamePrefix?: string;
|
|
170
|
-
fields?: readonly DataGridExportField<TRow>[];
|
|
171
|
-
fetchRows?: (options: DataGridExportRowsOptions) => Promise<readonly TRow[]>;
|
|
172
|
-
emptyExportTitle?: string;
|
|
173
|
-
emptyExportDescription?: string;
|
|
174
|
-
allScopeLabel?: ReactNode;
|
|
175
|
-
filteredScopeLabel?: ReactNode;
|
|
176
|
-
progressSubjectLabel?: string; /** Which export scope is selected by default when the dialog opens. Defaults to `"all"`. */
|
|
177
|
-
defaultScope?: DataGridExportScope;
|
|
178
|
-
};
|
|
179
|
-
type DataGridCallbacks<TRow> = {
|
|
180
|
-
onRowClick?: (row: TRow, rowId: RowId, event: React.MouseEvent) => void;
|
|
181
|
-
onRowDoubleClick?: (row: TRow, rowId: RowId, event: React.MouseEvent) => void;
|
|
182
|
-
onCellClick?: (row: TRow, columnId: string, value: unknown, event: React.MouseEvent) => void;
|
|
183
|
-
/**
|
|
184
|
-
* Fires when the selection set changes. **Page-scoped:** the header "select
|
|
185
|
-
* all" checkbox and `selectedRows` only cover the rows currently rendered
|
|
186
|
-
* (the visible page in paginated mode, or the loaded prefix in infinite
|
|
187
|
-
* mode). The grid does not load other pages to satisfy the selection — if
|
|
188
|
-
* you need cross-page selection, drive `selectedIds` from your own state
|
|
189
|
-
* and load all rows you care about up-front.
|
|
190
|
-
*/
|
|
191
|
-
onSelectionChange?: (selectedIds: ReadonlySet<RowId>, selectedRows: TRow[]) => void;
|
|
192
|
-
onSortChange?: (model: DataGridSortModel) => void;
|
|
193
|
-
onColumnResize?: (columnId: string, width: number) => void;
|
|
194
|
-
onColumnVisibilityChange?: (model: DataGridColumnVisibility) => void;
|
|
195
|
-
};
|
|
196
|
-
type DataGridProps<TRow> = {
|
|
197
|
-
/** Column definitions. */columns: readonly DataGridColumnDef<TRow>[];
|
|
198
|
-
/** The rows to display. The consumer is responsible for sorting
|
|
199
|
-
* and paginating before passing them in. */
|
|
200
|
-
rows: readonly TRow[]; /** Extract a unique identifier from each row. */
|
|
201
|
-
getRowId: (row: TRow) => RowId; /** Total row count across all pages (used for pagination UI). */
|
|
202
|
-
totalRowCount?: number; /** True while the initial data load is in progress (shows skeleton). */
|
|
203
|
-
isLoading?: boolean; /** True during a background refetch (shows subtle indicator, keeps rows). */
|
|
204
|
-
isRefetching?: boolean; /** Whether more rows can be loaded (shows infinite scroll sentinel). */
|
|
205
|
-
hasMore?: boolean; /** True while loading the next page of infinite scroll. */
|
|
206
|
-
isLoadingMore?: boolean; /** Called when the infinite scroll sentinel becomes visible. */
|
|
207
|
-
onLoadMore?: () => void;
|
|
208
|
-
state: DataGridState;
|
|
209
|
-
onChange: React.Dispatch<React.SetStateAction<DataGridState>>;
|
|
210
|
-
/** UI mode for pagination. "paginated" shows page controls in the
|
|
211
|
-
* footer. "infinite" shows a scroll sentinel instead. Defaults to
|
|
212
|
-
* "paginated". */
|
|
213
|
-
paginationMode?: "paginated" | "infinite"; /** Selection behaviour. Defaults to "none". */
|
|
214
|
-
selectionMode?: DataGridSelectionMode; /** Whether columns can be resized by dragging. Defaults to true. */
|
|
215
|
-
resizable?: boolean;
|
|
216
|
-
/** Row height in pixels, or `"auto"` for dynamic measurement.
|
|
217
|
-
*
|
|
218
|
-
* - **number** (default `44`): every row is exactly this tall.
|
|
219
|
-
* Fast and predictable; content that overflows is clipped.
|
|
220
|
-
* - **`"auto"`**: each row is measured by the browser after render
|
|
221
|
-
* and the virtualizer adjusts positions accordingly. Columns
|
|
222
|
-
* with `cellOverflow: "wrap"` will push the row taller; columns
|
|
223
|
-
* with `cellOverflow: "truncate"` (or the default) stay
|
|
224
|
-
* single-line. Use `estimatedRowHeight` to reduce scroll-jank
|
|
225
|
-
* when rows haven't been measured yet. */
|
|
226
|
-
rowHeight?: number | "auto";
|
|
227
|
-
/** Estimated row height used by the virtualizer when
|
|
228
|
-
* `rowHeight="auto"`. Better estimates = less scroll-position
|
|
229
|
-
* jank before rows are measured. Defaults to 44. Ignored when
|
|
230
|
-
* `rowHeight` is a number. */
|
|
231
|
-
estimatedRowHeight?: number; /** Header row height in pixels. Defaults to 44. */
|
|
232
|
-
headerHeight?: number; /** Number of rows to render outside the visible area. Defaults to 5. */
|
|
233
|
-
overscan?: number; /** Grid max height. If omitted, grid takes available space (when `fillHeight`). */
|
|
234
|
-
maxHeight?: number | string;
|
|
235
|
-
/**
|
|
236
|
-
* When `true` (default), the grid uses `h-full` and the row area scrolls inside the grid.
|
|
237
|
-
* When `false`, the grid is only as tall as toolbar + header + rows (`h-auto`), so sibling
|
|
238
|
-
* content (e.g. metadata) sits directly under the table without a large empty gap.
|
|
239
|
-
*/
|
|
240
|
-
fillHeight?: boolean; /** Top offset for the sticky toolbar + header (px or CSS string). */
|
|
241
|
-
stickyTop?: number | string;
|
|
242
|
-
} & DataGridCallbacks<TRow> & {
|
|
243
|
-
/** Custom toolbar renderer. When `false`, toolbar is hidden entirely. */toolbar?: false | ((ctx: DataGridToolbarContext<TRow>) => ReactNode);
|
|
244
|
-
/** Extra content rendered inside the default toolbar row, to the left of
|
|
245
|
-
* the built-in columns / export actions. Use this to slot in
|
|
246
|
-
* refresh buttons, custom toggles, row counts, etc. without giving up
|
|
247
|
-
* the built-in actions. Ignored if a custom `toolbar` render function
|
|
248
|
-
* is provided — that function owns the entire row. */
|
|
249
|
-
toolbarExtra?: ReactNode | ((ctx: DataGridToolbarContext<TRow>) => ReactNode); /** Custom empty state. Defaults to a centered "No data" message. */
|
|
250
|
-
emptyState?: ReactNode; /** Custom loading state. Defaults to skeleton rows. */
|
|
251
|
-
loadingState?: ReactNode; /** Custom footer. When `false`, footer is hidden. */
|
|
252
|
-
footer?: false | ((ctx: DataGridFooterContext<TRow>) => ReactNode); /** Extra content rendered to the right of the default footer info. */
|
|
253
|
-
footerExtra?: ReactNode | ((ctx: DataGridFooterContext<TRow>) => ReactNode); /** Filename stem for CSV export (without extension). */
|
|
254
|
-
exportFilename?: string;
|
|
255
|
-
/** Full export dialog configuration. If omitted, the dialog exports the
|
|
256
|
-
* currently loaded rows using the grid's visible columns. */
|
|
257
|
-
exportOptions?: DataGridExportOptions<TRow>; /** i18n overrides. */
|
|
258
|
-
strings?: Partial<DataGridStrings>;
|
|
259
|
-
className?: string;
|
|
260
|
-
};
|
|
261
|
-
type DataGridToolbarContext<TRow> = {
|
|
262
|
-
state: DataGridState;
|
|
263
|
-
onChange: React.Dispatch<React.SetStateAction<DataGridState>>;
|
|
264
|
-
columns: readonly DataGridColumnDef<TRow>[];
|
|
265
|
-
visibleColumns: readonly DataGridColumnDef<TRow>[];
|
|
266
|
-
totalRowCount: number | undefined;
|
|
267
|
-
selectedRowCount: number;
|
|
268
|
-
strings: DataGridStrings; /** Trigger a CSV export. */
|
|
269
|
-
exportCsv: () => void;
|
|
270
|
-
};
|
|
271
|
-
type DataGridFooterContext<TRow> = {
|
|
272
|
-
state: DataGridState;
|
|
273
|
-
totalRowCount: number | undefined;
|
|
274
|
-
visibleRowCount: number;
|
|
275
|
-
selectedRowCount: number;
|
|
276
|
-
paginationMode: DataGridPaginationMode;
|
|
277
|
-
strings: DataGridStrings;
|
|
278
|
-
};
|
|
279
|
-
type DataGridStrings = {
|
|
280
|
-
searchPlaceholder: string;
|
|
281
|
-
columns: string;
|
|
282
|
-
export: string;
|
|
283
|
-
density: string;
|
|
284
|
-
showAll: string;
|
|
285
|
-
hideAll: string;
|
|
286
|
-
resetColumns: string;
|
|
287
|
-
dateFormat: string;
|
|
288
|
-
dateFormatRelative: string;
|
|
289
|
-
dateFormatAbsolute: string;
|
|
290
|
-
rowsSelected: (count: number) => string;
|
|
291
|
-
rowsPerPage: string;
|
|
292
|
-
pageOf: (page: number, total: number) => string;
|
|
293
|
-
noData: string;
|
|
294
|
-
loading: string;
|
|
295
|
-
loadingMore: string;
|
|
296
|
-
exportCsv: string;
|
|
297
|
-
exportCopied: string;
|
|
298
|
-
sortAsc: string;
|
|
299
|
-
sortDesc: string;
|
|
300
|
-
unsort: string;
|
|
301
|
-
pinLeft: string;
|
|
302
|
-
pinRight: string;
|
|
303
|
-
unpin: string;
|
|
304
|
-
hideColumn: string;
|
|
305
|
-
};
|
|
306
|
-
//#endregion
|
|
307
|
-
export { DataGridCallbacks, DataGridCellContext, DataGridColumnAlign, DataGridColumnDef, DataGridColumnPin, DataGridColumnPinning, DataGridColumnType, DataGridColumnVisibility, DataGridDataPaginationMode, DataGridDataSource, DataGridDateDisplay, DataGridDateFormat, DataGridExportField, DataGridExportFormat, DataGridExportOptions, DataGridExportRowsOptions, DataGridExportScope, DataGridFetchParams, DataGridFetchResult, DataGridFooterContext, DataGridHeaderContext, DataGridPaginationMode, DataGridPaginationModel, DataGridProps, DataGridSelectOption, DataGridSelectionMode, DataGridSelectionModel, DataGridSortItem, DataGridSortModel, DataGridState, DataGridStrings, DataGridToolbarContext, RowId };
|
|
308
|
-
//# sourceMappingURL=types.d.ts.map
|
|
1
|
+
import { A as DataGridState, C as DataGridPaginationModel, D as DataGridSelectionModel, E as DataGridSelectionMode, M as DataGridToolbarContext, N as RowId, O as DataGridSortItem, S as DataGridPaginationMode, T as DataGridSelectOption, _ as DataGridExportScope, a as DataGridColumnPin, b as DataGridFooterContext, c as DataGridColumnVisibility, d as DataGridDateDisplay, f as DataGridDateFormat, g as DataGridExportRowsOptions, h as DataGridExportOptions, i as DataGridColumnDef, j as DataGridStrings, k as DataGridSortModel, l as DataGridDataPaginationMode, m as DataGridExportFormat, n as DataGridCellContext, o as DataGridColumnPinning, p as DataGridExportField, r as DataGridColumnAlign, s as DataGridColumnType, t as DataGridCallbacks, u as DataGridDataSource, v as DataGridFetchParams, w as DataGridProps, x as DataGridHeaderContext, y as DataGridFetchResult } from "../../types-1-eOd1JF.js";
|
|
2
|
+
export { DataGridCallbacks, DataGridCellContext, DataGridColumnAlign, DataGridColumnDef, DataGridColumnPin, DataGridColumnPinning, DataGridColumnType, DataGridColumnVisibility, DataGridDataPaginationMode, DataGridDataSource, DataGridDateDisplay, DataGridDateFormat, DataGridExportField, DataGridExportFormat, DataGridExportOptions, DataGridExportRowsOptions, DataGridExportScope, DataGridFetchParams, DataGridFetchResult, DataGridFooterContext, DataGridHeaderContext, DataGridPaginationMode, DataGridPaginationModel, DataGridProps, DataGridSelectOption, DataGridSelectionMode, DataGridSelectionModel, DataGridSortItem, DataGridSortModel, DataGridState, DataGridStrings, DataGridToolbarContext, RowId };
|
|
@@ -1,85 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
//#region src/components/data-grid/use-data-source.d.ts
|
|
4
|
-
type UseDataSourceResult<TRow> = {
|
|
5
|
-
/** All rows currently loaded (for infinite mode, the accumulated set). */rows: readonly TRow[]; /** Total row count if known. */
|
|
6
|
-
totalRowCount: number | undefined; /** Whether the initial load is in progress (no data at all yet). */
|
|
7
|
-
isLoading: boolean; /** Whether a background refetch is happening (data already shown). */
|
|
8
|
-
isRefetching: boolean; /** Whether more rows are being fetched (infinite scroll). */
|
|
9
|
-
isLoadingMore: boolean; /** Request the next page (infinite scroll). */
|
|
10
|
-
loadMore: () => void; /** Whether there are more pages to load. */
|
|
11
|
-
hasMore: boolean; /** Reload from scratch. */
|
|
12
|
-
reload: () => void;
|
|
13
|
-
/**
|
|
14
|
-
* Error from the most recent async fetch, if any. Consumers should render
|
|
15
|
-
* an error UI and offer a `reload()` button when this is non-null. Client
|
|
16
|
-
* mode never sets this (no fetching). Cleared on next successful fetch.
|
|
17
|
-
*/
|
|
18
|
-
error: Error | null;
|
|
19
|
-
};
|
|
20
|
-
/**
|
|
21
|
-
* Hook that processes raw data through the grid's sort/pagination state
|
|
22
|
-
* and returns the `rows` slice ready to pass to `DataGrid`. This is the
|
|
23
|
-
* only correct way to feed client-side data into a grid.
|
|
24
|
-
*
|
|
25
|
-
* Two modes, picked by which prop you pass:
|
|
26
|
-
* - `data: TRow[]` → client-side mode. In-memory sort + paginate.
|
|
27
|
-
* - `dataSource: (params) => AsyncGenerator` → server / infinite mode.
|
|
28
|
-
* The generator yields pages as you scroll or change pages.
|
|
29
|
-
*
|
|
30
|
-
* ```tsx
|
|
31
|
-
* // Client-side (most common):
|
|
32
|
-
* const gridData = useDataSource({
|
|
33
|
-
* data: users,
|
|
34
|
-
* columns,
|
|
35
|
-
* getRowId: (row) => row.id,
|
|
36
|
-
* sorting: gridState.sorting,
|
|
37
|
-
* quickSearch: gridState.quickSearch,
|
|
38
|
-
* pagination: gridState.pagination,
|
|
39
|
-
* paginationMode: "client",
|
|
40
|
-
* });
|
|
41
|
-
*
|
|
42
|
-
* <DataGrid
|
|
43
|
-
* columns={columns}
|
|
44
|
-
* rows={gridData.rows}
|
|
45
|
-
* totalRowCount={gridData.totalRowCount}
|
|
46
|
-
* isLoading={gridData.isLoading}
|
|
47
|
-
* state={gridState}
|
|
48
|
-
* onChange={setGridState}
|
|
49
|
-
* getRowId={(row) => row.id}
|
|
50
|
-
* />
|
|
51
|
-
* ```
|
|
52
|
-
*
|
|
53
|
-
* Rules:
|
|
54
|
-
* - Call this hook unconditionally at the top level, before any early return.
|
|
55
|
-
* - `rows` on `DataGrid` must ALWAYS be `gridData.rows`, never your raw array.
|
|
56
|
-
* - For server or infinite pagination, use `dataSource` — see the
|
|
57
|
-
* `DataGridDataSource` type for the generator signature.
|
|
58
|
-
*
|
|
59
|
-
* Quick search:
|
|
60
|
-
* - Client mode (`data` prop): the hook auto-filters rows via
|
|
61
|
-
* `applyQuickSearch` using a default case-insensitive substring match
|
|
62
|
-
* across every column. Override with `matchRow` for custom matching
|
|
63
|
-
* (fuzzy, weighted, field-specific, etc.).
|
|
64
|
-
* - Async mode (`dataSource` prop): the hook passes `quickSearch` into
|
|
65
|
-
* `params.quickSearch` and re-runs the generator whenever the search
|
|
66
|
-
* string changes. The consumer owns the matching logic (typically by
|
|
67
|
-
* folding it into a backend query). The grid performs NO client-side
|
|
68
|
-
* filtering in async mode.
|
|
69
|
-
*/
|
|
70
|
-
declare function useDataSource<TRow>(opts: {
|
|
71
|
-
data?: readonly TRow[];
|
|
72
|
-
dataSource?: DataGridDataSource<TRow>;
|
|
73
|
-
columns: readonly DataGridColumnDef<TRow>[];
|
|
74
|
-
getRowId: (row: TRow) => RowId;
|
|
75
|
-
sorting: DataGridSortModel; /** Current quick-search text, typically `gridState.quickSearch`. */
|
|
76
|
-
quickSearch: string;
|
|
77
|
-
/** Override the default client-mode matcher. Ignored in async mode
|
|
78
|
-
* (there the generator is the matcher). */
|
|
79
|
-
matchRow?: (row: TRow, query: string, columns: readonly DataGridColumnDef<TRow>[]) => boolean;
|
|
80
|
-
pagination: DataGridPaginationModel;
|
|
81
|
-
paginationMode: DataGridDataPaginationMode;
|
|
82
|
-
}): UseDataSourceResult<TRow>;
|
|
83
|
-
//#endregion
|
|
84
|
-
export { UseDataSourceResult, useDataSource };
|
|
85
|
-
//# sourceMappingURL=use-data-source.d.ts.map
|
|
1
|
+
import { n as useDataSource, t as UseDataSourceResult } from "../../use-data-source-BVFynerX.js";
|
|
2
|
+
export { UseDataSourceResult, useDataSource };
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value:
|
|
2
|
-
const require_chunk = require('../../chunk-BE-pF4vm.js');
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
2
|
let react = require("react");
|
|
4
3
|
let __state_js = require("./state.js");
|
|
5
|
-
|
|
6
4
|
//#region src/components/data-grid/use-data-source.ts
|
|
7
5
|
function useClientDataSource(opts) {
|
|
8
6
|
const { data, columns, sorting, quickSearch, matchRow, pagination, paginationMode } = opts;
|
|
@@ -238,7 +236,7 @@ function useDataSource(opts) {
|
|
|
238
236
|
});
|
|
239
237
|
return isClientMode ? clientResult : asyncResult;
|
|
240
238
|
}
|
|
241
|
-
|
|
242
239
|
//#endregion
|
|
243
240
|
exports.useDataSource = useDataSource;
|
|
241
|
+
|
|
244
242
|
//# sourceMappingURL=use-data-source.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-data-source.js","names":["defaultMatchRow"],"sources":["../../../src/components/data-grid/use-data-source.ts"],"sourcesContent":["import { useCallback, useEffect, useMemo, useRef, useState } from \"react\";\nimport type {\n DataGridColumnDef,\n DataGridDataSource,\n DataGridFetchParams,\n DataGridDataPaginationMode,\n DataGridPaginationModel,\n DataGridSortModel,\n RowId,\n} from \"./types\";\nimport {\n applyQuickSearch,\n buildRowComparator,\n defaultMatchRow,\n paginateRows,\n} from \"./state\";\n\nexport type UseDataSourceResult<TRow> = {\n /** All rows currently loaded (for infinite mode, the accumulated set). */\n rows: readonly TRow[];\n /** Total row count if known. */\n totalRowCount: number | undefined;\n /** Whether the initial load is in progress (no data at all yet). */\n isLoading: boolean;\n /** Whether a background refetch is happening (data already shown). */\n isRefetching: boolean;\n /** Whether more rows are being fetched (infinite scroll). */\n isLoadingMore: boolean;\n /** Request the next page (infinite scroll). */\n loadMore: () => void;\n /** Whether there are more pages to load. */\n hasMore: boolean;\n /** Reload from scratch. */\n reload: () => void;\n /**\n * Error from the most recent async fetch, if any. Consumers should render\n * an error UI and offer a `reload()` button when this is non-null. Client\n * mode never sets this (no fetching). Cleared on next successful fetch.\n */\n error: Error | null;\n};\n\n// ─── Client-side hook ────────────────────────────────────────────────\n// Memoised so resize / selection / other unrelated state changes\n// don't recompute or create new array references.\n\nfunction useClientDataSource<TRow>(opts: {\n data: readonly TRow[];\n columns: readonly DataGridColumnDef<TRow>[];\n sorting: DataGridSortModel;\n quickSearch: string;\n matchRow: (\n row: TRow,\n query: string,\n columns: readonly DataGridColumnDef<TRow>[],\n ) => boolean;\n pagination: DataGridPaginationModel;\n paginationMode: DataGridDataPaginationMode;\n}): UseDataSourceResult<TRow> {\n const { data, columns, sorting, quickSearch, matchRow, pagination, paginationMode } = opts;\n\n // Stable serialised keys so useMemo only fires on real changes\n const sortingKey = JSON.stringify(sorting);\n\n const processed = useMemo(() => {\n // Quick search is applied FIRST, on the full input. If nothing is\n // typed this is a zero-cost no-op (applyQuickSearch returns the\n // original array reference). Sort and paginate operate on the\n // already-filtered set so the result counts are search-aware.\n const searched = applyQuickSearch(data, quickSearch, columns, matchRow);\n const comparator = buildRowComparator(sorting, columns);\n const sorted = comparator ? [...searched].sort(comparator) : searched;\n const totalRowCount = sorted.length;\n const paged =\n paginationMode === \"client\"\n ? paginateRows(sorted as readonly TRow[], pagination)\n : sorted;\n return { rows: paged, totalRowCount };\n }, [data, sortingKey, quickSearch, matchRow, pagination.pageIndex, pagination.pageSize, paginationMode, columns]);\n\n return useMemo(() => ({\n rows: processed.rows,\n totalRowCount: processed.totalRowCount,\n isLoading: false,\n isRefetching: false,\n isLoadingMore: false,\n loadMore: () => {},\n hasMore: false,\n reload: () => {},\n error: null,\n }), [processed]);\n}\n\n// ─── Async data source hook ──────────────────────────────────────────\n// Key behaviour: when refetching (sort change), we keep showing the old\n// rows and set `isRefetching` instead of `isLoading`. This avoids the\n// jarring flash-to-skeleton on every sort toggle.\n\nfunction useAsyncDataSource<TRow>(opts: {\n dataSource: DataGridDataSource<TRow>;\n getRowId: (row: TRow) => RowId;\n sorting: DataGridSortModel;\n quickSearch: string;\n pagination: DataGridPaginationModel;\n paginationMode: DataGridDataPaginationMode;\n}): UseDataSourceResult<TRow> {\n const {\n dataSource,\n getRowId,\n sorting,\n quickSearch,\n pagination,\n paginationMode,\n } = opts;\n\n const [rows, setRows] = useState<TRow[]>([]);\n const [totalRowCount, setTotalRowCount] = useState<number | undefined>(undefined);\n const [isLoading, setIsLoading] = useState(true);\n const [isRefetching, setIsRefetching] = useState(false);\n const [isLoadingMore, setIsLoadingMore] = useState(false);\n const [hasMore, setHasMore] = useState(true);\n const [error, setError] = useState<Error | null>(null);\n\n const cursorRef = useRef<unknown>(undefined);\n const abortRef = useRef<AbortController | null>(null);\n const pageIndexRef = useRef(0);\n const hasDataRef = useRef(false);\n const hasMountedServerPaginationRef = useRef(false);\n\n const latestArgsRef = useRef({\n dataSource,\n getRowId,\n sorting,\n quickSearch,\n pagination,\n });\n latestArgsRef.current = { dataSource, getRowId, sorting, quickSearch, pagination };\n\n const sortingKey = JSON.stringify(sorting);\n const quickSearchKey = quickSearch;\n\n const fetchPage = useCallback(\n async (append: boolean) => {\n const {\n dataSource: currentDataSource,\n getRowId: currentGetRowId,\n sorting: currentSorting,\n quickSearch: currentQuickSearch,\n pagination: currentPagination,\n } = latestArgsRef.current;\n\n abortRef.current?.abort();\n const controller = new AbortController();\n abortRef.current = controller;\n\n if (append) {\n setIsLoadingMore(true);\n } else {\n // First load → skeleton. Subsequent → subtle refetch indicator.\n if (hasDataRef.current) {\n setIsRefetching(true);\n } else {\n setIsLoading(true);\n }\n cursorRef.current = undefined;\n pageIndexRef.current = 0;\n }\n // Clear previous error at the start of a new attempt; we'll set it\n // again if this attempt fails.\n setError(null);\n\n try {\n const params: DataGridFetchParams = {\n sorting: currentSorting,\n quickSearch: currentQuickSearch,\n pagination: append\n ? { pageIndex: pageIndexRef.current, pageSize: currentPagination.pageSize }\n : currentPagination,\n cursor: cursorRef.current,\n };\n\n const gen = currentDataSource(params);\n\n for await (const result of gen) {\n if (controller.signal.aborted) return;\n\n if (result.totalRowCount != null) {\n setTotalRowCount(result.totalRowCount);\n }\n if (result.nextCursor !== undefined) {\n cursorRef.current = result.nextCursor;\n }\n setHasMore(result.hasMore !== false);\n\n if (append) {\n setRows((prev) => {\n const existingIds = new Set(prev.map(currentGetRowId));\n const newRows = result.rows.filter(\n (r) => !existingIds.has(currentGetRowId(r)),\n );\n return [...prev, ...newRows];\n });\n } else {\n setRows(result.rows);\n }\n\n hasDataRef.current = true;\n pageIndexRef.current++;\n }\n } catch (err) {\n if (controller.signal.aborted) return;\n // Surface the error on the result so consumers can render retry UI.\n // Still log to console so it's visible in dev without forcing every\n // consumer to wire up error rendering.\n // eslint-disable-next-line no-console\n console.error(\"[DataGrid] Data source error:\", err);\n setError(err instanceof Error ? err : new Error(String(err)));\n } finally {\n if (!controller.signal.aborted) {\n setIsLoading(false);\n setIsRefetching(false);\n setIsLoadingMore(false);\n }\n }\n },\n [],\n );\n\n useEffect(() => {\n fetchPage(false).catch(() => {});\n return () => abortRef.current?.abort();\n // Also refetches when `dataSource` identity changes — consumers encode\n // external filter state into the generator's closure, so a new\n // generator reference is the signal that the query changed.\n }, [fetchPage, dataSource, sortingKey, quickSearchKey, pagination.pageSize]);\n\n useEffect(() => {\n if (paginationMode !== \"server\") {\n hasMountedServerPaginationRef.current = false;\n return;\n }\n if (!hasMountedServerPaginationRef.current) {\n hasMountedServerPaginationRef.current = true;\n return;\n }\n fetchPage(false).catch(() => {});\n }, [fetchPage, paginationMode, pagination.pageIndex]);\n\n const loadMore = useCallback(() => {\n if (!isLoadingMore && hasMore && paginationMode === \"infinite\") {\n fetchPage(true).catch(() => {});\n }\n }, [isLoadingMore, hasMore, paginationMode, fetchPage]);\n\n const reload = useCallback(() => {\n fetchPage(false).catch(() => {});\n }, [fetchPage]);\n\n return {\n rows,\n totalRowCount,\n isLoading,\n isRefetching,\n isLoadingMore,\n loadMore,\n hasMore,\n reload,\n error,\n };\n}\n\n// ─── Noop data source (stable reference) ─────────────────────────────\nconst NOOP_DATA_SOURCE: DataGridDataSource<any> = async function* () {};\nconst NOOP_GET_ROW_ID = () => \"\";\n\n// ─── Public hook ─────────────────────────────────────────────────────\n// Both inner hooks are always called (React rules-of-hooks) but only\n// one provides the returned result.\n\n/**\n * Hook that processes raw data through the grid's sort/pagination state\n * and returns the `rows` slice ready to pass to `DataGrid`. This is the\n * only correct way to feed client-side data into a grid.\n *\n * Two modes, picked by which prop you pass:\n * - `data: TRow[]` → client-side mode. In-memory sort + paginate.\n * - `dataSource: (params) => AsyncGenerator` → server / infinite mode.\n * The generator yields pages as you scroll or change pages.\n *\n * ```tsx\n * // Client-side (most common):\n * const gridData = useDataSource({\n * data: users,\n * columns,\n * getRowId: (row) => row.id,\n * sorting: gridState.sorting,\n * quickSearch: gridState.quickSearch,\n * pagination: gridState.pagination,\n * paginationMode: \"client\",\n * });\n *\n * <DataGrid\n * columns={columns}\n * rows={gridData.rows}\n * totalRowCount={gridData.totalRowCount}\n * isLoading={gridData.isLoading}\n * state={gridState}\n * onChange={setGridState}\n * getRowId={(row) => row.id}\n * />\n * ```\n *\n * Rules:\n * - Call this hook unconditionally at the top level, before any early return.\n * - `rows` on `DataGrid` must ALWAYS be `gridData.rows`, never your raw array.\n * - For server or infinite pagination, use `dataSource` — see the\n * `DataGridDataSource` type for the generator signature.\n *\n * Quick search:\n * - Client mode (`data` prop): the hook auto-filters rows via\n * `applyQuickSearch` using a default case-insensitive substring match\n * across every column. Override with `matchRow` for custom matching\n * (fuzzy, weighted, field-specific, etc.).\n * - Async mode (`dataSource` prop): the hook passes `quickSearch` into\n * `params.quickSearch` and re-runs the generator whenever the search\n * string changes. The consumer owns the matching logic (typically by\n * folding it into a backend query). The grid performs NO client-side\n * filtering in async mode.\n */\nexport function useDataSource<TRow>(opts: {\n data?: readonly TRow[];\n dataSource?: DataGridDataSource<TRow>;\n columns: readonly DataGridColumnDef<TRow>[];\n getRowId: (row: TRow) => RowId;\n sorting: DataGridSortModel;\n /** Current quick-search text, typically `gridState.quickSearch`. */\n quickSearch: string;\n /** Override the default client-mode matcher. Ignored in async mode\n * (there the generator is the matcher). */\n matchRow?: (\n row: TRow,\n query: string,\n columns: readonly DataGridColumnDef<TRow>[],\n ) => boolean;\n pagination: DataGridPaginationModel;\n paginationMode: DataGridDataPaginationMode;\n}): UseDataSourceResult<TRow> {\n const {\n data,\n dataSource,\n columns,\n getRowId,\n sorting,\n quickSearch,\n matchRow = defaultMatchRow,\n pagination,\n paginationMode,\n } = opts;\n\n const isClientMode = data != null && !dataSource;\n\n if (process.env.NODE_ENV !== \"production\" && data == null && dataSource == null) {\n // eslint-disable-next-line no-console\n console.warn(\n \"[useDataSource] neither `data` nor `dataSource` was provided — \"\n + \"the grid will render empty indefinitely. Pass one or the other.\"\n );\n }\n\n // Common footgun: consumers pass `data` as a fully-materialized array and\n // set `paginationMode: \"infinite\"` expecting the grid to page through it.\n // In client mode \"infinite\" skips `paginateRows` and returns every row;\n // `hasMore` / `loadMore` on the result are always false/no-ops. If you\n // want real paging, switch to `paginationMode: \"server\"` with a\n // `dataSource` generator. If you want in-memory slicing, use `\"client\"`.\n // If you're manually accumulating rows into `data` and driving the grid's\n // sentinel via your own `hasMore`/`onLoadMore`, this warning is a hint —\n // but current behavior (full list + external sentinel) is intentional.\n if (\n process.env.NODE_ENV !== \"production\"\n && isClientMode\n && paginationMode === \"infinite\"\n && data.length > 0\n ) {\n // eslint-disable-next-line no-console\n console.warn(\n \"[useDataSource] `paginationMode: \\\"infinite\\\"` with a `data` array \"\n + \"skips pagination entirely. Prefer `\\\"client\\\"` for in-memory lists \"\n + \"or `\\\"server\\\"` + a `dataSource` generator for real paging.\"\n );\n }\n\n const clientResult = useClientDataSource({\n data: data ?? [],\n columns,\n sorting,\n quickSearch,\n matchRow,\n pagination,\n paginationMode,\n });\n\n const asyncResult = useAsyncDataSource({\n dataSource: dataSource ?? NOOP_DATA_SOURCE,\n getRowId: dataSource ? getRowId : NOOP_GET_ROW_ID,\n sorting,\n quickSearch,\n pagination,\n paginationMode,\n });\n\n return isClientMode ? clientResult : asyncResult;\n}\n"],"mappings":";;;;;;AA8CA,SAAS,oBAA0B,MAYL;CAC5B,MAAM,EAAE,MAAM,SAAS,SAAS,aAAa,UAAU,YAAY,mBAAmB;CAKtF,MAAM,qCAA0B;EAK9B,MAAM,4CAA4B,MAAM,aAAa,SAAS,SAAS;EACvE,MAAM,gDAAgC,SAAS,QAAQ;EACvD,MAAM,SAAS,aAAa,CAAC,GAAG,SAAS,CAAC,KAAK,WAAW,GAAG;EAC7D,MAAM,gBAAgB,OAAO;AAK7B,SAAO;GAAE,MAHP,mBAAmB,wCACF,QAA2B,WAAW,GACnD;GACgB;GAAe;IACpC;EAAC;EAhBe,KAAK,UAAU,QAAQ;EAgBpB;EAAa;EAAU,WAAW;EAAW,WAAW;EAAU;EAAgB;EAAQ,CAAC;AAEjH,kCAAsB;EACpB,MAAM,UAAU;EAChB,eAAe,UAAU;EACzB,WAAW;EACX,cAAc;EACd,eAAe;EACf,gBAAgB;EAChB,SAAS;EACT,cAAc;EACd,OAAO;EACR,GAAG,CAAC,UAAU,CAAC;;AAQlB,SAAS,mBAAyB,MAOJ;CAC5B,MAAM,EACJ,YACA,UACA,SACA,aACA,YACA,mBACE;CAEJ,MAAM,CAAC,MAAM,+BAA4B,EAAE,CAAC;CAC5C,MAAM,CAAC,eAAe,wCAAiD,OAAU;CACjF,MAAM,CAAC,WAAW,oCAAyB,KAAK;CAChD,MAAM,CAAC,cAAc,uCAA4B,MAAM;CACvD,MAAM,CAAC,eAAe,wCAA6B,MAAM;CACzD,MAAM,CAAC,SAAS,kCAAuB,KAAK;CAC5C,MAAM,CAAC,OAAO,gCAAmC,KAAK;CAEtD,MAAM,8BAA4B,OAAU;CAC5C,MAAM,6BAA0C,KAAK;CACrD,MAAM,iCAAsB,EAAE;CAC9B,MAAM,+BAAoB,MAAM;CAChC,MAAM,kDAAuC,MAAM;CAEnD,MAAM,kCAAuB;EAC3B;EACA;EACA;EACA;EACA;EACD,CAAC;AACF,eAAc,UAAU;EAAE;EAAY;EAAU;EAAS;EAAa;EAAY;CAElF,MAAM,aAAa,KAAK,UAAU,QAAQ;CAC1C,MAAM,iBAAiB;CAEvB,MAAM,mCACJ,OAAO,WAAoB;EACzB,MAAM,EACJ,YAAY,mBACZ,UAAU,iBACV,SAAS,gBACT,aAAa,oBACb,YAAY,sBACV,cAAc;AAElB,WAAS,SAAS,OAAO;EACzB,MAAM,aAAa,IAAI,iBAAiB;AACxC,WAAS,UAAU;AAEnB,MAAI,OACF,kBAAiB,KAAK;OACjB;AAEL,OAAI,WAAW,QACb,iBAAgB,KAAK;OAErB,cAAa,KAAK;AAEpB,aAAU,UAAU;AACpB,gBAAa,UAAU;;AAIzB,WAAS,KAAK;AAEd,MAAI;GAUF,MAAM,MAAM,kBATwB;IAClC,SAAS;IACT,aAAa;IACb,YAAY,SACR;KAAE,WAAW,aAAa;KAAS,UAAU,kBAAkB;KAAU,GACzE;IACJ,QAAQ,UAAU;IACnB,CAEoC;AAErC,cAAW,MAAM,UAAU,KAAK;AAC9B,QAAI,WAAW,OAAO,QAAS;AAE/B,QAAI,OAAO,iBAAiB,KAC1B,kBAAiB,OAAO,cAAc;AAExC,QAAI,OAAO,eAAe,OACxB,WAAU,UAAU,OAAO;AAE7B,eAAW,OAAO,YAAY,MAAM;AAEpC,QAAI,OACF,UAAS,SAAS;KAChB,MAAM,cAAc,IAAI,IAAI,KAAK,IAAI,gBAAgB,CAAC;KACtD,MAAM,UAAU,OAAO,KAAK,QACzB,MAAM,CAAC,YAAY,IAAI,gBAAgB,EAAE,CAAC,CAC5C;AACD,YAAO,CAAC,GAAG,MAAM,GAAG,QAAQ;MAC5B;QAEF,SAAQ,OAAO,KAAK;AAGtB,eAAW,UAAU;AACrB,iBAAa;;WAER,KAAK;AACZ,OAAI,WAAW,OAAO,QAAS;AAK/B,WAAQ,MAAM,iCAAiC,IAAI;AACnD,YAAS,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,IAAI,CAAC,CAAC;YACrD;AACR,OAAI,CAAC,WAAW,OAAO,SAAS;AAC9B,iBAAa,MAAM;AACnB,oBAAgB,MAAM;AACtB,qBAAiB,MAAM;;;IAI7B,EAAE,CACH;AAED,4BAAgB;AACd,YAAU,MAAM,CAAC,YAAY,GAAG;AAChC,eAAa,SAAS,SAAS,OAAO;IAIrC;EAAC;EAAW;EAAY;EAAY;EAAgB,WAAW;EAAS,CAAC;AAE5E,4BAAgB;AACd,MAAI,mBAAmB,UAAU;AAC/B,iCAA8B,UAAU;AACxC;;AAEF,MAAI,CAAC,8BAA8B,SAAS;AAC1C,iCAA8B,UAAU;AACxC;;AAEF,YAAU,MAAM,CAAC,YAAY,GAAG;IAC/B;EAAC;EAAW;EAAgB,WAAW;EAAU,CAAC;AAYrD,QAAO;EACL;EACA;EACA;EACA;EACA;EACA,uCAhBiC;AACjC,OAAI,CAAC,iBAAiB,WAAW,mBAAmB,WAClD,WAAU,KAAK,CAAC,YAAY,GAAG;KAEhC;GAAC;GAAe;GAAS;GAAgB;GAAU,CAAC;EAarD;EACA,qCAZ+B;AAC/B,aAAU,MAAM,CAAC,YAAY,GAAG;KAC/B,CAAC,UAAU,CAAC;EAWb;EACD;;AAIH,MAAM,mBAA4C,mBAAmB;AACrE,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwD9B,SAAgB,cAAoB,MAiBN;CAC5B,MAAM,EACJ,MACA,YACA,SACA,UACA,SACA,aACA,WAAWA,4BACX,YACA,mBACE;CAEJ,MAAM,eAAe,QAAQ,QAAQ,CAAC;AAEtC,KAAI,QAAQ,IAAI,aAAa,gBAAgB,QAAQ,QAAQ,cAAc,KAEzE,SAAQ,KACN,iIAED;AAYH,KACE,QAAQ,IAAI,aAAa,gBACtB,gBACA,mBAAmB,cACnB,KAAK,SAAS,EAGjB,SAAQ,KACN,oMAGD;CAGH,MAAM,eAAe,oBAAoB;EACvC,MAAM,QAAQ,EAAE;EAChB;EACA;EACA;EACA;EACA;EACA;EACD,CAAC;CAEF,MAAM,cAAc,mBAAmB;EACrC,YAAY,cAAc;EAC1B,UAAU,aAAa,WAAW;EAClC;EACA;EACA;EACA;EACD,CAAC;AAEF,QAAO,eAAe,eAAe"}
|
|
1
|
+
{"version":3,"file":"use-data-source.js","names":["defaultMatchRow"],"sources":["../../../src/components/data-grid/use-data-source.ts"],"sourcesContent":["import { useCallback, useEffect, useMemo, useRef, useState } from \"react\";\nimport type {\n DataGridColumnDef,\n DataGridDataSource,\n DataGridFetchParams,\n DataGridDataPaginationMode,\n DataGridPaginationModel,\n DataGridSortModel,\n RowId,\n} from \"./types\";\nimport {\n applyQuickSearch,\n buildRowComparator,\n defaultMatchRow,\n paginateRows,\n} from \"./state\";\n\nexport type UseDataSourceResult<TRow> = {\n /** All rows currently loaded (for infinite mode, the accumulated set). */\n rows: readonly TRow[];\n /** Total row count if known. */\n totalRowCount: number | undefined;\n /** Whether the initial load is in progress (no data at all yet). */\n isLoading: boolean;\n /** Whether a background refetch is happening (data already shown). */\n isRefetching: boolean;\n /** Whether more rows are being fetched (infinite scroll). */\n isLoadingMore: boolean;\n /** Request the next page (infinite scroll). */\n loadMore: () => void;\n /** Whether there are more pages to load. */\n hasMore: boolean;\n /** Reload from scratch. */\n reload: () => void;\n /**\n * Error from the most recent async fetch, if any. Consumers should render\n * an error UI and offer a `reload()` button when this is non-null. Client\n * mode never sets this (no fetching). Cleared on next successful fetch.\n */\n error: Error | null;\n};\n\n// ─── Client-side hook ────────────────────────────────────────────────\n// Memoised so resize / selection / other unrelated state changes\n// don't recompute or create new array references.\n\nfunction useClientDataSource<TRow>(opts: {\n data: readonly TRow[];\n columns: readonly DataGridColumnDef<TRow>[];\n sorting: DataGridSortModel;\n quickSearch: string;\n matchRow: (\n row: TRow,\n query: string,\n columns: readonly DataGridColumnDef<TRow>[],\n ) => boolean;\n pagination: DataGridPaginationModel;\n paginationMode: DataGridDataPaginationMode;\n}): UseDataSourceResult<TRow> {\n const { data, columns, sorting, quickSearch, matchRow, pagination, paginationMode } = opts;\n\n // Stable serialised keys so useMemo only fires on real changes\n const sortingKey = JSON.stringify(sorting);\n\n const processed = useMemo(() => {\n // Quick search is applied FIRST, on the full input. If nothing is\n // typed this is a zero-cost no-op (applyQuickSearch returns the\n // original array reference). Sort and paginate operate on the\n // already-filtered set so the result counts are search-aware.\n const searched = applyQuickSearch(data, quickSearch, columns, matchRow);\n const comparator = buildRowComparator(sorting, columns);\n const sorted = comparator ? [...searched].sort(comparator) : searched;\n const totalRowCount = sorted.length;\n const paged =\n paginationMode === \"client\"\n ? paginateRows(sorted as readonly TRow[], pagination)\n : sorted;\n return { rows: paged, totalRowCount };\n }, [data, sortingKey, quickSearch, matchRow, pagination.pageIndex, pagination.pageSize, paginationMode, columns]);\n\n return useMemo(() => ({\n rows: processed.rows,\n totalRowCount: processed.totalRowCount,\n isLoading: false,\n isRefetching: false,\n isLoadingMore: false,\n loadMore: () => {},\n hasMore: false,\n reload: () => {},\n error: null,\n }), [processed]);\n}\n\n// ─── Async data source hook ──────────────────────────────────────────\n// Key behaviour: when refetching (sort change), we keep showing the old\n// rows and set `isRefetching` instead of `isLoading`. This avoids the\n// jarring flash-to-skeleton on every sort toggle.\n\nfunction useAsyncDataSource<TRow>(opts: {\n dataSource: DataGridDataSource<TRow>;\n getRowId: (row: TRow) => RowId;\n sorting: DataGridSortModel;\n quickSearch: string;\n pagination: DataGridPaginationModel;\n paginationMode: DataGridDataPaginationMode;\n}): UseDataSourceResult<TRow> {\n const {\n dataSource,\n getRowId,\n sorting,\n quickSearch,\n pagination,\n paginationMode,\n } = opts;\n\n const [rows, setRows] = useState<TRow[]>([]);\n const [totalRowCount, setTotalRowCount] = useState<number | undefined>(undefined);\n const [isLoading, setIsLoading] = useState(true);\n const [isRefetching, setIsRefetching] = useState(false);\n const [isLoadingMore, setIsLoadingMore] = useState(false);\n const [hasMore, setHasMore] = useState(true);\n const [error, setError] = useState<Error | null>(null);\n\n const cursorRef = useRef<unknown>(undefined);\n const abortRef = useRef<AbortController | null>(null);\n const pageIndexRef = useRef(0);\n const hasDataRef = useRef(false);\n const hasMountedServerPaginationRef = useRef(false);\n\n const latestArgsRef = useRef({\n dataSource,\n getRowId,\n sorting,\n quickSearch,\n pagination,\n });\n latestArgsRef.current = { dataSource, getRowId, sorting, quickSearch, pagination };\n\n const sortingKey = JSON.stringify(sorting);\n const quickSearchKey = quickSearch;\n\n const fetchPage = useCallback(\n async (append: boolean) => {\n const {\n dataSource: currentDataSource,\n getRowId: currentGetRowId,\n sorting: currentSorting,\n quickSearch: currentQuickSearch,\n pagination: currentPagination,\n } = latestArgsRef.current;\n\n abortRef.current?.abort();\n const controller = new AbortController();\n abortRef.current = controller;\n\n if (append) {\n setIsLoadingMore(true);\n } else {\n // First load → skeleton. Subsequent → subtle refetch indicator.\n if (hasDataRef.current) {\n setIsRefetching(true);\n } else {\n setIsLoading(true);\n }\n cursorRef.current = undefined;\n pageIndexRef.current = 0;\n }\n // Clear previous error at the start of a new attempt; we'll set it\n // again if this attempt fails.\n setError(null);\n\n try {\n const params: DataGridFetchParams = {\n sorting: currentSorting,\n quickSearch: currentQuickSearch,\n pagination: append\n ? { pageIndex: pageIndexRef.current, pageSize: currentPagination.pageSize }\n : currentPagination,\n cursor: cursorRef.current,\n };\n\n const gen = currentDataSource(params);\n\n for await (const result of gen) {\n if (controller.signal.aborted) return;\n\n if (result.totalRowCount != null) {\n setTotalRowCount(result.totalRowCount);\n }\n if (result.nextCursor !== undefined) {\n cursorRef.current = result.nextCursor;\n }\n setHasMore(result.hasMore !== false);\n\n if (append) {\n setRows((prev) => {\n const existingIds = new Set(prev.map(currentGetRowId));\n const newRows = result.rows.filter(\n (r) => !existingIds.has(currentGetRowId(r)),\n );\n return [...prev, ...newRows];\n });\n } else {\n setRows(result.rows);\n }\n\n hasDataRef.current = true;\n pageIndexRef.current++;\n }\n } catch (err) {\n if (controller.signal.aborted) return;\n // Surface the error on the result so consumers can render retry UI.\n // Still log to console so it's visible in dev without forcing every\n // consumer to wire up error rendering.\n // eslint-disable-next-line no-console\n console.error(\"[DataGrid] Data source error:\", err);\n setError(err instanceof Error ? err : new Error(String(err)));\n } finally {\n if (!controller.signal.aborted) {\n setIsLoading(false);\n setIsRefetching(false);\n setIsLoadingMore(false);\n }\n }\n },\n [],\n );\n\n useEffect(() => {\n fetchPage(false).catch(() => {});\n return () => abortRef.current?.abort();\n // Also refetches when `dataSource` identity changes — consumers encode\n // external filter state into the generator's closure, so a new\n // generator reference is the signal that the query changed.\n }, [fetchPage, dataSource, sortingKey, quickSearchKey, pagination.pageSize]);\n\n useEffect(() => {\n if (paginationMode !== \"server\") {\n hasMountedServerPaginationRef.current = false;\n return;\n }\n if (!hasMountedServerPaginationRef.current) {\n hasMountedServerPaginationRef.current = true;\n return;\n }\n fetchPage(false).catch(() => {});\n }, [fetchPage, paginationMode, pagination.pageIndex]);\n\n const loadMore = useCallback(() => {\n if (!isLoadingMore && hasMore && paginationMode === \"infinite\") {\n fetchPage(true).catch(() => {});\n }\n }, [isLoadingMore, hasMore, paginationMode, fetchPage]);\n\n const reload = useCallback(() => {\n fetchPage(false).catch(() => {});\n }, [fetchPage]);\n\n return {\n rows,\n totalRowCount,\n isLoading,\n isRefetching,\n isLoadingMore,\n loadMore,\n hasMore,\n reload,\n error,\n };\n}\n\n// ─── Noop data source (stable reference) ─────────────────────────────\nconst NOOP_DATA_SOURCE: DataGridDataSource<any> = async function* () {};\nconst NOOP_GET_ROW_ID = () => \"\";\n\n// ─── Public hook ─────────────────────────────────────────────────────\n// Both inner hooks are always called (React rules-of-hooks) but only\n// one provides the returned result.\n\n/**\n * Hook that processes raw data through the grid's sort/pagination state\n * and returns the `rows` slice ready to pass to `DataGrid`. This is the\n * only correct way to feed client-side data into a grid.\n *\n * Two modes, picked by which prop you pass:\n * - `data: TRow[]` → client-side mode. In-memory sort + paginate.\n * - `dataSource: (params) => AsyncGenerator` → server / infinite mode.\n * The generator yields pages as you scroll or change pages.\n *\n * ```tsx\n * // Client-side (most common):\n * const gridData = useDataSource({\n * data: users,\n * columns,\n * getRowId: (row) => row.id,\n * sorting: gridState.sorting,\n * quickSearch: gridState.quickSearch,\n * pagination: gridState.pagination,\n * paginationMode: \"client\",\n * });\n *\n * <DataGrid\n * columns={columns}\n * rows={gridData.rows}\n * totalRowCount={gridData.totalRowCount}\n * isLoading={gridData.isLoading}\n * state={gridState}\n * onChange={setGridState}\n * getRowId={(row) => row.id}\n * />\n * ```\n *\n * Rules:\n * - Call this hook unconditionally at the top level, before any early return.\n * - `rows` on `DataGrid` must ALWAYS be `gridData.rows`, never your raw array.\n * - For server or infinite pagination, use `dataSource` — see the\n * `DataGridDataSource` type for the generator signature.\n *\n * Quick search:\n * - Client mode (`data` prop): the hook auto-filters rows via\n * `applyQuickSearch` using a default case-insensitive substring match\n * across every column. Override with `matchRow` for custom matching\n * (fuzzy, weighted, field-specific, etc.).\n * - Async mode (`dataSource` prop): the hook passes `quickSearch` into\n * `params.quickSearch` and re-runs the generator whenever the search\n * string changes. The consumer owns the matching logic (typically by\n * folding it into a backend query). The grid performs NO client-side\n * filtering in async mode.\n */\nexport function useDataSource<TRow>(opts: {\n data?: readonly TRow[];\n dataSource?: DataGridDataSource<TRow>;\n columns: readonly DataGridColumnDef<TRow>[];\n getRowId: (row: TRow) => RowId;\n sorting: DataGridSortModel;\n /** Current quick-search text, typically `gridState.quickSearch`. */\n quickSearch: string;\n /** Override the default client-mode matcher. Ignored in async mode\n * (there the generator is the matcher). */\n matchRow?: (\n row: TRow,\n query: string,\n columns: readonly DataGridColumnDef<TRow>[],\n ) => boolean;\n pagination: DataGridPaginationModel;\n paginationMode: DataGridDataPaginationMode;\n}): UseDataSourceResult<TRow> {\n const {\n data,\n dataSource,\n columns,\n getRowId,\n sorting,\n quickSearch,\n matchRow = defaultMatchRow,\n pagination,\n paginationMode,\n } = opts;\n\n const isClientMode = data != null && !dataSource;\n\n if (process.env.NODE_ENV !== \"production\" && data == null && dataSource == null) {\n // eslint-disable-next-line no-console\n console.warn(\n \"[useDataSource] neither `data` nor `dataSource` was provided — \"\n + \"the grid will render empty indefinitely. Pass one or the other.\"\n );\n }\n\n // Common footgun: consumers pass `data` as a fully-materialized array and\n // set `paginationMode: \"infinite\"` expecting the grid to page through it.\n // In client mode \"infinite\" skips `paginateRows` and returns every row;\n // `hasMore` / `loadMore` on the result are always false/no-ops. If you\n // want real paging, switch to `paginationMode: \"server\"` with a\n // `dataSource` generator. If you want in-memory slicing, use `\"client\"`.\n // If you're manually accumulating rows into `data` and driving the grid's\n // sentinel via your own `hasMore`/`onLoadMore`, this warning is a hint —\n // but current behavior (full list + external sentinel) is intentional.\n if (\n process.env.NODE_ENV !== \"production\"\n && isClientMode\n && paginationMode === \"infinite\"\n && data.length > 0\n ) {\n // eslint-disable-next-line no-console\n console.warn(\n \"[useDataSource] `paginationMode: \\\"infinite\\\"` with a `data` array \"\n + \"skips pagination entirely. Prefer `\\\"client\\\"` for in-memory lists \"\n + \"or `\\\"server\\\"` + a `dataSource` generator for real paging.\"\n );\n }\n\n const clientResult = useClientDataSource({\n data: data ?? [],\n columns,\n sorting,\n quickSearch,\n matchRow,\n pagination,\n paginationMode,\n });\n\n const asyncResult = useAsyncDataSource({\n dataSource: dataSource ?? NOOP_DATA_SOURCE,\n getRowId: dataSource ? getRowId : NOOP_GET_ROW_ID,\n sorting,\n quickSearch,\n pagination,\n paginationMode,\n });\n\n return isClientMode ? clientResult : asyncResult;\n}\n"],"mappings":";;;;AA8CA,SAAS,oBAA0B,MAYL;CAC5B,MAAM,EAAE,MAAM,SAAS,SAAS,aAAa,UAAU,YAAY,mBAAmB;CAKtF,MAAM,aAAA,GAAA,MAAA,QAAA,OAA0B;EAK9B,MAAM,YAAA,GAAA,WAAA,iBAAA,CAA4B,MAAM,aAAa,SAAS,QAAQ;EACtE,MAAM,cAAA,GAAA,WAAA,mBAAA,CAAgC,SAAS,OAAO;EACtD,MAAM,SAAS,aAAa,CAAC,GAAG,QAAQ,CAAC,CAAC,KAAK,UAAU,IAAI;EAC7D,MAAM,gBAAgB,OAAO;EAK7B,OAAO;GAAE,MAHP,mBAAmB,YAAA,GAAA,WAAA,aAAA,CACF,QAA2B,UAAU,IAClD;GACgB;EAAc;CACtC,GAAG;EAAC;EAhBe,KAAK,UAAU,OAgBf;EAAG;EAAa;EAAU,WAAW;EAAW,WAAW;EAAU;EAAgB;CAAO,CAAC;CAEhH,QAAA,GAAA,MAAA,QAAA,QAAsB;EACpB,MAAM,UAAU;EAChB,eAAe,UAAU;EACzB,WAAW;EACX,cAAc;EACd,eAAe;EACf,gBAAgB,CAAC;EACjB,SAAS;EACT,cAAc,CAAC;EACf,OAAO;CACT,IAAI,CAAC,SAAS,CAAC;AACjB;AAOA,SAAS,mBAAyB,MAOJ;CAC5B,MAAM,EACJ,YACA,UACA,SACA,aACA,YACA,mBACE;CAEJ,MAAM,CAAC,MAAM,YAAA,GAAA,MAAA,SAAA,CAA4B,CAAC,CAAC;CAC3C,MAAM,CAAC,eAAe,qBAAA,GAAA,MAAA,SAAA,CAAiD,KAAA,CAAS;CAChF,MAAM,CAAC,WAAW,iBAAA,GAAA,MAAA,SAAA,CAAyB,IAAI;CAC/C,MAAM,CAAC,cAAc,oBAAA,GAAA,MAAA,SAAA,CAA4B,KAAK;CACtD,MAAM,CAAC,eAAe,qBAAA,GAAA,MAAA,SAAA,CAA6B,KAAK;CACxD,MAAM,CAAC,SAAS,eAAA,GAAA,MAAA,SAAA,CAAuB,IAAI;CAC3C,MAAM,CAAC,OAAO,aAAA,GAAA,MAAA,SAAA,CAAmC,IAAI;CAErD,MAAM,aAAA,GAAA,MAAA,OAAA,CAA4B,KAAA,CAAS;CAC3C,MAAM,YAAA,GAAA,MAAA,OAAA,CAA0C,IAAI;CACpD,MAAM,gBAAA,GAAA,MAAA,OAAA,CAAsB,CAAC;CAC7B,MAAM,cAAA,GAAA,MAAA,OAAA,CAAoB,KAAK;CAC/B,MAAM,iCAAA,GAAA,MAAA,OAAA,CAAuC,KAAK;CAElD,MAAM,iBAAA,GAAA,MAAA,OAAA,CAAuB;EAC3B;EACA;EACA;EACA;EACA;CACF,CAAC;CACD,cAAc,UAAU;EAAE;EAAY;EAAU;EAAS;EAAa;CAAW;CAEjF,MAAM,aAAa,KAAK,UAAU,OAAO;CACzC,MAAM,iBAAiB;CAEvB,MAAM,aAAA,GAAA,MAAA,YAAA,CACJ,OAAO,WAAoB;EACzB,MAAM,EACJ,YAAY,mBACZ,UAAU,iBACV,SAAS,gBACT,aAAa,oBACb,YAAY,sBACV,cAAc;EAElB,SAAS,SAAS,MAAM;EACxB,MAAM,aAAa,IAAI,gBAAgB;EACvC,SAAS,UAAU;EAEnB,IAAI,QACF,iBAAiB,IAAI;OAChB;GAEL,IAAI,WAAW,SACb,gBAAgB,IAAI;QAEpB,aAAa,IAAI;GAEnB,UAAU,UAAU,KAAA;GACpB,aAAa,UAAU;EACzB;EAGA,SAAS,IAAI;EAEb,IAAI;GAUF,MAAM,MAAM,kBAAkB;IAR5B,SAAS;IACT,aAAa;IACb,YAAY,SACR;KAAE,WAAW,aAAa;KAAS,UAAU,kBAAkB;IAAS,IACxE;IACJ,QAAQ,UAAU;GAGe,CAAC;GAEpC,WAAW,MAAM,UAAU,KAAK;IAC9B,IAAI,WAAW,OAAO,SAAS;IAE/B,IAAI,OAAO,iBAAiB,MAC1B,iBAAiB,OAAO,aAAa;IAEvC,IAAI,OAAO,eAAe,KAAA,GACxB,UAAU,UAAU,OAAO;IAE7B,WAAW,OAAO,YAAY,KAAK;IAEnC,IAAI,QACF,SAAS,SAAS;KAChB,MAAM,cAAc,IAAI,IAAI,KAAK,IAAI,eAAe,CAAC;KACrD,MAAM,UAAU,OAAO,KAAK,QACzB,MAAM,CAAC,YAAY,IAAI,gBAAgB,CAAC,CAAC,CAC5C;KACA,OAAO,CAAC,GAAG,MAAM,GAAG,OAAO;IAC7B,CAAC;SAED,QAAQ,OAAO,IAAI;IAGrB,WAAW,UAAU;IACrB,aAAa;GACf;EACF,SAAS,KAAK;GACZ,IAAI,WAAW,OAAO,SAAS;GAK/B,QAAQ,MAAM,iCAAiC,GAAG;GAClD,SAAS,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC,CAAC;EAC9D,UAAU;GACR,IAAI,CAAC,WAAW,OAAO,SAAS;IAC9B,aAAa,KAAK;IAClB,gBAAgB,KAAK;IACrB,iBAAiB,KAAK;GACxB;EACF;CACF,GACA,CAAC,CACH;CAEA,CAAA,GAAA,MAAA,UAAA,OAAgB;EACd,UAAU,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC;EAC/B,aAAa,SAAS,SAAS,MAAM;CAIvC,GAAG;EAAC;EAAW;EAAY;EAAY;EAAgB,WAAW;CAAQ,CAAC;CAE3E,CAAA,GAAA,MAAA,UAAA,OAAgB;EACd,IAAI,mBAAmB,UAAU;GAC/B,8BAA8B,UAAU;GACxC;EACF;EACA,IAAI,CAAC,8BAA8B,SAAS;GAC1C,8BAA8B,UAAU;GACxC;EACF;EACA,UAAU,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC;CACjC,GAAG;EAAC;EAAW;EAAgB,WAAW;CAAS,CAAC;CAYpD,OAAO;EACL;EACA;EACA;EACA;EACA;EACA,WAAA,GAAA,MAAA,YAAA,OAhBiC;GACjC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,YAClD,UAAU,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;EAElC,GAAG;GAAC;GAAe;GAAS;GAAgB;EAAS,CAY5C;EACP;EACA,SAAA,GAAA,MAAA,YAAA,OAZ+B;GAC/B,UAAU,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC;EACjC,GAAG,CAAC,SAAS,CAUN;EACL;CACF;AACF;AAGA,MAAM,mBAA4C,mBAAmB,CAAC;AACtE,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwD9B,SAAgB,cAAoB,MAiBN;CAC5B,MAAM,EACJ,MACA,YACA,SACA,UACA,SACA,aACA,WAAWA,WAAAA,iBACX,YACA,mBACE;CAEJ,MAAM,eAAe,QAAQ,QAAQ,CAAC;CAEtC,IAAI,QAAQ,IAAI,aAAa,gBAAgB,QAAQ,QAAQ,cAAc,MAEzE,QAAQ,KACN,gIAEF;CAYF,IACE,QAAQ,IAAI,aAAa,gBACtB,gBACA,mBAAmB,cACnB,KAAK,SAAS,GAGjB,QAAQ,KACN,mMAGF;CAGF,MAAM,eAAe,oBAAoB;EACvC,MAAM,QAAQ,CAAC;EACf;EACA;EACA;EACA;EACA;EACA;CACF,CAAC;CAED,MAAM,cAAc,mBAAmB;EACrC,YAAY,cAAc;EAC1B,UAAU,aAAa,WAAW;EAClC;EACA;EACA;EACA;CACF,CAAC;CAED,OAAO,eAAe,eAAe;AACvC"}
|
|
@@ -1,38 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
//#region src/components/data-grid/use-url-state.d.ts
|
|
4
|
-
type UrlStateOptions = {
|
|
5
|
-
/** Disambiguates URL params when multiple grids share a page. Defaults
|
|
6
|
-
* to `"grid"`. Use unique prefixes per-grid (e.g. `"users"`, `"teams"`). */
|
|
7
|
-
paramPrefix?: string;
|
|
8
|
-
/** Overrides for default state used when the URL has no value for a
|
|
9
|
-
* given key. Useful for things like a sensible initial sort (e.g.
|
|
10
|
-
* "newest signups first") that should appear on first load but be
|
|
11
|
-
* overridden when the user navigates to a bookmarked URL. */
|
|
12
|
-
initial?: Partial<Pick<DataGridState, "sorting" | "quickSearch" | "columnVisibility">>;
|
|
13
|
-
};
|
|
14
|
-
/**
|
|
15
|
-
* Drop-in replacement for `useState(() => createDefaultDataGridState(columns))`
|
|
16
|
-
* that persists user view preferences to URL search params, so a view
|
|
17
|
-
* can be bookmarked / shared / restored on reload.
|
|
18
|
-
*
|
|
19
|
-
* **Persisted:** column widths, hidden columns, sort model, quick-search.
|
|
20
|
-
* **Not persisted** (deliberately): pagination scroll position, selection,
|
|
21
|
-
* column pinning/order, date display mode — these are session-scoped.
|
|
22
|
-
*
|
|
23
|
-
* ```tsx
|
|
24
|
-
* const [gridState, setGridState] = useDataGridUrlState(columns, {
|
|
25
|
-
* paramPrefix: "users",
|
|
26
|
-
* initial: { sorting: [{ columnId: "signedUpAt", direction: "desc" }] },
|
|
27
|
-
* });
|
|
28
|
-
* ```
|
|
29
|
-
*
|
|
30
|
-
* URL encoding: `?{prefix}_w=...&{prefix}_h=...&{prefix}_s=...&{prefix}_q=...`.
|
|
31
|
-
* Default values are omitted so URLs stay clean. Updates use
|
|
32
|
-
* `history.replaceState` (not pushState) so back/forward isn't polluted,
|
|
33
|
-
* and `popstate` is observed so external URL changes flow back into state.
|
|
34
|
-
*/
|
|
35
|
-
declare function useDataGridUrlState<TRow>(columns: readonly DataGridColumnDef<TRow>[], opts?: UrlStateOptions): [DataGridState, React.Dispatch<React.SetStateAction<DataGridState>>];
|
|
36
|
-
//#endregion
|
|
37
|
-
export { useDataGridUrlState };
|
|
38
|
-
//# sourceMappingURL=use-url-state.d.ts.map
|
|
1
|
+
import { t as useDataGridUrlState } from "../../use-url-state-B4_wnBjm.js";
|
|
2
|
+
export { useDataGridUrlState };
|
|
@@ -1,11 +1,8 @@
|
|
|
1
1
|
"use client";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
4
|
-
const require_chunk = require('../../chunk-BE-pF4vm.js');
|
|
2
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
5
3
|
let react = require("react");
|
|
6
4
|
let __state_js = require("./state.js");
|
|
7
5
|
let __data_grid_sizing_js = require("./data-grid-sizing.js");
|
|
8
|
-
|
|
9
6
|
//#region src/components/data-grid/use-url-state.ts
|
|
10
7
|
function serializeWidths(widths, columns) {
|
|
11
8
|
const parts = [];
|
|
@@ -208,7 +205,7 @@ function useDataGridUrlState(columns, opts) {
|
|
|
208
205
|
]);
|
|
209
206
|
return [state, setState];
|
|
210
207
|
}
|
|
211
|
-
|
|
212
208
|
//#endregion
|
|
213
209
|
exports.useDataGridUrlState = useDataGridUrlState;
|
|
210
|
+
|
|
214
211
|
//# sourceMappingURL=use-url-state.js.map
|