@svgrid/grid 2.0.0 → 2.0.2

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 (61) hide show
  1. package/dist/FlexRender.svelte +96 -96
  2. package/dist/GridFooter.svelte +178 -178
  3. package/dist/SvGrid.css +2376 -2376
  4. package/dist/SvGrid.svelte +2764 -2764
  5. package/dist/SvGridDropdown.svelte +666 -666
  6. package/dist/cdn/svgrid.js +1 -1
  7. package/dist/cdn/svgrid.svelte-external.js +1 -1
  8. package/package.json +85 -85
  9. package/src/FlexRender.svelte +96 -96
  10. package/src/GridFooter.svelte +178 -178
  11. package/src/SvGrid.controller.svelte.ts +2553 -2553
  12. package/src/SvGrid.css +2376 -2376
  13. package/src/SvGrid.svelte +2764 -2764
  14. package/src/SvGrid.types.ts +944 -944
  15. package/src/SvGridDropdown.svelte +666 -666
  16. package/src/a11y.contract.test.ts +49 -49
  17. package/src/a11y.test.ts +59 -59
  18. package/src/a11y.ts +61 -61
  19. package/src/build-api.ts +798 -798
  20. package/src/cell-formatting.ts +169 -169
  21. package/src/cell-render.ts +469 -469
  22. package/src/collaboration.test.ts +104 -104
  23. package/src/collaboration.ts +167 -167
  24. package/src/core.performance.test.ts +30 -30
  25. package/src/core.ts +1111 -1111
  26. package/src/createGrid.svelte.ts +42 -42
  27. package/src/createGrid.test.ts +10 -10
  28. package/src/createGridState.svelte.ts +17 -17
  29. package/src/editing.test.ts +859 -859
  30. package/src/editing.ts +675 -675
  31. package/src/export-data-api.test.ts +126 -126
  32. package/src/export-format.test.ts +107 -107
  33. package/src/export-format.ts +598 -598
  34. package/src/flex-render.ts +3 -3
  35. package/src/index.ts +463 -463
  36. package/src/keyboard.test.ts +59 -59
  37. package/src/keyboard.ts +97 -97
  38. package/src/menus.ts +582 -582
  39. package/src/merge-objects.ts +48 -48
  40. package/src/render-component.ts +28 -28
  41. package/src/selection.test.ts +754 -754
  42. package/src/selection.ts +600 -600
  43. package/src/server-data-source.test.ts +289 -289
  44. package/src/server-data-source.ts +413 -413
  45. package/src/sparkline.test.ts +68 -68
  46. package/src/sparkline.ts +169 -169
  47. package/src/spreadsheet.test.ts +489 -489
  48. package/src/spreadsheet.ts +304 -304
  49. package/src/static-functions.ts +11 -11
  50. package/src/subscribe.ts +38 -38
  51. package/src/svgrid-wrapper.types.ts +439 -439
  52. package/src/svgrid.behavior.test.ts +706 -706
  53. package/src/svgrid.features.test.ts +157 -157
  54. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  55. package/src/svgrid.wrapper.test.ts +40 -40
  56. package/src/virtualization/column-virtualizer.test.ts +27 -27
  57. package/src/virtualization/column-virtualizer.ts +30 -30
  58. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  59. package/src/virtualization/types.ts +30 -30
  60. package/src/virtualization/virtualizer.test.ts +47 -47
  61. package/src/virtualization/virtualizer.ts +296 -296
