@svgrid/grid 2.2.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (114) hide show
  1. package/dist/FlexRender.svelte +96 -96
  2. package/dist/GridFooter.svelte +178 -178
  3. package/dist/SvCarousel.svelte +141 -141
  4. package/dist/SvColorInput.svelte +187 -187
  5. package/dist/SvContextMenu.svelte +116 -116
  6. package/dist/SvDrawer.svelte +250 -250
  7. package/dist/SvGrid.svelte +3131 -3131
  8. package/dist/SvGridBoard.svelte +2339 -2339
  9. package/dist/SvGridChart.svelte +1724 -1724
  10. package/dist/SvGridChartPanel.svelte +485 -485
  11. package/dist/SvGridDropdown.svelte +689 -689
  12. package/dist/SvGroupCell.svelte +109 -109
  13. package/dist/SvMenu.svelte +124 -124
  14. package/dist/SvMenuList.svelte +117 -117
  15. package/dist/SvNumberInput.svelte +131 -131
  16. package/dist/SvOtpInput.svelte +158 -158
  17. package/dist/SvPopover.svelte +139 -139
  18. package/dist/SvRowGroupPanel.svelte +170 -170
  19. package/dist/SvScrollArea.svelte +61 -61
  20. package/dist/SvTooltip.svelte +127 -127
  21. package/dist/SvTour.svelte +204 -204
  22. package/dist/SvTree.svelte +377 -377
  23. package/dist/SvTreeSelect.svelte +230 -230
  24. package/dist/cdn/svgrid.js +8 -8
  25. package/dist/cdn/svgrid.svelte-external.js +8 -8
  26. package/dist/chart-export.js +8 -8
  27. package/package.json +10 -10
  28. package/src/FlexRender.svelte +96 -96
  29. package/src/GridFooter.svelte +178 -178
  30. package/src/SvCarousel.svelte +141 -141
  31. package/src/SvColorInput.svelte +187 -187
  32. package/src/SvContextMenu.svelte +116 -116
  33. package/src/SvDrawer.svelte +250 -250
  34. package/src/SvGrid.controller.svelte.ts +3158 -3158
  35. package/src/SvGrid.svelte +3131 -3131
  36. package/src/SvGrid.types.ts +1489 -1489
  37. package/src/SvGridBoard.svelte +2339 -2339
  38. package/src/SvGridChart.svelte +1724 -1724
  39. package/src/SvGridChartPanel.svelte +485 -485
  40. package/src/SvGridDropdown.svelte +689 -689
  41. package/src/SvGroupCell.svelte +109 -109
  42. package/src/SvMenu.svelte +124 -124
  43. package/src/SvMenu.test.ts +97 -97
  44. package/src/SvMenuList.svelte +117 -117
  45. package/src/SvNumberInput.svelte +131 -131
  46. package/src/SvOtpInput.svelte +158 -158
  47. package/src/SvPopover.svelte +139 -139
  48. package/src/SvRowGroupPanel.svelte +170 -170
  49. package/src/SvScrollArea.svelte +61 -61
  50. package/src/SvTooltip.svelte +127 -127
  51. package/src/SvTour.svelte +204 -204
  52. package/src/SvTree.svelte +377 -377
  53. package/src/SvTreeSelect.svelte +230 -230
  54. package/src/a11y.contract.test.ts +49 -49
  55. package/src/a11y.test.ts +59 -59
  56. package/src/a11y.ts +61 -61
  57. package/src/build-api.ts +870 -870
  58. package/src/cell-formatting.ts +169 -169
  59. package/src/cell-render.ts +469 -469
  60. package/src/chart-export.ts +201 -201
  61. package/src/chart.ts +2296 -2296
  62. package/src/collaboration.test.ts +104 -104
  63. package/src/collaboration.ts +167 -167
  64. package/src/core.performance.test.ts +30 -30
  65. package/src/core.ts +1111 -1111
  66. package/src/createAutocomplete.svelte.ts +132 -132
  67. package/src/createCombobox.svelte.ts +179 -179
  68. package/src/createCountryInput.svelte.ts +157 -157
  69. package/src/createDropdownList.svelte.ts +162 -162
  70. package/src/createGrid.svelte.ts +42 -42
  71. package/src/createGrid.test.ts +10 -10
  72. package/src/createGridState.svelte.ts +17 -17
  73. package/src/createMenu.svelte.ts +202 -202
  74. package/src/createPopoverSelect.svelte.ts +206 -206
  75. package/src/createTree.svelte.ts +319 -319
  76. package/src/editing.test.ts +859 -859
  77. package/src/editing.ts +675 -675
  78. package/src/export-data-api.test.ts +126 -126
  79. package/src/export-format.test.ts +107 -107
  80. package/src/export-format.ts +598 -598
  81. package/src/flex-render.ts +3 -3
  82. package/src/index.ts +623 -623
  83. package/src/keyboard.test.ts +59 -59
  84. package/src/keyboard.ts +97 -97
  85. package/src/list-nav.test.ts +49 -49
  86. package/src/list-nav.ts +29 -29
  87. package/src/menus.ts +639 -639
  88. package/src/merge-objects.ts +48 -48
  89. package/src/overlays.test.ts +90 -90
  90. package/src/render-component.ts +28 -28
  91. package/src/selection.test.ts +754 -754
  92. package/src/selection.ts +600 -600
  93. package/src/server-data-source.test.ts +289 -289
  94. package/src/server-data-source.ts +413 -413
  95. package/src/sparkline.test.ts +68 -68
  96. package/src/sparkline.ts +169 -169
  97. package/src/spreadsheet.test.ts +489 -489
  98. package/src/spreadsheet.ts +312 -312
  99. package/src/static-functions.ts +11 -11
  100. package/src/subscribe.ts +38 -38
  101. package/src/svgrid-wrapper.types.ts +501 -501
  102. package/src/svgrid.behavior.test.ts +706 -706
  103. package/src/svgrid.charting.test.ts +527 -527
  104. package/src/svgrid.features.test.ts +157 -157
  105. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  106. package/src/svgrid.wrapper.test.ts +40 -40
  107. package/src/test-setup.ts +62 -62
  108. package/src/themes/index.ts +159 -159
  109. package/src/virtualization/column-virtualizer.test.ts +27 -27
  110. package/src/virtualization/column-virtualizer.ts +30 -30
  111. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  112. package/src/virtualization/types.ts +30 -30
  113. package/src/virtualization/virtualizer.test.ts +47 -47
  114. package/src/virtualization/virtualizer.ts +296 -296