@@ -1,469 +1,469 @@
1
- // cell-render 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 type { Snippet } from "svelte";
44
- import { getKeyboardIntent, getNextActiveCell } from "./keyboard";
45
- import {
46
- formatNumericWithConfig,
47
- getDateFormatter,
48
- resolveDatePattern,
49
- } from "./cell-formatting";
50
- import {
51
- RenderSnippetConfig,
52
- RenderComponentConfig,
53
- } from "./render-component";
54
- import { buildFillPattern } from "./fill-patterns";
55
- import { buildSparkline, toSparklineValues } from "./sparkline";
56
- import {
57
- resolveCellFormat,
58
- computeColumnStat,
59
- formatsNeedingStats,
60
- type ColumnStat,
61
- type ResolvedCellFormat,
62
- } from "./conditional-formatting";
63
- import SvGridDropdown from "./SvGridDropdown.svelte";
64
- import type {
65
- Props,
66
- SelectionPoint,
67
- SelectionRange,
68
- CellEditState,
69
- FilterOperator,
70
- FilterOption,
71
- MenuPosition,
72
- } from "./SvGrid.types";
73
- import {
74
- cfTextStyle,
75
- fmtStat,
76
- getCellKey,
77
- resolveClassList,
78
- toDateInputValue,
79
- toDateTimeLocalInputValue,
80
- getEditableInputValue,
81
- getEditorInputType,
82
- toValueArray,
83
- getOptionLabel,
84
- getOptionColor,
85
- colorfulChipStyle,
86
- getEditorClass,
87
- asDate,
88
- clampMenuX,
89
- cssEscape,
90
- rawToNumber,
91
- formatFacetNumber,
92
- formatFacetDate,
93
- } from "./SvGrid.helpers";
94
- import { createEditing } from "./editing";
95
- import { createSelection } from "./selection";
96
- import { createColumns } from "./columns";
97
- import { createGridApi } from "./build-api";
98
- import { createClipboard } from "./clipboard";
99
- import {
100
- filterOperatorOptions,
101
- fallbackOperatorOption,
102
- TEXT_OPERATORS,
103
- NUMBER_OPERATORS,
104
- DATE_OPERATORS,
105
- CHECKBOX_OPERATORS,
106
- operatorOption,
107
- operatorsForColumn,
108
- defaultOperatorFor,
109
- operatorLabelFor,
110
- } from "./filter-operators";
111
- import {
112
- type FacetBucket,
113
- isBucketableColumn,
114
- buildBuckets,
115
- isInBucket,
116
- } from "./facet-buckets";
117
- import {
118
- getColumnBaseValue,
119
- isGroupRow,
120
- toolPanelHeaderLabel,
121
- formatSummaryNumeric,
122
- getColumnAlign,
123
- getPinnedCellValue,
124
- getColumnAccessorValue,
125
- columnDefMatchesId,
126
- } from "./cell-values";
127
-
128
- export function createCellRender<
129
- TFeatures extends TableFeatures = TableFeatures,
130
- TData extends RowData = RowData,
131
- >(ctx: any) {
132
- function cellConditionalFormat(
133
- row: Row<TData>,
134
- column: Column<TData>,
135
- value: unknown,
136
- ): ResolvedCellFormat | null {
137
- const formats = ctx.props.conditionalFormats;
138
- if (!formats?.length) return null;
139
- return resolveCellFormat(
140
- value,
141
- row.original,
142
- column.id,
143
- formats,
144
- ctx.conditionalColumnStats.get(column.id) ?? null,
145
- );
146
- }
147
-
148
- /** Compute the consumer-supplied row class for one rendered row. */
149
- function computeRowClass(row: Row<TData>, rowIndex: number): string {
150
- if (!ctx.props.rowClass) return "";
151
- return resolveClassList(
152
- ctx.props.rowClass({ row: row.original as TData, rowIndex }),
153
- );
154
- }
155
-
156
- /** Compute the consumer-supplied cell class for one rendered cell. */
157
- function computeCellClass(row: Row<TData>, column: Column<TData>): string {
158
- const raw = column.columnDef.cellClass;
159
- if (raw == null) return "";
160
- if (typeof raw === "string" || Array.isArray(raw)) {
161
- return resolveClassList(raw);
162
- }
163
- if (typeof raw === "function") {
164
- // Build a minimal CellContext - the only fields the wrapper-side
165
- // cellClass author needs are `row` and `column`. Callers can read
166
- // `ctx.row.original` and `ctx.column.id` exactly like in a `cell`
167
- // renderer. The other fields are stubbed for compatibility.
168
- const cellCtx = {
169
- row,
170
- column,
171
- cell: undefined as any,
172
- table: undefined as any,
173
- getValue: () => row.getCellValueByColumnId(column.id),
174
- };
175
- return resolveClassList(raw(cellCtx as any));
176
- }
177
- return "";
178
- }
179
-
180
- /**
181
- * Resolve the per-cell tooltip. Column-level `tooltip` field can be a
182
- * plain string (rendered as `title=`) or a `(ctx) => string` callback
183
- * for value-dependent text. Returning empty / nullish means no
184
- * tooltip - the renderer omits the `title=` attribute entirely.
185
- */
186
- function computeCellTooltip(row: Row<TData>, column: Column<TData>): string | null {
187
- const raw = column.columnDef.tooltip
188
- if (raw == null) return null
189
- if (typeof raw === "string") return raw || null
190
- if (typeof raw === "function") {
191
- const ctx = {
192
- row,
193
- column,
194
- cell: undefined as any,
195
- table: undefined as any,
196
- getValue: () => row.getCellValueByColumnId(column.id),
197
- }
198
- const out = (raw as any)(ctx)
199
- return out ? String(out) : null
200
- }
201
- return null
202
- }
203
-
204
- /**
205
- * Resolve per-cell validity via the column's declarative `validate` hook.
206
- * Runs for every rendered cell so pre-existing bad data is flagged on load.
207
- * Returns `{ invalid, message }` - `invalid` drives the red highlight class,
208
- * `message` (when present) becomes the cell's tooltip.
209
- */
210
- function computeCellValidity(
211
- row: Row<TData>,
212
- column: Column<TData>,
213
- ): { invalid: boolean; message: string | null } {
214
- const rule = column.columnDef.validate as
215
- | ((params: {
216
- value: unknown
217
- row: TData
218
- rowIndex: number
219
- column: Column<TData>
220
- }) => string | boolean | null | undefined)
221
- | undefined
222
- if (typeof rule !== "function") return { invalid: false, message: null }
223
- // Read the edit-aware value: inline edits land in `editedCellValues`
224
- // (keyed rowId:colId) and are NOT written into the row's memoized value
225
- // cache, so `getCellValueByColumnId` would return the stale pre-edit value
226
- // and validation would never re-run after an edit. Consult the overlay
227
- // first - same rule the display path (getCellDisplayValue) and summaries
228
- // use - so a cell re-validates live as the user types.
229
- const edited = ctx.editedCellValues ?? {}
230
- const key = getCellKey(row.id, column.id)
231
- const value =
232
- key in edited ? edited[key] : row.getCellValueByColumnId(column.id)
233
- const out = rule({
234
- value,
235
- row: row.original as TData,
236
- rowIndex: row.index,
237
- column,
238
- })
239
- // Valid: null / undefined / true. Invalid: false or a message string.
240
- if (out == null || out === true) return { invalid: false, message: null }
241
- if (out === false) return { invalid: true, message: null }
242
- const msg = String(out)
243
- return { invalid: true, message: msg.trim() ? msg : null }
244
- }
245
-
246
- /**
247
- * Resolve a per-cell note (a longer comment / annotation). Notes
248
- * come from the grid's `notes` prop - a `{ [rowId]: { [columnId]: string } }`
249
- * map - so the consumer keeps note storage. Returning non-empty
250
- * paints a corner indicator AND becomes the cell's tooltip text.
251
- */
252
- function computeCellNote(row: Row<TData>, column: Column<TData>): string | null {
253
- // Internal overlay (from the comment editor) wins over props.notes so
254
- // edits show immediately even when `notes` is controlled. An empty
255
- // overlay entry means "removed".
256
- const ov = ctx.noteOverrides?.[row.id]?.[column.id]
257
- if (ov !== undefined) return ov.trim() ? ov : null
258
- const map = ctx.props.notes
259
- if (!map) return null
260
- const byCol = map[row.id]
261
- if (!byCol) return null
262
- const v = byCol[column.id]
263
- return v && v.trim() ? v : null
264
- }
265
-
266
- function getColumnEditorOptions(
267
- column: Column<TData>,
268
- row?: Row<TData> | null,
269
- ): CellEditorOption[] {
270
- const def = column.columnDef.editorOptions;
271
- if (typeof def === "function") {
272
- // Dynamic per-row: must be re-evaluated because the row's other
273
- // cells may have just changed (cascade).
274
- if (!row?.original) return [];
275
- return normalizeEditorOptions(def(row.original as TData));
276
- }
277
- const id = column.id;
278
- if (
279
- !ctx.editorOptionsCache[id] ||
280
- ctx.editorOptionsCache[id + "__src"] !== (def as unknown as object)
281
- ) {
282
- ctx.editorOptionsCache[id] = normalizeEditorOptions(def);
283
- (ctx.editorOptionsCache as Record<string, unknown>)[id + "__src"] = def;
284
- }
285
- return ctx.editorOptionsCache[id];
286
- }
287
-
288
- /** Joined display string for list/chips cells. */
289
- function formatListCellValue(
290
- column: Column<TData>,
291
- value: unknown,
292
- row?: Row<TData> | null,
293
- ): string {
294
- const options = getColumnEditorOptions(column, row);
295
- const sep = column.columnDef.editorSeparator ?? ", ";
296
- if (Array.isArray(value)) {
297
- return value.map((v) => getOptionLabel(options, v)).join(sep);
298
- }
299
- if (value == null || value === "") return "";
300
- return getOptionLabel(options, value);
301
- }
302
-
303
- function formatCellValue(
304
- column: Column<TData>,
305
- value: unknown,
306
- row: Row<TData>,
307
- ) {
308
- const formatter = column.columnDef.formatter as
309
- | CellFormatter<TData>
310
- | undefined;
311
- if (typeof formatter === "function") {
312
- const formatted = formatter({ value, row, column, table: ctx.grid });
313
- return String(formatted ?? "");
314
- }
315
-
316
- // Password columns: mask the stored value with bullets when the cell
317
- // is in read-only mode. The editor still receives the real string.
318
- if (column.columnDef.editorType === "password") {
319
- const s = String(value ?? "");
320
- return s.length > 0 ? "•".repeat(Math.min(s.length, 12)) : "";
321
- }
322
-
323
- const formatConfig = column.columnDef.format as
324
- | CellFormatConfig
325
- | undefined;
326
- if (!formatConfig) return String(value ?? "");
327
-
328
- if (
329
- formatConfig.type === "number" ||
330
- formatConfig.type === "currency" ||
331
- formatConfig.type === "percent"
332
- ) {
333
- return formatNumericWithConfig(value, {
334
- type: formatConfig.type,
335
- locales: formatConfig.locales,
336
- currency:
337
- formatConfig.type === "currency"
338
- ? (formatConfig.currency ?? "USD")
339
- : undefined,
340
- valueIsPercentPoints:
341
- formatConfig.type === "percent"
342
- ? formatConfig.valueIsPercentPoints
343
- : undefined,
344
- options: formatConfig.options,
345
- });
346
- }
347
-
348
- if (formatConfig.type === "date" || formatConfig.type === "datetime") {
349
- const parsedDate = asDate(value);
350
- if (parsedDate) {
351
- const preset = resolveDatePattern(
352
- formatConfig.pattern,
353
- formatConfig.type,
354
- );
355
- const merged: Intl.DateTimeFormatOptions =
356
- preset || formatConfig.options
357
- ? { ...preset, ...formatConfig.options }
358
- : formatConfig.type === "date"
359
- ? { year: "numeric", month: "2-digit", day: "2-digit" }
360
- : {
361
- year: "numeric",
362
- month: "2-digit",
363
- day: "2-digit",
364
- hour: "2-digit",
365
- minute: "2-digit",
366
- };
367
-
368
- return getDateFormatter(formatConfig.locales, merged).format(
369
- parsedDate,
370
- );
371
- }
372
- }
373
-
374
- return String(value ?? "");
375
- }
376
-
377
- /**
378
- * Format a cell value for a PINNED row. Same surface as
379
- * `formatCellValue` but doesn't depend on Row<TData>. Custom
380
- * `formatter` callbacks are invoked with a `row` of `null` (their
381
- * type allows it; most don't read it).
382
- */
383
- function formatPinnedValue(
384
- column: Column<TData>,
385
- value: unknown,
386
- ): string {
387
- const def = column.columnDef;
388
- const formatter = def.formatter as
389
- | ((ctx: { value: unknown; row: null; column: Column<TData>; table: unknown }) => unknown)
390
- | undefined;
391
- if (typeof formatter === "function") {
392
- return String(
393
- formatter({ value, row: null, column, table: ctx.grid }) ?? "",
394
- );
395
- }
396
- if (def.editorType === "password") {
397
- const s = String(value ?? "");
398
- return s.length > 0 ? "•".repeat(Math.min(s.length, 12)) : "";
399
- }
400
- const formatConfig = def.format as CellFormatConfig | undefined;
401
- if (!formatConfig) return String(value ?? "");
402
- if (
403
- formatConfig.type === "number" ||
404
- formatConfig.type === "currency" ||
405
- formatConfig.type === "percent"
406
- ) {
407
- return formatNumericWithConfig(value, {
408
- type: formatConfig.type,
409
- locales: formatConfig.locales,
410
- currency:
411
- formatConfig.type === "currency"
412
- ? (formatConfig.currency ?? "USD")
413
- : undefined,
414
- valueIsPercentPoints:
415
- formatConfig.type === "percent"
416
- ? formatConfig.valueIsPercentPoints
417
- : undefined,
418
- options: formatConfig.options,
419
- });
420
- }
421
- if (formatConfig.type === "date" || formatConfig.type === "datetime") {
422
- const parsedDate = asDate(value);
423
- if (parsedDate) {
424
- const preset = resolveDatePattern(formatConfig.pattern, formatConfig.type);
425
- const merged: Intl.DateTimeFormatOptions =
426
- preset || formatConfig.options
427
- ? { ...preset, ...formatConfig.options }
428
- : formatConfig.type === "date"
429
- ? { year: "numeric", month: "2-digit", day: "2-digit" }
430
- : { year: "numeric", month: "2-digit", day: "2-digit", hour: "2-digit", minute: "2-digit" };
431
- return getDateFormatter(formatConfig.locales, merged).format(parsedDate);
432
- }
433
- }
434
- return String(value ?? "");
435
- }
436
-
437
- /**
438
- * Resolve `cellClass` for a pinned row. We synthesise a minimal
439
- * context `{ getValue, value, row: null, column }`; cell-class
440
- * callbacks that read only the value (the common case) work
441
- * unchanged.
442
- */
443
- function computePinnedCellClass(
444
- rowData: TData,
445
- column: Column<TData>,
446
- ): string {
447
- const cellClass = column.columnDef.cellClass as
448
- | ((ctx: { getValue: () => unknown; value: unknown; row: null; column: Column<TData> }) => string | undefined | null)
449
- | undefined;
450
- if (typeof cellClass !== "function") return "";
451
- const value = getPinnedCellValue(rowData, column);
452
- const out = cellClass({ getValue: () => value, value, row: null, column });
453
- return out ? String(out) : "";
454
- }
455
-
456
- return {
457
- cellConditionalFormat,
458
- computeRowClass,
459
- computeCellClass,
460
- computeCellTooltip,
461
- computeCellValidity,
462
- computeCellNote,
463
- getColumnEditorOptions,
464
- formatListCellValue,
465
- formatCellValue,
466
- formatPinnedValue,
467
- computePinnedCellClass,
468
- };
469
- }
1
+ // cell-render 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 type { Snippet } from "svelte";
44
+ import { getKeyboardIntent, getNextActiveCell } from "./keyboard";
45
+ import {
46
+ formatNumericWithConfig,
47
+ getDateFormatter,
48
+ resolveDatePattern,
49
+ } from "./cell-formatting";
50
+ import {
51
+ RenderSnippetConfig,
52
+ RenderComponentConfig,
53
+ } from "./render-component";
54
+ import { buildFillPattern } from "./fill-patterns";
55
+ import { buildSparkline, toSparklineValues } from "./sparkline";
56
+ import {
57
+ resolveCellFormat,
58
+ computeColumnStat,
59
+ formatsNeedingStats,
60
+ type ColumnStat,
61
+ type ResolvedCellFormat,
62
+ } from "./conditional-formatting";
63
+ import SvGridDropdown from "./SvGridDropdown.svelte";
64
+ import type {
65
+ Props,
66
+ SelectionPoint,
67
+ SelectionRange,
68
+ CellEditState,
69
+ FilterOperator,
70
+ FilterOption,
71
+ MenuPosition,
72
+ } from "./SvGrid.types";
73
+ import {
74
+ cfTextStyle,
75
+ fmtStat,
76
+ getCellKey,
77
+ resolveClassList,
78
+ toDateInputValue,
79
+ toDateTimeLocalInputValue,
80
+ getEditableInputValue,
81
+ getEditorInputType,
82
+ toValueArray,
83
+ getOptionLabel,
84
+ getOptionColor,
85
+ colorfulChipStyle,
86
+ getEditorClass,
87
+ asDate,
88
+ clampMenuX,
89
+ cssEscape,
90
+ rawToNumber,
91
+ formatFacetNumber,
92
+ formatFacetDate,
93
+ } from "./SvGrid.helpers";
94
+ import { createEditing } from "./editing";
95
+ import { createSelection } from "./selection";
96
+ import { createColumns } from "./columns";
97
+ import { createGridApi } from "./build-api";
98
+ import { createClipboard } from "./clipboard";
99
+ import {
100
+ filterOperatorOptions,
101
+ fallbackOperatorOption,
102
+ TEXT_OPERATORS,
103
+ NUMBER_OPERATORS,
104
+ DATE_OPERATORS,
105
+ CHECKBOX_OPERATORS,
106
+ operatorOption,
107
+ operatorsForColumn,
108
+ defaultOperatorFor,
109
+ operatorLabelFor,
110
+ } from "./filter-operators";
111
+ import {
112
+ type FacetBucket,
113
+ isBucketableColumn,
114
+ buildBuckets,
115
+ isInBucket,
116
+ } from "./facet-buckets";
117
+ import {
118
+ getColumnBaseValue,
119
+ isGroupRow,
120
+ toolPanelHeaderLabel,
121
+ formatSummaryNumeric,
122
+ getColumnAlign,
123
+ getPinnedCellValue,
124
+ getColumnAccessorValue,
125
+ columnDefMatchesId,
126
+ } from "./cell-values";
127
+
128
+ export function createCellRender<
129
+ TFeatures extends TableFeatures = TableFeatures,
130
+ TData extends RowData = RowData,
131
+ >(ctx: any) {
132
+ function cellConditionalFormat(
133
+ row: Row<TData>,
134
+ column: Column<TData>,
135
+ value: unknown,
136
+ ): ResolvedCellFormat | null {
137
+ const formats = ctx.props.conditionalFormats;
138
+ if (!formats?.length) return null;
139
+ return resolveCellFormat(
140
+ value,
141
+ row.original,
142
+ column.id,
143
+ formats,
144
+ ctx.conditionalColumnStats.get(column.id) ?? null,
145
+ );
146
+ }
147
+
148
+ /** Compute the consumer-supplied row class for one rendered row. */
149
+ function computeRowClass(row: Row<TData>, rowIndex: number): string {
150
+ if (!ctx.props.rowClass) return "";
151
+ return resolveClassList(
152
+ ctx.props.rowClass({ row: row.original as TData, rowIndex }),
153
+ );
154
+ }
155
+
156
+ /** Compute the consumer-supplied cell class for one rendered cell. */
157
+ function computeCellClass(row: Row<TData>, column: Column<TData>): string {
158
+ const raw = column.columnDef.cellClass;
159
+ if (raw == null) return "";
160
+ if (typeof raw === "string" || Array.isArray(raw)) {
161
+ return resolveClassList(raw);
162
+ }
163
+ if (typeof raw === "function") {
164
+ // Build a minimal CellContext - the only fields the wrapper-side
165
+ // cellClass author needs are `row` and `column`. Callers can read
166
+ // `ctx.row.original` and `ctx.column.id` exactly like in a `cell`
167
+ // renderer. The other fields are stubbed for compatibility.
168
+ const cellCtx = {
169
+ row,
170
+ column,
171
+ cell: undefined as any,
172
+ table: undefined as any,
173
+ getValue: () => row.getCellValueByColumnId(column.id),
174
+ };
175
+ return resolveClassList(raw(cellCtx as any));
176
+ }
177
+ return "";
178
+ }
179
+
180
+ /**
181
+ * Resolve the per-cell tooltip. Column-level `tooltip` field can be a
182
+ * plain string (rendered as `title=`) or a `(ctx) => string` callback
183
+ * for value-dependent text. Returning empty / nullish means no
184
+ * tooltip - the renderer omits the `title=` attribute entirely.
185
+ */
186
+ function computeCellTooltip(row: Row<TData>, column: Column<TData>): string | null {
187
+ const raw = column.columnDef.tooltip
188
+ if (raw == null) return null
189
+ if (typeof raw === "string") return raw || null
190
+ if (typeof raw === "function") {
191
+ const ctx = {
192
+ row,
193
+ column,
194
+ cell: undefined as any,
195
+ table: undefined as any,
196
+ getValue: () => row.getCellValueByColumnId(column.id),
197
+ }
198
+ const out = (raw as any)(ctx)
199
+ return out ? String(out) : null
200
+ }
201
+ return null
202
+ }
203
+
204
+ /**
205
+ * Resolve per-cell validity via the column's declarative `validate` hook.
206
+ * Runs for every rendered cell so pre-existing bad data is flagged on load.
207
+ * Returns `{ invalid, message }` - `invalid` drives the red highlight class,
208
+ * `message` (when present) becomes the cell's tooltip.
209
+ */
210
+ function computeCellValidity(
211
+ row: Row<TData>,
212
+ column: Column<TData>,
213
+ ): { invalid: boolean; message: string | null } {
214
+ const rule = column.columnDef.validate as
215
+ | ((params: {
216
+ value: unknown
217
+ row: TData
218
+ rowIndex: number
219
+ column: Column<TData>
220
+ }) => string | boolean | null | undefined)
221
+ | undefined
222
+ if (typeof rule !== "function") return { invalid: false, message: null }
223
+ // Read the edit-aware value: inline edits land in `editedCellValues`
224
+ // (keyed rowId:colId) and are NOT written into the row's memoized value
225
+ // cache, so `getCellValueByColumnId` would return the stale pre-edit value
226
+ // and validation would never re-run after an edit. Consult the overlay
227
+ // first - same rule the display path (getCellDisplayValue) and summaries
228
+ // use - so a cell re-validates live as the user types.
229
+ const edited = ctx.editedCellValues ?? {}
230
+ const key = getCellKey(row.id, column.id)
231
+ const value =
232
+ key in edited ? edited[key] : row.getCellValueByColumnId(column.id)
233
+ const out = rule({
234
+ value,
235
+ row: row.original as TData,
236
+ rowIndex: row.index,
237
+ column,
238
+ })
239
+ // Valid: null / undefined / true. Invalid: false or a message string.
240
+ if (out == null || out === true) return { invalid: false, message: null }
241
+ if (out === false) return { invalid: true, message: null }
242
+ const msg = String(out)
243
+ return { invalid: true, message: msg.trim() ? msg : null }
244
+ }
245
+
246
+ /**
247
+ * Resolve a per-cell note (a longer comment / annotation). Notes
248
+ * come from the grid's `notes` prop - a `{ [rowId]: { [columnId]: string } }`
249
+ * map - so the consumer keeps note storage. Returning non-empty
250
+ * paints a corner indicator AND becomes the cell's tooltip text.
251
+ */
252
+ function computeCellNote(row: Row<TData>, column: Column<TData>): string | null {
253
+ // Internal overlay (from the comment editor) wins over props.notes so
254
+ // edits show immediately even when `notes` is controlled. An empty
255
+ // overlay entry means "removed".
256
+ const ov = ctx.noteOverrides?.[row.id]?.[column.id]
257
+ if (ov !== undefined) return ov.trim() ? ov : null
258
+ const map = ctx.props.notes
259
+ if (!map) return null
260
+ const byCol = map[row.id]
261
+ if (!byCol) return null
262
+ const v = byCol[column.id]
263
+ return v && v.trim() ? v : null
264
+ }
265
+
266
+ function getColumnEditorOptions(
267
+ column: Column<TData>,
268
+ row?: Row<TData> | null,
269
+ ): CellEditorOption[] {
270
+ const def = column.columnDef.editorOptions;
271
+ if (typeof def === "function") {
272
+ // Dynamic per-row: must be re-evaluated because the row's other
273
+ // cells may have just changed (cascade).
274
+ if (!row?.original) return [];
275
+ return normalizeEditorOptions(def(row.original as TData));
276
+ }
277
+ const id = column.id;
278
+ if (
279
+ !ctx.editorOptionsCache[id] ||
280
+ ctx.editorOptionsCache[id + "__src"] !== (def as unknown as object)
281
+ ) {
282
+ ctx.editorOptionsCache[id] = normalizeEditorOptions(def);
283
+ (ctx.editorOptionsCache as Record<string, unknown>)[id + "__src"] = def;
284
+ }
285
+ return ctx.editorOptionsCache[id];
286
+ }
287
+
288
+ /** Joined display string for list/chips cells. */
289
+ function formatListCellValue(
290
+ column: Column<TData>,
291
+ value: unknown,
292
+ row?: Row<TData> | null,
293
+ ): string {
294
+ const options = getColumnEditorOptions(column, row);
295
+ const sep = column.columnDef.editorSeparator ?? ", ";
296
+ if (Array.isArray(value)) {
297
+ return value.map((v) => getOptionLabel(options, v)).join(sep);
298
+ }
299
+ if (value == null || value === "") return "";
300
+ return getOptionLabel(options, value);
301
+ }
302
+
303
+ function formatCellValue(
304
+ column: Column<TData>,
305
+ value: unknown,
306
+ row: Row<TData>,
307
+ ) {
308
+ const formatter = column.columnDef.formatter as
309
+ | CellFormatter<TData>
310
+ | undefined;
311
+ if (typeof formatter === "function") {
312
+ const formatted = formatter({ value, row, column, table: ctx.grid });
313
+ return String(formatted ?? "");
314
+ }
315
+
316
+ // Password columns: mask the stored value with bullets when the cell
317
+ // is in read-only mode. The editor still receives the real string.
318
+ if (column.columnDef.editorType === "password") {
319
+ const s = String(value ?? "");
320
+ return s.length > 0 ? "•".repeat(Math.min(s.length, 12)) : "";
321
+ }
322
+
323
+ const formatConfig = column.columnDef.format as
324
+ | CellFormatConfig
325
+ | undefined;
326
+ if (!formatConfig) return String(value ?? "");
327
+
328
+ if (
329
+ formatConfig.type === "number" ||
330
+ formatConfig.type === "currency" ||
331
+ formatConfig.type === "percent"
332
+ ) {
333
+ return formatNumericWithConfig(value, {
334
+ type: formatConfig.type,
335
+ locales: formatConfig.locales,
336
+ currency:
337
+ formatConfig.type === "currency"
338
+ ? (formatConfig.currency ?? "USD")
339
+ : undefined,
340
+ valueIsPercentPoints:
341
+ formatConfig.type === "percent"
342
+ ? formatConfig.valueIsPercentPoints
343
+ : undefined,
344
+ options: formatConfig.options,
345
+ });
346
+ }
347
+
348
+ if (formatConfig.type === "date" || formatConfig.type === "datetime") {
349
+ const parsedDate = asDate(value);
350
+ if (parsedDate) {
351
+ const preset = resolveDatePattern(
352
+ formatConfig.pattern,
353
+ formatConfig.type,
354
+ );
355
+ const merged: Intl.DateTimeFormatOptions =
356
+ preset || formatConfig.options
357
+ ? { ...preset, ...formatConfig.options }
358
+ : formatConfig.type === "date"
359
+ ? { year: "numeric", month: "2-digit", day: "2-digit" }
360
+ : {
361
+ year: "numeric",
362
+ month: "2-digit",
363
+ day: "2-digit",
364
+ hour: "2-digit",
365
+ minute: "2-digit",
366
+ };
367
+
368
+ return getDateFormatter(formatConfig.locales, merged).format(
369
+ parsedDate,
370
+ );
371
+ }
372
+ }
373
+
374
+ return String(value ?? "");
375
+ }
376
+
377
+ /**
378
+ * Format a cell value for a PINNED row. Same surface as
379
+ * `formatCellValue` but doesn't depend on Row<TData>. Custom
380
+ * `formatter` callbacks are invoked with a `row` of `null` (their
381
+ * type allows it; most don't read it).
382
+ */
383
+ function formatPinnedValue(
384
+ column: Column<TData>,
385
+ value: unknown,
386
+ ): string {
387
+ const def = column.columnDef;
388
+ const formatter = def.formatter as
389
+ | ((ctx: { value: unknown; row: null; column: Column<TData>; table: unknown }) => unknown)
390
+ | undefined;
391
+ if (typeof formatter === "function") {
392
+ return String(
393
+ formatter({ value, row: null, column, table: ctx.grid }) ?? "",
394
+ );
395
+ }
396
+ if (def.editorType === "password") {
397
+ const s = String(value ?? "");
398
+ return s.length > 0 ? "•".repeat(Math.min(s.length, 12)) : "";
399
+ }
400
+ const formatConfig = def.format as CellFormatConfig | undefined;
401
+ if (!formatConfig) return String(value ?? "");
402
+ if (
403
+ formatConfig.type === "number" ||
404
+ formatConfig.type === "currency" ||
405
+ formatConfig.type === "percent"
406
+ ) {
407
+ return formatNumericWithConfig(value, {
408
+ type: formatConfig.type,
409
+ locales: formatConfig.locales,
410
+ currency:
411
+ formatConfig.type === "currency"
412
+ ? (formatConfig.currency ?? "USD")
413
+ : undefined,
414
+ valueIsPercentPoints:
415
+ formatConfig.type === "percent"
416
+ ? formatConfig.valueIsPercentPoints
417
+ : undefined,
418
+ options: formatConfig.options,
419
+ });
420
+ }
421
+ if (formatConfig.type === "date" || formatConfig.type === "datetime") {
422
+ const parsedDate = asDate(value);
423
+ if (parsedDate) {
424
+ const preset = resolveDatePattern(formatConfig.pattern, formatConfig.type);
425
+ const merged: Intl.DateTimeFormatOptions =
426
+ preset || formatConfig.options
427
+ ? { ...preset, ...formatConfig.options }
428
+ : formatConfig.type === "date"
429
+ ? { year: "numeric", month: "2-digit", day: "2-digit" }
430
+ : { year: "numeric", month: "2-digit", day: "2-digit", hour: "2-digit", minute: "2-digit" };
431
+ return getDateFormatter(formatConfig.locales, merged).format(parsedDate);
432
+ }
433
+ }
434
+ return String(value ?? "");
435
+ }
436
+
437
+ /**
438
+ * Resolve `cellClass` for a pinned row. We synthesise a minimal
439
+ * context `{ getValue, value, row: null, column }`; cell-class
440
+ * callbacks that read only the value (the common case) work
441
+ * unchanged.
442
+ */
443
+ function computePinnedCellClass(
444
+ rowData: TData,
445
+ column: Column<TData>,
446
+ ): string {
447
+ const cellClass = column.columnDef.cellClass as
448
+ | ((ctx: { getValue: () => unknown; value: unknown; row: null; column: Column<TData> }) => string | undefined | null)
449
+ | undefined;
450
+ if (typeof cellClass !== "function") return "";
451
+ const value = getPinnedCellValue(rowData, column);
452
+ const out = cellClass({ getValue: () => value, value, row: null, column });
453
+ return out ? String(out) : "";
454
+ }
455
+
456
+ return {
457
+ cellConditionalFormat,
458
+ computeRowClass,
459
+ computeCellClass,
460
+ computeCellTooltip,
461
+ computeCellValidity,
462
+ computeCellNote,
463
+ getColumnEditorOptions,
464
+ formatListCellValue,
465
+ formatCellValue,
466
+ formatPinnedValue,
467
+ computePinnedCellClass,
468
+ };
469
+ }