package/src/menus.ts CHANGED
@@ -1,639 +1,639 @@
1
- // menus handlers extracted from the controller. Imperative event handlers
2
- // reading/writing controller state via the `ctx` handle; the reactive core
3
- // ($state/$derived/$effect) stays in the controller.
4
- import {
5
- applyExcelFilter,
6
- normalizeForFilter,
7
- createColumnVirtualizer,
8
- createCoreRowModel,
9
- createExpandedRowModel,
10
- createFilteredRowModel,
11
- createGroupedRowModel,
12
- createPaginatedRowModel,
13
- createSvelteVirtualizer,
14
- createSortedRowModel,
15
- createSvGrid,
16
- filterFns,
17
- getGridCellA11yProps,
18
- getGridCellDomId,
19
- getGridHeaderA11yProps,
20
- getGridRootA11yProps,
21
- getGridRowA11yProps,
22
- parseEditorValue,
23
- normalizeEditorOptions,
24
- sortFns,
25
- tableFeatures,
26
- rowSortingFeature,
27
- columnFilteringFeature,
28
- columnGroupingFeature,
29
- type CellContext,
30
- type EditorContext,
31
- type CellEditorOption,
32
- type CellEditorType,
33
- type CellFormatter,
34
- type CellFormatConfig,
35
- type Column,
36
- type ColumnDef,
37
- type Row,
38
- type RowData,
39
- type SvGridApi,
40
- type TableFeatures,
41
- } from "./index";
42
- import "./sv-grid-scrollbar";
43
- import { untrack } from "svelte";
44
- import type { Snippet } from "svelte";
45
- import { getKeyboardIntent, getNextActiveCell } from "./keyboard";
46
- import {
47
- formatNumericWithConfig,
48
- getDateFormatter,
49
- resolveDatePattern,
50
- } from "./cell-formatting";
51
- import {
52
- RenderSnippetConfig,
53
- RenderComponentConfig,
54
- } from "./render-component";
55
- import { buildFillPattern } from "./fill-patterns";
56
- import { buildSparkline, toSparklineValues } from "./sparkline";
57
- import {
58
- resolveCellFormat,
59
- computeColumnStat,
60
- formatsNeedingStats,
61
- type ColumnStat,
62
- type ResolvedCellFormat,
63
- } from "./conditional-formatting";
64
- import SvGridDropdown from "./SvGridDropdown.svelte";
65
- import type {
66
- Props,
67
- SelectionPoint,
68
- SelectionRange,
69
- CellEditState,
70
- FilterOperator,
71
- FilterOption,
72
- MenuPosition,
73
- } from "./SvGrid.types";
74
- import {
75
- cfTextStyle,
76
- fmtStat,
77
- getCellKey,
78
- resolveClassList,
79
- toDateInputValue,
80
- toDateTimeLocalInputValue,
81
- getEditableInputValue,
82
- getEditorInputType,
83
- toValueArray,
84
- getOptionLabel,
85
- getOptionColor,
86
- colorfulChipStyle,
87
- getEditorClass,
88
- asDate,
89
- clampMenuX,
90
- cssEscape,
91
- rawToNumber,
92
- formatFacetNumber,
93
- formatFacetDate,
94
- } from "./SvGrid.helpers";
95
- import { createCellRender } from "./cell-render";
96
- import { createEditing } from "./editing";
97
- import { createSelection } from "./selection";
98
- import { createColumns } from "./columns";
99
- import { createGridApi } from "./build-api";
100
- import { createClipboard } from "./clipboard";
101
- import {
102
- filterOperatorOptions,
103
- fallbackOperatorOption,
104
- TEXT_OPERATORS,
105
- NUMBER_OPERATORS,
106
- DATE_OPERATORS,
107
- CHECKBOX_OPERATORS,
108
- operatorOption,
109
- operatorsForColumn,
110
- defaultOperatorFor,
111
- operatorLabelFor,
112
- } from "./filter-operators";
113
- import {
114
- type FacetBucket,
115
- isBucketableColumn,
116
- buildBuckets,
117
- isInBucket,
118
- } from "./facet-buckets";
119
- import { splitInTokens, joinInTokens } from "./filtering/excel-filters";
120
- import {
121
- getColumnBaseValue,
122
- isGroupRow,
123
- toolPanelHeaderLabel,
124
- formatSummaryNumeric,
125
- getColumnAlign,
126
- getPinnedCellValue,
127
- getColumnAccessorValue,
128
- columnDefMatchesId,
129
- } from "./cell-values";
130
-
131
- export function createMenus<
132
- TFeatures extends TableFeatures = TableFeatures,
133
- TData extends RowData = RowData,
134
- >(ctx: any) {
135
- function updateFilterRow(columnId: string, value: string) {
136
- ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
137
- const current = ctx.filterMenuValues[columnId] ?? {
138
- operator: "contains" as const,
139
- value: "",
140
- };
141
- ctx.filterMenuValues = {
142
- ...ctx.filterMenuValues,
143
- [columnId]: { ...current, value },
144
- };
145
- }
146
-
147
- function updateFilterOperator(columnId: string, operator: FilterOperator) {
148
- const current = ctx.filterMenuValues[columnId] ?? {
149
- operator: "contains" as const,
150
- value: "",
151
- };
152
- ctx.filterMenuValues = {
153
- ...ctx.filterMenuValues,
154
- [columnId]: { ...current, operator },
155
- };
156
- }
157
-
158
- function updateFilterMenuValue(columnId: string, value: string) {
159
- const current = ctx.filterMenuValues[columnId] ?? {
160
- operator: "contains" as const,
161
- value: "",
162
- };
163
- ctx.filterMenuValues = {
164
- ...ctx.filterMenuValues,
165
- [columnId]: { ...current, value },
166
- };
167
- ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
168
- }
169
-
170
- /** Upper-bound input for the `between` operator. Only relevant when
171
- * the column's current operator is `between`; harmless to call
172
- * otherwise. */
173
- function updateFilterMenuValueTo(columnId: string, valueTo: string) {
174
- const current = ctx.filterMenuValues[columnId] ?? {
175
- operator: "between" as const,
176
- value: "",
177
- };
178
- ctx.filterMenuValues = {
179
- ...ctx.filterMenuValues,
180
- [columnId]: { ...current, valueTo },
181
- };
182
- }
183
-
184
- /** Current `in` / `notIn` token list for a column (from the filter-row value). */
185
- function filterTokens(columnId: string): string[] {
186
- return splitInTokens(ctx.filterRowValues[columnId] ?? "");
187
- }
188
-
189
- /** Add a value to a column's `in` / `notIn` list (no-op if already present). */
190
- function addFilterToken(columnId: string, token: string) {
191
- const t = token.trim();
192
- if (!t) return;
193
- const tokens = filterTokens(columnId);
194
- if (!tokens.includes(t)) tokens.push(t);
195
- updateFilterRow(columnId, joinInTokens(tokens));
196
- }
197
-
198
- /** Remove a value from a column's `in` / `notIn` list. */
199
- function removeFilterToken(columnId: string, token: string) {
200
- updateFilterRow(
201
- columnId,
202
- joinInTokens(filterTokens(columnId).filter((t) => t !== token)),
203
- );
204
- }
205
-
206
- /** Toggle a value in a column's `in` / `notIn` list (checklist behaviour). */
207
- function toggleFilterToken(columnId: string, token: string) {
208
- if (filterTokens(columnId).includes(token)) removeFilterToken(columnId, token);
209
- else addFilterToken(columnId, token);
210
- }
211
-
212
- function toggleCheckboxWithKeyboard(
213
- event: KeyboardEvent,
214
- toggle: () => void,
215
- ) {
216
- if (event.key !== "Enter" && event.key !== " ") return;
217
- event.preventDefault();
218
- toggle();
219
- }
220
-
221
- function isColumnFiltered(columnId: string) {
222
- if (ctx.valueFilters[columnId]) return true;
223
- const menuFilter = ctx.filterMenuValues[columnId];
224
- return Boolean(
225
- menuFilter &&
226
- (menuFilter.operator === "isBlank" ||
227
- menuFilter.operator === "isNotBlank" ||
228
- menuFilter.value.trim()),
229
- );
230
- }
231
-
232
- function closeMenus() {
233
- ctx.columnMenuFor = null;
234
- ctx.filterMenuFor = null;
235
- ctx.operatorMenuFor = null;
236
- ctx.inSuggestFor = null;
237
- ctx.chooseColumnsPos = null;
238
- }
239
-
240
- /** Open the `in` / `notIn` value-suggestions dropdown under a chip input. */
241
- function openInSuggest(anchor: HTMLElement, columnId: string) {
242
- const rect = anchor.getBoundingClientRect();
243
- ctx.inSuggestPos = { x: clampMenuX(rect.left, 220), y: rect.bottom + 4 };
244
- ctx.inSuggestQuery = "";
245
- ctx.inSuggestFor = columnId;
246
- }
247
-
248
- function closeInSuggest() {
249
- ctx.inSuggestFor = null;
250
- ctx.inSuggestQuery = "";
251
- }
252
-
253
- function openChooseColumns(event: MouseEvent) {
254
- event.stopPropagation();
255
- // Submenu behavior: keep the parent operations menu open and float the
256
- // Choose Columns panel out to the right of it (AG-Grid style). Falls
257
- // back to below the item if the popover would clip the viewport.
258
- const trigger = event.currentTarget as HTMLElement;
259
- const menuEl = trigger.closest(".sv-grid-menu") as HTMLElement | null;
260
- const anchor = (menuEl ?? trigger).getBoundingClientRect();
261
- const panelWidth = 240;
262
- const wantRight = anchor.right + 4;
263
- const x =
264
- wantRight + panelWidth + 8 > window.innerWidth
265
- ? clampMenuX(anchor.left - panelWidth - 4, panelWidth)
266
- : clampMenuX(wantRight, panelWidth);
267
- ctx.chooseColumnsPos = { x, y: anchor.top };
268
- }
269
-
270
- function openColumnMenu(event: MouseEvent, columnId: string) {
271
- event.stopPropagation();
272
- const wasOpen = ctx.columnMenuFor === columnId;
273
- closeMenus();
274
- if (wasOpen) return;
275
- const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
276
- ctx.columnMenuPos = {
277
- x: clampMenuX(rect.right - 240, 240),
278
- y: rect.bottom + 4,
279
- };
280
- ctx.columnMenuTab = "general";
281
- ctx.columnMenuFor = columnId;
282
- }
283
-
284
- function openFilterMenu(event: MouseEvent, columnId: string) {
285
- event.stopPropagation();
286
- const wasOpen = ctx.filterMenuFor === columnId;
287
- closeMenus();
288
- if (wasOpen) return;
289
-
290
- // If the consumer is running in row-mode (or any mode where the
291
- // funnel popover wouldn't render), redirect the click to the
292
- // inline filter input for this column. Without this the funnel
293
- // would be a dead button - it visibly clicks but nothing happens
294
- // because the menu is gated behind `showColumnFiltersEffective`.
295
- if (!ctx.showColumnFiltersEffective && ctx.showFilterRowEffective) {
296
- // Find the row-mode filter input and focus it. The input is
297
- // tagged with `data-svgrid-filter-col` so we can target by id
298
- // without depending on column position.
299
- const input = (ctx.scrollContainer as HTMLElement | null)?.querySelector<HTMLInputElement>(
300
- `[data-svgrid-filter-col="${cssEscape(columnId)}"]`,
301
- );
302
- if (input) {
303
- input.focus();
304
- input.select();
305
- // Brief pulse so the user sees where focus landed.
306
- input.classList.add("sv-grid-filter-value-pulse");
307
- setTimeout(() => input.classList.remove("sv-grid-filter-value-pulse"), 700);
308
- }
309
- return;
310
- }
311
-
312
- const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
313
- ctx.filterMenuPos = {
314
- x: clampMenuX(rect.right - 260, 260),
315
- y: rect.bottom + 4,
316
- };
317
- ctx.columnMenuSearch = "";
318
- ctx.filterMenuFor = columnId;
319
- }
320
-
321
- function openOperatorMenu(event: MouseEvent, columnId: string) {
322
- event.stopPropagation();
323
- const wasOpen = ctx.operatorMenuFor === columnId;
324
- closeMenus();
325
- if (wasOpen) return;
326
- const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
327
- ctx.operatorMenuPos = { x: clampMenuX(rect.left, 184), y: rect.bottom + 4 };
328
- ctx.operatorMenuFor = columnId;
329
- }
330
-
331
- function sortColumnFromMenu(columnId: string, desc: boolean) {
332
- ctx.grid.store.setState((prev: any) => ({
333
- ...prev,
334
- sorting: [{ id: columnId, desc }],
335
- }));
336
- closeMenus();
337
- }
338
-
339
- function clearColumnSort(columnId: string) {
340
- ctx.grid.store.setState((prev: any) => ({
341
- ...prev,
342
- sorting: (prev.sorting ?? []).filter(
343
- (entry: { id: string }) => entry.id !== columnId,
344
- ),
345
- }));
346
- closeMenus();
347
- }
348
-
349
- function groupByColumnFromMenu(columnId: string) {
350
- const current = ctx.grid.getState().grouping ?? [];
351
- if (current.includes(columnId)) {
352
- closeMenus();
353
- return;
354
- }
355
- ctx.grid.setGrouping([...current, columnId]);
356
- closeMenus();
357
- }
358
-
359
- function clearGroupingFromMenu(columnId: string) {
360
- const current = ctx.grid.getState().grouping ?? [];
361
- ctx.grid.setGrouping(current.filter((id: string) => id !== columnId));
362
- closeMenus();
363
- }
364
-
365
- function isFacetChecked(columnId: string, value: string) {
366
- const selected = ctx.valueFilters[columnId];
367
- return selected ? selected.has(value) : true;
368
- }
369
-
370
- function toggleFacetValue(columnId: string, value: string) {
371
- const allValues = ctx.columnMenuFacetValues;
372
- const next = new Set(ctx.valueFilters[columnId] ?? allValues);
373
- if (next.has(value)) next.delete(value);
374
- else next.add(value);
375
- if (next.size === allValues.length) {
376
- const copy = { ...ctx.valueFilters };
377
- delete copy[columnId];
378
- ctx.valueFilters = copy;
379
- } else {
380
- ctx.valueFilters = { ...ctx.valueFilters, [columnId]: next };
381
- }
382
- }
383
-
384
- function isAllFacetsChecked(columnId: string) {
385
- const selected = ctx.valueFilters[columnId];
386
- return !selected || selected.size >= ctx.columnMenuFacetValues.length;
387
- }
388
-
389
- function toggleAllFacets(columnId: string) {
390
- if (isAllFacetsChecked(columnId)) {
391
- ctx.valueFilters = { ...ctx.valueFilters, [columnId]: new Set<string>() };
392
- } else {
393
- const copy = { ...ctx.valueFilters };
394
- delete copy[columnId];
395
- ctx.valueFilters = copy;
396
- }
397
- }
398
-
399
- function clearColumnFilter(columnId: string) {
400
- // `untrack`: read-modify-write on the filter maps. Keeps the method safe to
401
- // call from a consumer's reactive `$effect` (e.g. via `api.clearFilter`)
402
- // without capturing these reads as a dependency and looping. See
403
- // `build-api`'s `setFilter` for the full rationale.
404
- untrack(() => {
405
- if (ctx.valueFilters[columnId]) {
406
- const next = { ...ctx.valueFilters };
407
- delete next[columnId];
408
- ctx.valueFilters = next;
409
- }
410
- if (ctx.filterMenuValues[columnId]) {
411
- const next = { ...ctx.filterMenuValues };
412
- delete next[columnId];
413
- ctx.filterMenuValues = next;
414
- }
415
- if (ctx.filterRowValues[columnId]) {
416
- const next = { ...ctx.filterRowValues };
417
- delete next[columnId];
418
- ctx.filterRowValues = next;
419
- }
420
- });
421
- }
422
-
423
- // External pagination is controlled: emit the requested page/size and let
424
- // the consumer fetch + update props. Never mutate local pagination state.
425
- function emitExternalPagination(pageIndex: number, pageSize: number): boolean {
426
- if (ctx.props.externalPagination !== true) return false;
427
- ctx.props.onPaginationChange?.({ pageIndex: Math.max(0, pageIndex), pageSize });
428
- ctx.scrollContainer?.scrollTo?.({ top: 0 });
429
- return true;
430
- }
431
-
432
- function changePage(delta: number) {
433
- if (
434
- emitExternalPagination(
435
- (ctx.props.pageIndex ?? 0) + delta,
436
- ctx.props.pageSize ?? 10,
437
- )
438
- )
439
- return;
440
- ctx.grid.setPagination((prev: any) => ({
441
- ...prev,
442
- pageIndex: Math.max((prev?.pageIndex ?? 0) + delta, 0),
443
- }));
444
- ctx.scrollContainer?.scrollTo?.({ top: 0 });
445
- }
446
-
447
- function goToPage(pageIndex: number) {
448
- if (emitExternalPagination(pageIndex, ctx.props.pageSize ?? 10)) return;
449
- ctx.grid.setPagination((prev: any) => ({
450
- ...prev,
451
- pageIndex: Math.max(0, pageIndex),
452
- }));
453
- ctx.scrollContainer?.scrollTo?.({ top: 0 });
454
- }
455
-
456
- function setPageSize(pageSize: number) {
457
- // External mode: changing page size resets to the first page.
458
- if (emitExternalPagination(0, pageSize)) return;
459
- ctx.grid.setPagination((prev: any) => {
460
- const oldSize = prev?.pageSize ?? 10;
461
- const oldIndex = prev?.pageIndex ?? 0;
462
- // Keep the first visible row in view when the page size changes.
463
- const firstVisibleRow = oldIndex * oldSize;
464
- return {
465
- ...prev,
466
- pageSize,
467
- pageIndex: Math.max(0, Math.floor(firstVisibleRow / pageSize)),
468
- };
469
- });
470
- }
471
-
472
- // ---- Right-click context menu --------------------------------------
473
- type CtxTarget = { rowIndex: number; colIndex: number; columnId: string; rowId: string; row: TData | null };
474
- type ResolvedItem = { key: string; label: string; separator?: boolean; disabled?: boolean; run?: () => void };
475
-
476
- function insertRowAt(t: CtxTarget, offset: number) {
477
- const data = ctx.internalData.slice() as TData[];
478
- const idx = t.row ? data.indexOf(t.row) : -1;
479
- const at = idx < 0 ? data.length : idx + offset;
480
- data.splice(at, 0, {} as TData);
481
- ctx.internalData = data;
482
- }
483
- function removeRowAt(t: CtxTarget) {
484
- if (!t.row) return;
485
- ctx.internalData = (ctx.internalData as TData[]).filter((r) => r !== t.row);
486
- }
487
- function removeColAt(t: CtxTarget) {
488
- ctx.internalColumns = ctx.internalColumns.filter(
489
- (d: any) => (d.id ?? d.field) !== t.columnId,
490
- );
491
- }
492
-
493
- // Built-in items, keyed. `run` reads the live target passed at click time.
494
- const builtins: Record<string, { label: string; run: (t: CtxTarget) => void }> = {
495
- copy: { label: "Copy", run: () => ctx.copySelectionToClipboard() },
496
- cut: { label: "Cut", run: () => ctx.cutSelectionToClipboard() },
497
- paste: { label: "Paste", run: () => void ctx.pasteFromClipboard() },
498
- clear: { label: "Clear", run: () => ctx.clearSelectedCells() },
499
- row_above: { label: "Insert row above", run: (t) => insertRowAt(t, 0) },
500
- row_below: { label: "Insert row below", run: (t) => insertRowAt(t, 1) },
501
- remove_row: { label: "Remove row", run: removeRowAt },
502
- remove_col: { label: "Remove column", run: removeColAt },
503
- comment: { label: "Edit comment", run: (t) => openCommentEditor(t) },
504
- };
505
- const DEFAULT_ITEMS = [
506
- "copy", "cut", "paste", "clear", "separator",
507
- "row_above", "row_below", "remove_row", "separator", "remove_col",
508
- ];
509
-
510
- function openContextMenu(
511
- event: MouseEvent,
512
- rowIndex: number,
513
- colIndex: number,
514
- columnId: string,
515
- ) {
516
- if (!ctx.props.contextMenu) return;
517
- event.preventDefault();
518
- closeMenus();
519
- ctx.contextMenuFor = null;
520
- const rowModel = ctx.allRows[rowIndex];
521
- const row = rowModel?.original ?? null;
522
- const rowId = rowModel?.id ?? String(rowIndex);
523
- // Reserve ~280px for the menu body. If the click is in the bottom third,
524
- // flip the menu above the cursor so it stays fully in the viewport.
525
- const menuHeight = 280;
526
- const y = event.clientY + menuHeight > window.innerHeight
527
- ? Math.max(8, event.clientY - menuHeight)
528
- : event.clientY;
529
- ctx.contextMenuPos = {
530
- x: clampMenuX(event.clientX, 220),
531
- y,
532
- };
533
- ctx.contextMenuFor = { rowIndex, colIndex, columnId, rowId, row };
534
- }
535
-
536
- function closeContextMenu() {
537
- ctx.contextMenuFor = null;
538
- }
539
-
540
- // ---- Editable comments ---------------------------------------------
541
- function openCommentEditor(t: CtxTarget) {
542
- const cur =
543
- ctx.noteOverrides?.[t.rowId]?.[t.columnId] ??
544
- ctx.props.notes?.[t.rowId]?.[t.columnId] ??
545
- "";
546
- ctx.commentDraft = cur;
547
- ctx.commentEditFor = { rowId: t.rowId, columnId: t.columnId, x: ctx.contextMenuPos.x, y: ctx.contextMenuPos.y };
548
- ctx.contextMenuFor = null;
549
- }
550
- function writeNote(rowId: string, columnId: string, note: string) {
551
- const next = { ...ctx.noteOverrides };
552
- next[rowId] = { ...(next[rowId] ?? {}), [columnId]: note };
553
- ctx.noteOverrides = next;
554
- ctx.props.onNoteChange?.({ rowId, columnId, note });
555
- }
556
- function saveComment() {
557
- const e = ctx.commentEditFor;
558
- if (!e) return;
559
- writeNote(e.rowId, e.columnId, ctx.commentDraft);
560
- ctx.commentEditFor = null;
561
- }
562
- function removeComment() {
563
- const e = ctx.commentEditFor;
564
- if (!e) return;
565
- writeNote(e.rowId, e.columnId, "");
566
- ctx.commentEditFor = null;
567
- }
568
- function closeCommentEditor() {
569
- ctx.commentEditFor = null;
570
- }
571
-
572
- /** Resolve the configured items against the current target for rendering. */
573
- function contextMenuItems(): ResolvedItem[] {
574
- const target = ctx.contextMenuFor as CtxTarget | null;
575
- if (!target) return [];
576
- const cfg = ctx.props.contextMenu;
577
- const entries: any[] = Array.isArray(cfg)
578
- ? cfg
579
- : [...DEFAULT_ITEMS, ...(ctx.props.editableComments ? ["separator", "comment"] : [])];
580
- const out: ResolvedItem[] = [];
581
- for (const entry of entries) {
582
- if (entry === "separator") { out.push({ key: "sep" + out.length, label: "", separator: true }); continue; }
583
- if (typeof entry === "string") {
584
- const b = builtins[entry];
585
- if (!b) continue;
586
- out.push({ key: entry, label: b.label, run: () => b.run(target) });
587
- continue;
588
- }
589
- if (entry.hidden?.(target)) continue;
590
- out.push({
591
- key: entry.key,
592
- label: entry.label,
593
- disabled: entry.disabled?.(target) ?? false,
594
- run: () => entry.action(target),
595
- });
596
- }
597
- // Drop leading/trailing/double separators.
598
- return out.filter((it, i, a) =>
599
- !it.separator || (i > 0 && i < a.length - 1 && !a[i - 1]?.separator),
600
- );
601
- }
602
-
603
- return {
604
- updateFilterRow,
605
- updateFilterOperator,
606
- updateFilterMenuValue,
607
- updateFilterMenuValueTo,
608
- addFilterToken,
609
- removeFilterToken,
610
- toggleFilterToken,
611
- toggleCheckboxWithKeyboard,
612
- isColumnFiltered,
613
- closeMenus,
614
- openInSuggest,
615
- closeInSuggest,
616
- openChooseColumns,
617
- openColumnMenu,
618
- openFilterMenu,
619
- openOperatorMenu,
620
- sortColumnFromMenu,
621
- clearColumnSort,
622
- groupByColumnFromMenu,
623
- clearGroupingFromMenu,
624
- isFacetChecked,
625
- toggleFacetValue,
626
- isAllFacetsChecked,
627
- toggleAllFacets,
628
- clearColumnFilter,
629
- changePage,
630
- goToPage,
631
- setPageSize,
632
- openContextMenu,
633
- closeContextMenu,
634
- contextMenuItems,
635
- saveComment,
636
- removeComment,
637
- closeCommentEditor,
638
- };
639
- }
1
+ // menus handlers extracted from the controller. Imperative event handlers
2
+ // reading/writing controller state via the `ctx` handle; the reactive core
3
+ // ($state/$derived/$effect) stays in the controller.
4
+ import {
5
+ applyExcelFilter,
6
+ normalizeForFilter,
7
+ createColumnVirtualizer,
8
+ createCoreRowModel,
9
+ createExpandedRowModel,
10
+ createFilteredRowModel,
11
+ createGroupedRowModel,
12
+ createPaginatedRowModel,
13
+ createSvelteVirtualizer,
14
+ createSortedRowModel,
15
+ createSvGrid,
16
+ filterFns,
17
+ getGridCellA11yProps,
18
+ getGridCellDomId,
19
+ getGridHeaderA11yProps,
20
+ getGridRootA11yProps,
21
+ getGridRowA11yProps,
22
+ parseEditorValue,
23
+ normalizeEditorOptions,
24
+ sortFns,
25
+ tableFeatures,
26
+ rowSortingFeature,
27
+ columnFilteringFeature,
28
+ columnGroupingFeature,
29
+ type CellContext,
30
+ type EditorContext,
31
+ type CellEditorOption,
32
+ type CellEditorType,
33
+ type CellFormatter,
34
+ type CellFormatConfig,
35
+ type Column,
36
+ type ColumnDef,
37
+ type Row,
38
+ type RowData,
39
+ type SvGridApi,
40
+ type TableFeatures,
41
+ } from "./index";
42
+ import "./sv-grid-scrollbar";
43
+ import { untrack } from "svelte";
44
+ import type { Snippet } from "svelte";
45
+ import { getKeyboardIntent, getNextActiveCell } from "./keyboard";
46
+ import {
47
+ formatNumericWithConfig,
48
+ getDateFormatter,
49
+ resolveDatePattern,
50
+ } from "./cell-formatting";
51
+ import {
52
+ RenderSnippetConfig,
53
+ RenderComponentConfig,
54
+ } from "./render-component";
55
+ import { buildFillPattern } from "./fill-patterns";
56
+ import { buildSparkline, toSparklineValues } from "./sparkline";
57
+ import {
58
+ resolveCellFormat,
59
+ computeColumnStat,
60
+ formatsNeedingStats,
61
+ type ColumnStat,
62
+ type ResolvedCellFormat,
63
+ } from "./conditional-formatting";
64
+ import SvGridDropdown from "./SvGridDropdown.svelte";
65
+ import type {
66
+ Props,
67
+ SelectionPoint,
68
+ SelectionRange,
69
+ CellEditState,
70
+ FilterOperator,
71
+ FilterOption,
72
+ MenuPosition,
73
+ } from "./SvGrid.types";
74
+ import {
75
+ cfTextStyle,
76
+ fmtStat,
77
+ getCellKey,
78
+ resolveClassList,
79
+ toDateInputValue,
80
+ toDateTimeLocalInputValue,
81
+ getEditableInputValue,
82
+ getEditorInputType,
83
+ toValueArray,
84
+ getOptionLabel,
85
+ getOptionColor,
86
+ colorfulChipStyle,
87
+ getEditorClass,
88
+ asDate,
89
+ clampMenuX,
90
+ cssEscape,
91
+ rawToNumber,
92
+ formatFacetNumber,
93
+ formatFacetDate,
94
+ } from "./SvGrid.helpers";
95
+ import { createCellRender } from "./cell-render";
96
+ import { createEditing } from "./editing";
97
+ import { createSelection } from "./selection";
98
+ import { createColumns } from "./columns";
99
+ import { createGridApi } from "./build-api";
100
+ import { createClipboard } from "./clipboard";
101
+ import {
102
+ filterOperatorOptions,
103
+ fallbackOperatorOption,
104
+ TEXT_OPERATORS,
105
+ NUMBER_OPERATORS,
106
+ DATE_OPERATORS,
107
+ CHECKBOX_OPERATORS,
108
+ operatorOption,
109
+ operatorsForColumn,
110
+ defaultOperatorFor,
111
+ operatorLabelFor,
112
+ } from "./filter-operators";
113
+ import {
114
+ type FacetBucket,
115
+ isBucketableColumn,
116
+ buildBuckets,
117
+ isInBucket,
118
+ } from "./facet-buckets";
119
+ import { splitInTokens, joinInTokens } from "./filtering/excel-filters";
120
+ import {
121
+ getColumnBaseValue,
122
+ isGroupRow,
123
+ toolPanelHeaderLabel,
124
+ formatSummaryNumeric,
125
+ getColumnAlign,
126
+ getPinnedCellValue,
127
+ getColumnAccessorValue,
128
+ columnDefMatchesId,
129
+ } from "./cell-values";
130
+
131
+ export function createMenus<
132
+ TFeatures extends TableFeatures = TableFeatures,
133
+ TData extends RowData = RowData,
134
+ >(ctx: any) {
135
+ function updateFilterRow(columnId: string, value: string) {
136
+ ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
137
+ const current = ctx.filterMenuValues[columnId] ?? {
138
+ operator: "contains" as const,
139
+ value: "",
140
+ };
141
+ ctx.filterMenuValues = {
142
+ ...ctx.filterMenuValues,
143
+ [columnId]: { ...current, value },
144
+ };
145
+ }
146
+
147
+ function updateFilterOperator(columnId: string, operator: FilterOperator) {
148
+ const current = ctx.filterMenuValues[columnId] ?? {
149
+ operator: "contains" as const,
150
+ value: "",
151
+ };
152
+ ctx.filterMenuValues = {
153
+ ...ctx.filterMenuValues,
154
+ [columnId]: { ...current, operator },
155
+ };
156
+ }
157
+
158
+ function updateFilterMenuValue(columnId: string, value: string) {
159
+ const current = ctx.filterMenuValues[columnId] ?? {
160
+ operator: "contains" as const,
161
+ value: "",
162
+ };
163
+ ctx.filterMenuValues = {
164
+ ...ctx.filterMenuValues,
165
+ [columnId]: { ...current, value },
166
+ };
167
+ ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
168
+ }
169
+
170
+ /** Upper-bound input for the `between` operator. Only relevant when
171
+ * the column's current operator is `between`; harmless to call
172
+ * otherwise. */
173
+ function updateFilterMenuValueTo(columnId: string, valueTo: string) {
174
+ const current = ctx.filterMenuValues[columnId] ?? {
175
+ operator: "between" as const,
176
+ value: "",
177
+ };
178
+ ctx.filterMenuValues = {
179
+ ...ctx.filterMenuValues,
180
+ [columnId]: { ...current, valueTo },
181
+ };
182
+ }
183
+
184
+ /** Current `in` / `notIn` token list for a column (from the filter-row value). */
185
+ function filterTokens(columnId: string): string[] {
186
+ return splitInTokens(ctx.filterRowValues[columnId] ?? "");
187
+ }
188
+
189
+ /** Add a value to a column's `in` / `notIn` list (no-op if already present). */
190
+ function addFilterToken(columnId: string, token: string) {
191
+ const t = token.trim();
192
+ if (!t) return;
193
+ const tokens = filterTokens(columnId);
194
+ if (!tokens.includes(t)) tokens.push(t);
195
+ updateFilterRow(columnId, joinInTokens(tokens));
196
+ }
197
+
198
+ /** Remove a value from a column's `in` / `notIn` list. */
199
+ function removeFilterToken(columnId: string, token: string) {
200
+ updateFilterRow(
201
+ columnId,
202
+ joinInTokens(filterTokens(columnId).filter((t) => t !== token)),
203
+ );
204
+ }
205
+
206
+ /** Toggle a value in a column's `in` / `notIn` list (checklist behaviour). */
207
+ function toggleFilterToken(columnId: string, token: string) {
208
+ if (filterTokens(columnId).includes(token)) removeFilterToken(columnId, token);
209
+ else addFilterToken(columnId, token);
210
+ }
211
+
212
+ function toggleCheckboxWithKeyboard(
213
+ event: KeyboardEvent,
214
+ toggle: () => void,
215
+ ) {
216
+ if (event.key !== "Enter" && event.key !== " ") return;
217
+ event.preventDefault();
218
+ toggle();
219
+ }
220
+
221
+ function isColumnFiltered(columnId: string) {
222
+ if (ctx.valueFilters[columnId]) return true;
223
+ const menuFilter = ctx.filterMenuValues[columnId];
224
+ return Boolean(
225
+ menuFilter &&
226
+ (menuFilter.operator === "isBlank" ||
227
+ menuFilter.operator === "isNotBlank" ||
228
+ menuFilter.value.trim()),
229
+ );
230
+ }
231
+
232
+ function closeMenus() {
233
+ ctx.columnMenuFor = null;
234
+ ctx.filterMenuFor = null;
235
+ ctx.operatorMenuFor = null;
236
+ ctx.inSuggestFor = null;
237
+ ctx.chooseColumnsPos = null;
238
+ }
239
+
240
+ /** Open the `in` / `notIn` value-suggestions dropdown under a chip input. */
241
+ function openInSuggest(anchor: HTMLElement, columnId: string) {
242
+ const rect = anchor.getBoundingClientRect();
243
+ ctx.inSuggestPos = { x: clampMenuX(rect.left, 220), y: rect.bottom + 4 };
244
+ ctx.inSuggestQuery = "";
245
+ ctx.inSuggestFor = columnId;
246
+ }
247
+
248
+ function closeInSuggest() {
249
+ ctx.inSuggestFor = null;
250
+ ctx.inSuggestQuery = "";
251
+ }
252
+
253
+ function openChooseColumns(event: MouseEvent) {
254
+ event.stopPropagation();
255
+ // Submenu behavior: keep the parent operations menu open and float the
256
+ // Choose Columns panel out to the right of it (AG-Grid style). Falls
257
+ // back to below the item if the popover would clip the viewport.
258
+ const trigger = event.currentTarget as HTMLElement;
259
+ const menuEl = trigger.closest(".sv-grid-menu") as HTMLElement | null;
260
+ const anchor = (menuEl ?? trigger).getBoundingClientRect();
261
+ const panelWidth = 240;
262
+ const wantRight = anchor.right + 4;
263
+ const x =
264
+ wantRight + panelWidth + 8 > window.innerWidth
265
+ ? clampMenuX(anchor.left - panelWidth - 4, panelWidth)
266
+ : clampMenuX(wantRight, panelWidth);
267
+ ctx.chooseColumnsPos = { x, y: anchor.top };
268
+ }
269
+
270
+ function openColumnMenu(event: MouseEvent, columnId: string) {
271
+ event.stopPropagation();
272
+ const wasOpen = ctx.columnMenuFor === columnId;
273
+ closeMenus();
274
+ if (wasOpen) return;
275
+ const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
276
+ ctx.columnMenuPos = {
277
+ x: clampMenuX(rect.right - 240, 240),
278
+ y: rect.bottom + 4,
279
+ };
280
+ ctx.columnMenuTab = "general";
281
+ ctx.columnMenuFor = columnId;
282
+ }
283
+
284
+ function openFilterMenu(event: MouseEvent, columnId: string) {
285
+ event.stopPropagation();
286
+ const wasOpen = ctx.filterMenuFor === columnId;
287
+ closeMenus();
288
+ if (wasOpen) return;
289
+
290
+ // If the consumer is running in row-mode (or any mode where the
291
+ // funnel popover wouldn't render), redirect the click to the
292
+ // inline filter input for this column. Without this the funnel
293
+ // would be a dead button - it visibly clicks but nothing happens
294
+ // because the menu is gated behind `showColumnFiltersEffective`.
295
+ if (!ctx.showColumnFiltersEffective && ctx.showFilterRowEffective) {
296
+ // Find the row-mode filter input and focus it. The input is
297
+ // tagged with `data-svgrid-filter-col` so we can target by id
298
+ // without depending on column position.
299
+ const input = (ctx.scrollContainer as HTMLElement | null)?.querySelector<HTMLInputElement>(
300
+ `[data-svgrid-filter-col="${cssEscape(columnId)}"]`,
301
+ );
302
+ if (input) {
303
+ input.focus();
304
+ input.select();
305
+ // Brief pulse so the user sees where focus landed.
306
+ input.classList.add("sv-grid-filter-value-pulse");
307
+ setTimeout(() => input.classList.remove("sv-grid-filter-value-pulse"), 700);
308
+ }
309
+ return;
310
+ }
311
+
312
+ const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
313
+ ctx.filterMenuPos = {
314
+ x: clampMenuX(rect.right - 260, 260),
315
+ y: rect.bottom + 4,
316
+ };
317
+ ctx.columnMenuSearch = "";
318
+ ctx.filterMenuFor = columnId;
319
+ }
320
+
321
+ function openOperatorMenu(event: MouseEvent, columnId: string) {
322
+ event.stopPropagation();
323
+ const wasOpen = ctx.operatorMenuFor === columnId;
324
+ closeMenus();
325
+ if (wasOpen) return;
326
+ const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
327
+ ctx.operatorMenuPos = { x: clampMenuX(rect.left, 184), y: rect.bottom + 4 };
328
+ ctx.operatorMenuFor = columnId;
329
+ }
330
+
331
+ function sortColumnFromMenu(columnId: string, desc: boolean) {
332
+ ctx.grid.store.setState((prev: any) => ({
333
+ ...prev,
334
+ sorting: [{ id: columnId, desc }],
335
+ }));
336
+ closeMenus();
337
+ }
338
+
339
+ function clearColumnSort(columnId: string) {
340
+ ctx.grid.store.setState((prev: any) => ({
341
+ ...prev,
342
+ sorting: (prev.sorting ?? []).filter(
343
+ (entry: { id: string }) => entry.id !== columnId,
344
+ ),
345
+ }));
346
+ closeMenus();
347
+ }
348
+
349
+ function groupByColumnFromMenu(columnId: string) {
350
+ const current = ctx.grid.getState().grouping ?? [];
351
+ if (current.includes(columnId)) {
352
+ closeMenus();
353
+ return;
354
+ }
355
+ ctx.grid.setGrouping([...current, columnId]);
356
+ closeMenus();
357
+ }
358
+
359
+ function clearGroupingFromMenu(columnId: string) {
360
+ const current = ctx.grid.getState().grouping ?? [];
361
+ ctx.grid.setGrouping(current.filter((id: string) => id !== columnId));
362
+ closeMenus();
363
+ }
364
+
365
+ function isFacetChecked(columnId: string, value: string) {
366
+ const selected = ctx.valueFilters[columnId];
367
+ return selected ? selected.has(value) : true;
368
+ }
369
+
370
+ function toggleFacetValue(columnId: string, value: string) {
371
+ const allValues = ctx.columnMenuFacetValues;
372
+ const next = new Set(ctx.valueFilters[columnId] ?? allValues);
373
+ if (next.has(value)) next.delete(value);
374
+ else next.add(value);
375
+ if (next.size === allValues.length) {
376
+ const copy = { ...ctx.valueFilters };
377
+ delete copy[columnId];
378
+ ctx.valueFilters = copy;
379
+ } else {
380
+ ctx.valueFilters = { ...ctx.valueFilters, [columnId]: next };
381
+ }
382
+ }
383
+
384
+ function isAllFacetsChecked(columnId: string) {
385
+ const selected = ctx.valueFilters[columnId];
386
+ return !selected || selected.size >= ctx.columnMenuFacetValues.length;
387
+ }
388
+
389
+ function toggleAllFacets(columnId: string) {
390
+ if (isAllFacetsChecked(columnId)) {
391
+ ctx.valueFilters = { ...ctx.valueFilters, [columnId]: new Set<string>() };
392
+ } else {
393
+ const copy = { ...ctx.valueFilters };
394
+ delete copy[columnId];
395
+ ctx.valueFilters = copy;
396
+ }
397
+ }
398
+
399
+ function clearColumnFilter(columnId: string) {
400
+ // `untrack`: read-modify-write on the filter maps. Keeps the method safe to
401
+ // call from a consumer's reactive `$effect` (e.g. via `api.clearFilter`)
402
+ // without capturing these reads as a dependency and looping. See
403
+ // `build-api`'s `setFilter` for the full rationale.
404
+ untrack(() => {
405
+ if (ctx.valueFilters[columnId]) {
406
+ const next = { ...ctx.valueFilters };
407
+ delete next[columnId];
408
+ ctx.valueFilters = next;
409
+ }
410
+ if (ctx.filterMenuValues[columnId]) {
411
+ const next = { ...ctx.filterMenuValues };
412
+ delete next[columnId];
413
+ ctx.filterMenuValues = next;
414
+ }
415
+ if (ctx.filterRowValues[columnId]) {
416
+ const next = { ...ctx.filterRowValues };
417
+ delete next[columnId];
418
+ ctx.filterRowValues = next;
419
+ }
420
+ });
421
+ }
422
+
423
+ // External pagination is controlled: emit the requested page/size and let
424
+ // the consumer fetch + update props. Never mutate local pagination state.
425
+ function emitExternalPagination(pageIndex: number, pageSize: number): boolean {
426
+ if (ctx.props.externalPagination !== true) return false;
427
+ ctx.props.onPaginationChange?.({ pageIndex: Math.max(0, pageIndex), pageSize });
428
+ ctx.scrollContainer?.scrollTo?.({ top: 0 });
429
+ return true;
430
+ }
431
+
432
+ function changePage(delta: number) {
433
+ if (
434
+ emitExternalPagination(
435
+ (ctx.props.pageIndex ?? 0) + delta,
436
+ ctx.props.pageSize ?? 10,
437
+ )
438
+ )
439
+ return;
440
+ ctx.grid.setPagination((prev: any) => ({
441
+ ...prev,
442
+ pageIndex: Math.max((prev?.pageIndex ?? 0) + delta, 0),
443
+ }));
444
+ ctx.scrollContainer?.scrollTo?.({ top: 0 });
445
+ }
446
+
447
+ function goToPage(pageIndex: number) {
448
+ if (emitExternalPagination(pageIndex, ctx.props.pageSize ?? 10)) return;
449
+ ctx.grid.setPagination((prev: any) => ({
450
+ ...prev,
451
+ pageIndex: Math.max(0, pageIndex),
452
+ }));
453
+ ctx.scrollContainer?.scrollTo?.({ top: 0 });
454
+ }
455
+
456
+ function setPageSize(pageSize: number) {
457
+ // External mode: changing page size resets to the first page.
458
+ if (emitExternalPagination(0, pageSize)) return;
459
+ ctx.grid.setPagination((prev: any) => {
460
+ const oldSize = prev?.pageSize ?? 10;
461
+ const oldIndex = prev?.pageIndex ?? 0;
462
+ // Keep the first visible row in view when the page size changes.
463
+ const firstVisibleRow = oldIndex * oldSize;
464
+ return {
465
+ ...prev,
466
+ pageSize,
467
+ pageIndex: Math.max(0, Math.floor(firstVisibleRow / pageSize)),
468
+ };
469
+ });
470
+ }
471
+
472
+ // ---- Right-click context menu --------------------------------------
473
+ type CtxTarget = { rowIndex: number; colIndex: number; columnId: string; rowId: string; row: TData | null };
474
+ type ResolvedItem = { key: string; label: string; separator?: boolean; disabled?: boolean; run?: () => void };
475
+
476
+ function insertRowAt(t: CtxTarget, offset: number) {
477
+ const data = ctx.internalData.slice() as TData[];
478
+ const idx = t.row ? data.indexOf(t.row) : -1;
479
+ const at = idx < 0 ? data.length : idx + offset;
480
+ data.splice(at, 0, {} as TData);
481
+ ctx.internalData = data;
482
+ }
483
+ function removeRowAt(t: CtxTarget) {
484
+ if (!t.row) return;
485
+ ctx.internalData = (ctx.internalData as TData[]).filter((r) => r !== t.row);
486
+ }
487
+ function removeColAt(t: CtxTarget) {
488
+ ctx.internalColumns = ctx.internalColumns.filter(
489
+ (d: any) => (d.id ?? d.field) !== t.columnId,
490
+ );
491
+ }
492
+
493
+ // Built-in items, keyed. `run` reads the live target passed at click time.
494
+ const builtins: Record<string, { label: string; run: (t: CtxTarget) => void }> = {
495
+ copy: { label: "Copy", run: () => ctx.copySelectionToClipboard() },
496
+ cut: { label: "Cut", run: () => ctx.cutSelectionToClipboard() },
497
+ paste: { label: "Paste", run: () => void ctx.pasteFromClipboard() },
498
+ clear: { label: "Clear", run: () => ctx.clearSelectedCells() },
499
+ row_above: { label: "Insert row above", run: (t) => insertRowAt(t, 0) },
500
+ row_below: { label: "Insert row below", run: (t) => insertRowAt(t, 1) },
501
+ remove_row: { label: "Remove row", run: removeRowAt },
502
+ remove_col: { label: "Remove column", run: removeColAt },
503
+ comment: { label: "Edit comment", run: (t) => openCommentEditor(t) },
504
+ };
505
+ const DEFAULT_ITEMS = [
506
+ "copy", "cut", "paste", "clear", "separator",
507
+ "row_above", "row_below", "remove_row", "separator", "remove_col",
508
+ ];
509
+
510
+ function openContextMenu(
511
+ event: MouseEvent,
512
+ rowIndex: number,
513
+ colIndex: number,
514
+ columnId: string,
515
+ ) {
516
+ if (!ctx.props.contextMenu) return;
517
+ event.preventDefault();
518
+ closeMenus();
519
+ ctx.contextMenuFor = null;
520
+ const rowModel = ctx.allRows[rowIndex];
521
+ const row = rowModel?.original ?? null;
522
+ const rowId = rowModel?.id ?? String(rowIndex);
523
+ // Reserve ~280px for the menu body. If the click is in the bottom third,
524
+ // flip the menu above the cursor so it stays fully in the viewport.
525
+ const menuHeight = 280;
526
+ const y = event.clientY + menuHeight > window.innerHeight
527
+ ? Math.max(8, event.clientY - menuHeight)
528
+ : event.clientY;
529
+ ctx.contextMenuPos = {
530
+ x: clampMenuX(event.clientX, 220),
531
+ y,
532
+ };
533
+ ctx.contextMenuFor = { rowIndex, colIndex, columnId, rowId, row };
534
+ }
535
+
536
+ function closeContextMenu() {
537
+ ctx.contextMenuFor = null;
538
+ }
539
+
540
+ // ---- Editable comments ---------------------------------------------
541
+ function openCommentEditor(t: CtxTarget) {
542
+ const cur =
543
+ ctx.noteOverrides?.[t.rowId]?.[t.columnId] ??
544
+ ctx.props.notes?.[t.rowId]?.[t.columnId] ??
545
+ "";
546
+ ctx.commentDraft = cur;
547
+ ctx.commentEditFor = { rowId: t.rowId, columnId: t.columnId, x: ctx.contextMenuPos.x, y: ctx.contextMenuPos.y };
548
+ ctx.contextMenuFor = null;
549
+ }
550
+ function writeNote(rowId: string, columnId: string, note: string) {
551
+ const next = { ...ctx.noteOverrides };
552
+ next[rowId] = { ...(next[rowId] ?? {}), [columnId]: note };
553
+ ctx.noteOverrides = next;
554
+ ctx.props.onNoteChange?.({ rowId, columnId, note });
555
+ }
556
+ function saveComment() {
557
+ const e = ctx.commentEditFor;
558
+ if (!e) return;
559
+ writeNote(e.rowId, e.columnId, ctx.commentDraft);
560
+ ctx.commentEditFor = null;
561
+ }
562
+ function removeComment() {
563
+ const e = ctx.commentEditFor;
564
+ if (!e) return;
565
+ writeNote(e.rowId, e.columnId, "");
566
+ ctx.commentEditFor = null;
567
+ }
568
+ function closeCommentEditor() {
569
+ ctx.commentEditFor = null;
570
+ }
571
+
572
+ /** Resolve the configured items against the current target for rendering. */
573
+ function contextMenuItems(): ResolvedItem[] {
574
+ const target = ctx.contextMenuFor as CtxTarget | null;
575
+ if (!target) return [];
576
+ const cfg = ctx.props.contextMenu;
577
+ const entries: any[] = Array.isArray(cfg)
578
+ ? cfg
579
+ : [...DEFAULT_ITEMS, ...(ctx.props.editableComments ? ["separator", "comment"] : [])];
580
+ const out: ResolvedItem[] = [];
581
+ for (const entry of entries) {
582
+ if (entry === "separator") { out.push({ key: "sep" + out.length, label: "", separator: true }); continue; }
583
+ if (typeof entry === "string") {
584
+ const b = builtins[entry];
585
+ if (!b) continue;
586
+ out.push({ key: entry, label: b.label, run: () => b.run(target) });
587
+ continue;
588
+ }
589
+ if (entry.hidden?.(target)) continue;
590
+ out.push({
591
+ key: entry.key,
592
+ label: entry.label,
593
+ disabled: entry.disabled?.(target) ?? false,
594
+ run: () => entry.action(target),
595
+ });
596
+ }
597
+ // Drop leading/trailing/double separators.
598
+ return out.filter((it, i, a) =>
599
+ !it.separator || (i > 0 && i < a.length - 1 && !a[i - 1]?.separator),
600
+ );
601
+ }
602
+
603
+ return {
604
+ updateFilterRow,
605
+ updateFilterOperator,
606
+ updateFilterMenuValue,
607
+ updateFilterMenuValueTo,
608
+ addFilterToken,
609
+ removeFilterToken,
610
+ toggleFilterToken,
611
+ toggleCheckboxWithKeyboard,
612
+ isColumnFiltered,
613
+ closeMenus,
614
+ openInSuggest,
615
+ closeInSuggest,
616
+ openChooseColumns,
617
+ openColumnMenu,
618
+ openFilterMenu,
619
+ openOperatorMenu,
620
+ sortColumnFromMenu,
621
+ clearColumnSort,
622
+ groupByColumnFromMenu,
623
+ clearGroupingFromMenu,
624
+ isFacetChecked,
625
+ toggleFacetValue,
626
+ isAllFacetsChecked,
627
+ toggleAllFacets,
628
+ clearColumnFilter,
629
+ changePage,
630
+ goToPage,
631
+ setPageSize,
632
+ openContextMenu,
633
+ closeContextMenu,
634
+ contextMenuItems,
635
+ saveComment,
636
+ removeComment,
637
+ closeCommentEditor,
638
+ };
639
+ }