@open-grid/primitives 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,931 @@
1
+ import { CellCoordinate, ColumnPinningPosition, ColumnId, Grid, ColumnLayout, Row, FocusDirection, MoveFocusOptions, GridState, Column, ColumnFiltersState } from '@open-grid/core';
2
+
3
+ type PrimitiveProps = Record<string, string | number | boolean | undefined>;
4
+ declare const GRID_DENSITIES: readonly ["compact", "standard", "comfortable"];
5
+ type GridDensity = (typeof GRID_DENSITIES)[number];
6
+ declare const GRID_PREFERENCES_VERSION: 1;
7
+ interface GridPreferencesState {
8
+ columnVisibility: GridState["columnVisibility"];
9
+ columnSizing: GridState["columnSizing"];
10
+ columnOrder: GridState["columnOrder"];
11
+ columnPinning: GridState["columnPinning"];
12
+ }
13
+ interface GridPreferences {
14
+ version: typeof GRID_PREFERENCES_VERSION;
15
+ density: GridDensity;
16
+ state: GridPreferencesState;
17
+ }
18
+ interface GridPreferencesOptions {
19
+ validColumnIds?: readonly string[] | undefined;
20
+ }
21
+ interface GridPreferencesStorageLike {
22
+ getItem: (key: string) => string | null;
23
+ setItem: (key: string, value: string) => void;
24
+ removeItem: (key: string) => void;
25
+ }
26
+ interface GridPreferencesStorageEnvironmentLike {
27
+ localStorage?: GridPreferencesStorageLike | null | undefined;
28
+ }
29
+ interface CellPrimitiveOptions {
30
+ focusedCell?: CellCoordinate | null;
31
+ editing?: boolean;
32
+ rangeSelected?: boolean;
33
+ rowIndexOffset?: number | undefined;
34
+ }
35
+ interface CellEditorPrimitiveOptions {
36
+ invalid?: boolean | undefined;
37
+ }
38
+ interface CellEditorOptionPrimitiveOptions {
39
+ value: string;
40
+ label?: string | undefined;
41
+ disabled?: boolean | undefined;
42
+ }
43
+ interface CellEditorValueTargetLike {
44
+ value?: unknown;
45
+ }
46
+ interface CellEditorValueEventLike<TTarget = unknown> {
47
+ currentTarget?: TTarget | null | undefined;
48
+ target?: TTarget | null | undefined;
49
+ }
50
+ interface CellEditValidationEventLike {
51
+ validation?: {
52
+ valid: boolean;
53
+ message?: string | undefined;
54
+ } | undefined;
55
+ }
56
+ interface CellFillHandleVisibilityOptions {
57
+ activeEditing?: boolean | undefined;
58
+ editing?: boolean | undefined;
59
+ fillHandleCoordinate?: CellCoordinate | null | undefined;
60
+ rangeSelected?: boolean | undefined;
61
+ }
62
+ interface ClipboardTextAreaLike {
63
+ value: string;
64
+ style: {
65
+ position?: string | undefined;
66
+ top?: string | undefined;
67
+ left?: string | undefined;
68
+ };
69
+ select: () => void;
70
+ setAttribute: (name: string, value: string) => void;
71
+ }
72
+ interface ClipboardTextParentLike {
73
+ appendChild: (element: ClipboardTextAreaLike) => void;
74
+ removeChild: (element: ClipboardTextAreaLike) => void;
75
+ }
76
+ interface ClipboardTextDocumentLike {
77
+ body?: ClipboardTextParentLike | null | undefined;
78
+ documentElement: ClipboardTextParentLike;
79
+ createElement: (tagName: "textarea") => ClipboardTextAreaLike;
80
+ execCommand: (command: "copy") => boolean;
81
+ }
82
+ interface ClipboardTextNavigatorLike {
83
+ clipboard?: {
84
+ readText?: () => Promise<string> | string;
85
+ writeText?: (text: string) => Promise<void> | void;
86
+ } | undefined;
87
+ }
88
+ interface ClipboardTextEnvironment {
89
+ document?: ClipboardTextDocumentLike | undefined;
90
+ navigator?: ClipboardTextNavigatorLike | undefined;
91
+ }
92
+ interface BrowserExportFileLike {
93
+ filename: string;
94
+ mimeType: string;
95
+ text: string;
96
+ }
97
+ interface BrowserDownloadAnchorLike {
98
+ href: string;
99
+ download: string;
100
+ style: {
101
+ display?: string | undefined;
102
+ };
103
+ click: () => void;
104
+ }
105
+ interface BrowserDownloadParentLike {
106
+ appendChild: (element: BrowserDownloadAnchorLike) => void;
107
+ removeChild: (element: BrowserDownloadAnchorLike) => void;
108
+ }
109
+ interface BrowserDownloadDocumentLike {
110
+ body?: BrowserDownloadParentLike | null | undefined;
111
+ documentElement: BrowserDownloadParentLike;
112
+ createElement: (tagName: "a") => BrowserDownloadAnchorLike;
113
+ }
114
+ interface BrowserDownloadBlobConstructorLike {
115
+ new (blobParts: readonly string[], options: {
116
+ type: string;
117
+ }): unknown;
118
+ }
119
+ interface BrowserDownloadUrlLike {
120
+ createObjectURL: (blob: unknown) => string;
121
+ revokeObjectURL: (url: string) => void;
122
+ }
123
+ interface BrowserDownloadEnvironment {
124
+ blob?: BrowserDownloadBlobConstructorLike | undefined;
125
+ document?: BrowserDownloadDocumentLike | undefined;
126
+ url?: BrowserDownloadUrlLike | undefined;
127
+ }
128
+ interface FocusableElementLike {
129
+ focus: () => void;
130
+ }
131
+ interface HeaderActionMenuItemFocusTargetLike extends FocusableElementLike {
132
+ }
133
+ interface FocusableSelectableElementLike extends FocusableElementLike {
134
+ select?: (() => void) | undefined;
135
+ }
136
+ interface FocusedCellContainerLike {
137
+ querySelector: (selector: string) => FocusableElementLike | null;
138
+ }
139
+ interface KeyboardTargetEventLike {
140
+ target: EventTarget | null;
141
+ currentTarget: EventTarget | null;
142
+ }
143
+ interface HeaderActionMenuFocusTargetEventLike {
144
+ currentTarget: unknown;
145
+ }
146
+ interface HeaderActionMenuActiveElementDocumentLike {
147
+ activeElement?: unknown;
148
+ }
149
+ interface HeaderActionMenuActiveElementTargetLike {
150
+ ownerDocument?: HeaderActionMenuActiveElementDocumentLike | null | undefined;
151
+ }
152
+ interface HeaderActionMenuFocusTargetLike extends ParentNode {
153
+ focus: () => void;
154
+ }
155
+ interface FocusedCellRestoreOptions {
156
+ focusedCell: CellCoordinate | null | undefined;
157
+ scroller: unknown;
158
+ shouldRestore: boolean;
159
+ inProgress?: boolean | undefined;
160
+ }
161
+ interface FocusedCellRestoreFrameSyncOptions {
162
+ inProgress?: boolean | undefined;
163
+ }
164
+ interface ElementIdLookupLike<TElement extends FocusableElementLike = FocusableElementLike> {
165
+ getElementById: (id: string) => TElement | null;
166
+ }
167
+ interface ScrollPositionElementLike {
168
+ scrollLeft: number;
169
+ scrollTop: number;
170
+ }
171
+ interface ScrollFrameElementLike extends ScrollPositionElementLike {
172
+ clientHeight: number;
173
+ clientWidth: number;
174
+ }
175
+ interface ScrollFrameElementOptions {
176
+ scrollLeft?: number | undefined;
177
+ scrollTop?: number | undefined;
178
+ stickyTopOffset?: number | undefined;
179
+ }
180
+ interface ScrollFrameOptionsLike {
181
+ scrollTop: number;
182
+ scrollLeft: number;
183
+ viewportHeight: number;
184
+ viewportWidth: number;
185
+ stickyTopOffset: number;
186
+ }
187
+ type FocusedCellScrollElementOptions<TData> = Omit<FocusedCellScrollOptions<TData>, "currentScrollLeft" | "currentScrollTop" | "viewportWidth" | "viewportHeight">;
188
+ interface FocusedRowSelectionTarget<TData> {
189
+ row: Row<TData>;
190
+ rowIndex: number;
191
+ }
192
+ interface CellLayoutPrimitiveOptions {
193
+ invalid?: boolean | undefined;
194
+ pinnedEdge?: "left" | "right" | undefined;
195
+ }
196
+ interface RowPrimitiveOptions {
197
+ selected?: boolean;
198
+ rowIndexOffset?: number | undefined;
199
+ }
200
+ interface RowExpansionTogglePrimitiveOptions {
201
+ expanded: boolean;
202
+ label: string;
203
+ }
204
+ interface RowLayoutPrimitiveOptions {
205
+ expanded?: boolean | undefined;
206
+ virtualIndex?: number | undefined;
207
+ columnVirtualized?: boolean | undefined;
208
+ }
209
+ interface ColumnPinningButtonPrimitiveOptions {
210
+ position: ColumnPinningPosition;
211
+ active: boolean;
212
+ }
213
+ interface HeaderActionMenuTriggerPrimitiveOptions {
214
+ expanded: boolean;
215
+ controls: string;
216
+ }
217
+ interface HeaderActionMenuItemPrimitiveOptions {
218
+ disabled?: boolean | undefined;
219
+ }
220
+ interface HeaderActionMenuLabelPrimitiveOptions {
221
+ label?: string | undefined;
222
+ }
223
+ interface HeaderCellLayoutPrimitiveOptions {
224
+ colSpan?: number | undefined;
225
+ rowSpan?: number | undefined;
226
+ grouped?: boolean | undefined;
227
+ placeholder?: boolean | undefined;
228
+ pinnedEdge?: "left" | "right" | undefined;
229
+ draggable?: boolean | undefined;
230
+ }
231
+ interface HeaderCellPrimitiveOptions {
232
+ pinned?: ColumnPinningPosition | undefined;
233
+ }
234
+ interface HeaderButtonPrimitiveOptions {
235
+ disabled?: boolean | undefined;
236
+ placeholder?: boolean | undefined;
237
+ }
238
+ interface HeaderSortIndicatorTextOptions {
239
+ visible?: boolean | undefined;
240
+ }
241
+ interface HeaderKeyboardMoveEventLike {
242
+ key: string;
243
+ altKey?: boolean | undefined;
244
+ shiftKey?: boolean | undefined;
245
+ }
246
+ interface GridKeyboardShortcutEventLike {
247
+ key: string;
248
+ ctrlKey?: boolean | undefined;
249
+ metaKey?: boolean | undefined;
250
+ altKey?: boolean | undefined;
251
+ shiftKey?: boolean | undefined;
252
+ }
253
+ type GridKeyboardShortcutAction = "copy" | "paste" | "undo-edit" | "redo-edit" | "row-selection";
254
+ type GridKeyboardEditAction = "start-edit" | "cancel-edit";
255
+ type CellEditorKeyboardAction = "commit-edit" | "cancel-edit";
256
+ interface GridKeyboardFocusMove {
257
+ direction: FocusDirection;
258
+ options: MoveFocusOptions;
259
+ }
260
+ interface ColumnResizeHandlePrimitiveOptions {
261
+ valueNow?: number | undefined;
262
+ }
263
+ interface ColumnResizeKeyboardEventLike {
264
+ key: string;
265
+ shiftKey?: boolean | undefined;
266
+ }
267
+ interface ColumnResizeKeyboardSizeOptions {
268
+ defaultStep?: number | undefined;
269
+ largeStep?: number | undefined;
270
+ }
271
+ interface ColumnResizePointerEventLike {
272
+ clientX: number;
273
+ }
274
+ interface ColumnResizeFinalSizeEventLike {
275
+ defaultPrevented: boolean;
276
+ size: number;
277
+ }
278
+ interface ColumnResizeDefaultPreventableEventLike {
279
+ defaultPrevented: boolean;
280
+ }
281
+ interface PointerCaptureTargetLike {
282
+ setPointerCapture: (pointerId: number) => void;
283
+ releasePointerCapture: (pointerId: number) => void;
284
+ }
285
+ interface PointerCaptureEventLike {
286
+ currentTarget: unknown;
287
+ }
288
+ type PointerListener = (event: PointerEvent) => void;
289
+ interface PointerMoveUpListeners {
290
+ move: PointerListener;
291
+ up: PointerListener;
292
+ }
293
+ interface PointerMoveUpListenerTargetLike {
294
+ addEventListener: (type: "pointermove" | "pointerup", listener: PointerListener) => void;
295
+ removeEventListener: (type: "pointermove" | "pointerup", listener: PointerListener) => void;
296
+ }
297
+ interface PointerUpCancelListeners {
298
+ up: PointerListener;
299
+ cancel: PointerListener;
300
+ }
301
+ interface PointerUpCancelListenerTargetLike {
302
+ addEventListener: (type: "pointerup" | "pointercancel", listener: PointerListener) => void;
303
+ removeEventListener: (type: "pointerup" | "pointercancel", listener: PointerListener) => void;
304
+ }
305
+ interface PointerMoveUpCancelListeners {
306
+ move: PointerListener;
307
+ up: PointerListener;
308
+ cancel: PointerListener;
309
+ }
310
+ interface PointerMoveUpCancelListenerTargetLike {
311
+ addEventListener: (type: "pointermove" | "pointerup" | "pointercancel", listener: PointerListener) => void;
312
+ removeEventListener: (type: "pointermove" | "pointerup" | "pointercancel", listener: PointerListener) => void;
313
+ }
314
+ type ScrollListener = (event: Event) => void;
315
+ interface ScrollListenerTargetLike {
316
+ addEventListener: (type: "scroll", listener: ScrollListener, options?: AddEventListenerOptions) => void;
317
+ removeEventListener: (type: "scroll", listener: ScrollListener) => void;
318
+ }
319
+ interface GroupingPanelPrimitiveOptions {
320
+ empty?: boolean | undefined;
321
+ }
322
+ interface GroupingPanelMoveButtonPrimitiveOptions {
323
+ direction: "left" | "right";
324
+ disabled?: boolean | undefined;
325
+ }
326
+ interface GroupRowLabelOptions<TFallback = string> {
327
+ fallback?: TFallback | undefined;
328
+ }
329
+ interface GroupCellIndentOptions {
330
+ depthSize?: number | undefined;
331
+ footerOffset?: number | undefined;
332
+ }
333
+ interface GridHeaderRowPrimitiveOptions {
334
+ columnVirtualized?: boolean | undefined;
335
+ rowIndex?: number | undefined;
336
+ }
337
+ interface GridRowCoordinateOptions {
338
+ additionalHeaderRowCount?: number | undefined;
339
+ headerRowCount?: number | undefined;
340
+ ariaLabel?: string | undefined;
341
+ error?: boolean | undefined;
342
+ loading?: boolean | undefined;
343
+ }
344
+ interface ColumnFilterCellPrimitiveOptions {
345
+ columnIndex: number;
346
+ rowIndex: number;
347
+ pinned?: ColumnPinningPosition | undefined;
348
+ pinnedEdge?: "left" | "right" | undefined;
349
+ }
350
+ interface ColumnFilterInputPrimitiveOptions {
351
+ label: string;
352
+ value: unknown;
353
+ }
354
+ interface QuickFilterInputPrimitiveOptions {
355
+ value: string;
356
+ }
357
+ interface RowSelectionCheckboxPrimitiveOptions {
358
+ allSelected?: boolean | undefined;
359
+ someSelected?: boolean | undefined;
360
+ disabled?: boolean | undefined;
361
+ }
362
+ interface ColumnVisibilityCheckboxPrimitiveOptions {
363
+ columnId: ColumnId;
364
+ label: string;
365
+ visible: boolean;
366
+ visibleCount?: number | undefined;
367
+ disabled?: boolean | undefined;
368
+ }
369
+ interface CheckboxIndeterminateTargetLike {
370
+ indeterminate: boolean;
371
+ }
372
+ type PaginationAction = "first" | "previous" | "next" | "last";
373
+ interface PaginationButtonPrimitiveOptions {
374
+ action: PaginationAction;
375
+ disabled?: boolean | undefined;
376
+ }
377
+ declare const DEFAULT_PAGINATION_PAGE_SIZE_OPTIONS: readonly [25, 50, 100];
378
+ interface GridEmptyRowPrimitiveOptions {
379
+ rowIndexOffset?: number | undefined;
380
+ }
381
+ interface GridEmptyCellPrimitiveOptions extends GridEmptyRowPrimitiveOptions {
382
+ columnCount?: number | undefined;
383
+ }
384
+ interface GridBodyPrimitiveOptions {
385
+ virtualized?: boolean | undefined;
386
+ columnOrder?: readonly string[] | undefined;
387
+ }
388
+ interface RowVirtualizationPrimitiveOptions {
389
+ enabled?: boolean | undefined;
390
+ estimateRowHeight?: number | undefined;
391
+ measureRowHeight?: boolean | undefined;
392
+ overscan?: number | undefined;
393
+ }
394
+ interface ResolvedRowVirtualizationOptions {
395
+ enabled: boolean;
396
+ estimateRowHeight: number;
397
+ measureRowHeight: boolean;
398
+ overscan: number;
399
+ }
400
+ interface ColumnVirtualizationPrimitiveOptions {
401
+ enabled?: boolean | undefined;
402
+ measureColumnWidth?: boolean | undefined;
403
+ overscan?: number | undefined;
404
+ }
405
+ interface ResolvedColumnVirtualizationOptions {
406
+ enabled: boolean;
407
+ measureColumnWidth: boolean;
408
+ overscan: number;
409
+ }
410
+ interface FocusedCellScrollOptions<TData> {
411
+ focusedCell: CellCoordinate;
412
+ layout: readonly ColumnLayout[];
413
+ rows: readonly Row<TData>[];
414
+ currentScrollLeft: number;
415
+ currentScrollTop: number;
416
+ viewportWidth: number;
417
+ viewportHeight: number;
418
+ headerHeight: number;
419
+ getRowSize: (index: number) => number;
420
+ rowVirtualOptions: ResolvedRowVirtualizationOptions;
421
+ columnVirtualOptions: ResolvedColumnVirtualizationOptions;
422
+ }
423
+ interface FocusedCellScrollPosition {
424
+ scrollLeft: number;
425
+ scrollTop: number;
426
+ }
427
+ type HeaderActionMenuItemFocusPosition = "first" | "last" | "next" | "previous";
428
+ type HeaderActionMenuKeyboardAction = {
429
+ type: "focus";
430
+ position: HeaderActionMenuItemFocusPosition;
431
+ } | {
432
+ type: "close";
433
+ } | {
434
+ type: "tab-close";
435
+ };
436
+ type HeaderActionMenuDefaultItemId = "sort-asc" | "sort-desc" | "clear-sort" | "move-left" | "move-right" | "pin-left" | "unpin" | "pin-right" | "toggle-group";
437
+ interface HeaderActionMenuDefaultItemLabelOptions {
438
+ grouped?: boolean | undefined;
439
+ }
440
+ interface HeaderActionMenuDefaultItemDescriptor {
441
+ id: HeaderActionMenuDefaultItemId;
442
+ label: string;
443
+ disabled?: boolean;
444
+ }
445
+ interface HeaderActionMenuDefaultItemDescriptorOptions {
446
+ sortDirection: "asc" | "desc" | false;
447
+ pinningPosition: ColumnPinningPosition;
448
+ isGrouped: boolean;
449
+ canGroup: boolean;
450
+ canMoveLeft: boolean;
451
+ canMoveRight: boolean;
452
+ }
453
+ interface HeaderActionMenuPrimitiveItem {
454
+ type?: string | undefined;
455
+ }
456
+ interface HeaderActionMenuPrimitiveCustomItem {
457
+ type: "custom";
458
+ props?: Record<string, unknown> | undefined;
459
+ }
460
+ interface HeaderActionMenuPrimitiveLabelItem {
461
+ type: "label";
462
+ }
463
+ interface HeaderActionMenuPrimitiveSeparatorItem {
464
+ type: "separator";
465
+ }
466
+ interface DefaultPreventableEventLike {
467
+ preventDefault(): void;
468
+ }
469
+ interface RowSelectionToggleEventLike {
470
+ defaultPrevented: boolean;
471
+ }
472
+ interface DefaultPreventedEventLike {
473
+ defaultPrevented: boolean;
474
+ }
475
+ interface DefaultPreventablePropagationEventLike {
476
+ preventDefault(): void;
477
+ stopPropagation(): void;
478
+ }
479
+ interface PropagationEventLike {
480
+ stopPropagation(): void;
481
+ }
482
+ interface PointerClientCoordinateLike {
483
+ clientX: number;
484
+ clientY: number;
485
+ }
486
+ interface PointerButtonEventLike {
487
+ button: number;
488
+ }
489
+ interface PointerButtonsEventLike {
490
+ buttons: number;
491
+ }
492
+ interface PointerIdEventLike {
493
+ pointerId: number;
494
+ }
495
+ interface PointerDragSessionLike {
496
+ pointerId: number;
497
+ }
498
+ interface VirtualRowStyleItemLike {
499
+ start: number;
500
+ size: number;
501
+ }
502
+ interface VirtualBodyStyleRangeLike {
503
+ totalSize: number;
504
+ }
505
+ interface VirtualBodyStyleProps {
506
+ height: number;
507
+ }
508
+ interface InlineSizeStyleProps {
509
+ width: number;
510
+ }
511
+ interface VirtualizedInlineSizeStyleProps {
512
+ width: number;
513
+ minWidth: number;
514
+ }
515
+ interface GroupCellIndentStyleProps {
516
+ paddingLeft: number;
517
+ }
518
+ interface PinnedColumnOffsetStyleLayoutLike {
519
+ pinned: ColumnPinningPosition;
520
+ pinnedStart?: number | undefined;
521
+ }
522
+ type PinnedColumnOffsetStyleProps = {
523
+ position: "sticky";
524
+ left: number;
525
+ } | {
526
+ position: "sticky";
527
+ right: number;
528
+ };
529
+ interface VirtualRowStyleProps {
530
+ position: "absolute";
531
+ top: 0;
532
+ left: 0;
533
+ right: 0;
534
+ height: number;
535
+ transform: string;
536
+ }
537
+ interface ColumnLayoutTotalWidthItemLike {
538
+ end: number;
539
+ }
540
+ interface ColumnIdItemLike {
541
+ id: ColumnId;
542
+ }
543
+ interface RowIdItemLike {
544
+ id: string;
545
+ }
546
+ interface PointerDragStartLike {
547
+ startX: number;
548
+ startY: number;
549
+ }
550
+ interface PointerDragMovementLike extends PointerDragStartLike {
551
+ didDrag?: boolean | undefined;
552
+ }
553
+ interface HeaderDragEndLike {
554
+ sourceColumnId: string;
555
+ targetColumnId: string;
556
+ didDrag?: boolean | undefined;
557
+ }
558
+ interface HeaderDragEndColumnLike {
559
+ id: string;
560
+ getCanGroup(): boolean;
561
+ }
562
+ type HeaderDragEndAction = {
563
+ type: "group";
564
+ columnId: string;
565
+ } | {
566
+ type: "move";
567
+ sourceColumnId: string;
568
+ targetColumnId: string;
569
+ };
570
+ interface HeaderDragEndActionOptions<TColumn extends HeaderDragEndColumnLike> {
571
+ event: PointerClientCoordinateLike;
572
+ groupingPanel: boolean;
573
+ groupingPanelElement?: PointerHitTestElementLike | null | undefined;
574
+ columns: readonly TColumn[];
575
+ }
576
+ interface PointerHitTestElementLike {
577
+ getBoundingClientRect(): {
578
+ left: number;
579
+ right: number;
580
+ top: number;
581
+ bottom: number;
582
+ };
583
+ }
584
+ interface MeasuredBlockElementLike {
585
+ scrollHeight: number;
586
+ }
587
+ interface MeasuredBlockRectElementLike extends MeasuredBlockElementLike {
588
+ getBoundingClientRect(): {
589
+ height: number;
590
+ };
591
+ }
592
+ interface MeasuredInlineElementLike {
593
+ getBoundingClientRect(): {
594
+ width: number;
595
+ };
596
+ }
597
+ type MeasuredBlockRectElementTargetLike = Element & MeasuredBlockRectElementLike;
598
+ type MeasuredInlineDatasetElementTargetLike = Element & MeasuredInlineElementLike & DatasetElementLike;
599
+ interface OffsetBlockElementLike {
600
+ offsetHeight: number;
601
+ }
602
+ interface DatasetElementLike {
603
+ dataset: Record<string, string | undefined>;
604
+ }
605
+ interface ResizeObserverDatasetTargetLike {
606
+ dataset?: Record<string, string | undefined> | undefined;
607
+ }
608
+ interface ResizeObserverDatasetEntryLike {
609
+ target: unknown;
610
+ }
611
+ interface ResizeObserverBlockSizeEntryLike {
612
+ target: unknown;
613
+ borderBoxSize?: ResizeObserverEntry["borderBoxSize"] | undefined;
614
+ contentRect: {
615
+ height: number;
616
+ };
617
+ }
618
+ interface ResizeObserverInlineSizeEntryLike {
619
+ borderBoxSize?: ResizeObserverEntry["borderBoxSize"] | undefined;
620
+ contentRect: {
621
+ width: number;
622
+ };
623
+ }
624
+ type ResizeObserverEntryDatasetKey = "rowId" | "columnId";
625
+ interface ResizeObserverObserveLike {
626
+ observe: (target: Element) => void;
627
+ }
628
+ interface ResizeObserverUnobserveLike {
629
+ unobserve: (target: Element) => void;
630
+ }
631
+ interface ResizeObserverDisconnectLike {
632
+ disconnect: () => void;
633
+ }
634
+ type ResizeObserverConstructorLike = new (callback: ResizeObserverCallback) => ResizeObserver;
635
+ interface ObservedElementMapLike<TElement extends Element> {
636
+ get: (id: string) => TElement | undefined;
637
+ set: (id: string, element: TElement) => unknown;
638
+ delete: (id: string) => unknown;
639
+ }
640
+ interface MeasuredSizeCacheLike {
641
+ set: (key: string, size: number) => boolean;
642
+ }
643
+ declare const HEADER_ACTION_MENU_ENABLED_ITEM_SELECTOR = "[role=\"menuitem\"]:not(:disabled):not([aria-disabled=\"true\"])";
644
+ declare const HEADER_ACTION_MENU_TRIGGER_TEXT = "...";
645
+ declare const GROUPING_PANEL_EMPTY_MESSAGE = "Drag column headers here to group";
646
+ declare const GRID_FOCUSED_CELL_SELECTOR = "[role=\"gridcell\"][data-focused=\"true\"]";
647
+ declare const GRID_INTERACTIVE_KEYBOARD_TARGET_SELECTOR = "button, input, select, textarea, a[href], [contenteditable]:not([contenteditable='false']), [role='button'], [role='menuitem'], [role='separator'], [role='slider'], [role='textbox'], [role='combobox'], [role='searchbox'], [role='spinbutton']";
648
+ declare function getGridProps<TData>(grid: Grid<TData>, options?: GridRowCoordinateOptions): PrimitiveProps;
649
+ declare function getGridHeaderProps(): PrimitiveProps;
650
+ declare function getGridLoadingOverlayProps(): PrimitiveProps;
651
+ declare function getGridLoadingText(): string;
652
+ declare function getGridErrorOverlayProps(): PrimitiveProps;
653
+ declare function getGridErrorText(): string;
654
+ declare function getGridErrorRetryButtonProps(): PrimitiveProps;
655
+ declare function getGridErrorRetryButtonText(): string;
656
+ declare function getGridHeaderRowProps(options?: GridHeaderRowPrimitiveOptions): PrimitiveProps;
657
+ declare function getGridHeaderRowCount<TData>(grid: Grid<TData>, options?: GridRowCoordinateOptions): number;
658
+ declare function getGridBodyRowIndexOffset<TData>(grid: Grid<TData>, options?: GridRowCoordinateOptions): number;
659
+ declare function getColumnFilterCellProps<TData>(column: Column<TData, unknown>, options: ColumnFilterCellPrimitiveOptions): PrimitiveProps;
660
+ declare function getColumnFilterInputProps<TData>(column: Column<TData, unknown>, options: ColumnFilterInputPrimitiveOptions): PrimitiveProps;
661
+ declare function getColumnFilterText(filters: ColumnFiltersState, columnId: ColumnId): string;
662
+ declare function getQuickFilterProps(): PrimitiveProps;
663
+ declare function getQuickFilterInputProps(options: QuickFilterInputPrimitiveOptions): PrimitiveProps;
664
+ declare function getQuickFilterClearButtonProps(value: string): PrimitiveProps;
665
+ declare function getQuickFilterClearButtonText(): string;
666
+ declare function getRowSelectionControlsProps(): PrimitiveProps;
667
+ declare function getRowSelectionCheckboxProps(options?: RowSelectionCheckboxPrimitiveOptions): PrimitiveProps;
668
+ declare function getRowSelectionCheckboxText(): string;
669
+ declare function getRowSelectionStatusProps(): PrimitiveProps;
670
+ declare function getRowSelectionStatusText(selectedCount: number): string;
671
+ declare function getRowSelectionClearButtonProps(disabled?: boolean): PrimitiveProps;
672
+ declare function getRowSelectionClearButtonText(): string;
673
+ declare function setCheckboxIndeterminate(target: unknown, indeterminate: boolean): boolean;
674
+ declare function getColumnVisibilityControlsProps(): PrimitiveProps;
675
+ declare function getColumnVisibilitySummaryProps(visibleCount: number, totalCount: number): PrimitiveProps;
676
+ declare function getColumnVisibilitySummaryText(visibleCount: number, totalCount: number): string;
677
+ declare function getColumnVisibilitySearchInputProps(value: string): PrimitiveProps;
678
+ declare function getColumnVisibilityListProps(): PrimitiveProps;
679
+ declare function getColumnVisibilityCheckboxProps(options: ColumnVisibilityCheckboxPrimitiveOptions): PrimitiveProps;
680
+ declare function getColumnVisibilityStatusProps(): PrimitiveProps;
681
+ declare function getColumnVisibilityStatusText(visibleCount: number, totalCount: number): string;
682
+ declare function getColumnVisibilityEmptyText(): string;
683
+ declare function getColumnVisibilityResetButtonProps(hiddenCount: number): PrimitiveProps;
684
+ declare function getColumnVisibilityResetButtonText(): string;
685
+ declare function normalizeGridDensity(value: unknown, fallback?: GridDensity): GridDensity;
686
+ declare function createGridPreferences(state?: Partial<GridState>, density?: GridDensity, options?: GridPreferencesOptions): GridPreferences;
687
+ declare function serializeGridPreferences(preferences: GridPreferences, options?: GridPreferencesOptions): string;
688
+ declare function parseGridPreferences(value: string, options?: GridPreferencesOptions): GridPreferences | null;
689
+ declare function getBrowserGridPreferencesStorage(environment?: GridPreferencesStorageEnvironmentLike | null | undefined): GridPreferencesStorageLike | null;
690
+ declare function readGridPreferences(storage: GridPreferencesStorageLike | null | undefined, key: string, options?: GridPreferencesOptions): GridPreferences | null;
691
+ declare function writeGridPreferences(storage: GridPreferencesStorageLike | null | undefined, key: string, state: Partial<GridState>, density: GridDensity, options?: GridPreferencesOptions): boolean;
692
+ declare function removeGridPreferences(storage: GridPreferencesStorageLike | null | undefined, key: string): boolean;
693
+ declare function getGridDensityProps(density: GridDensity): PrimitiveProps;
694
+ declare function getGridDensityRowHeight(density: GridDensity): number;
695
+ declare function getDensityControlsProps(): PrimitiveProps;
696
+ declare function getDensityButtonProps(density: GridDensity, currentDensity: GridDensity): PrimitiveProps;
697
+ declare function getDensityButtonText(density: GridDensity): string;
698
+ declare function getFilteredColumnVisibilityColumns<TData>(columns: readonly Column<TData, unknown>[], query: string): Column<TData, unknown>[];
699
+ declare function getNextColumnFilters(filters: ColumnFiltersState, columnId: ColumnId, value: string): ColumnFiltersState;
700
+ declare function getPaginationProps(): PrimitiveProps;
701
+ declare function getPaginationButtonProps(options: PaginationButtonPrimitiveOptions): PrimitiveProps;
702
+ declare function getPaginationButtonText(action: PaginationAction): string;
703
+ declare function getPaginationStatusProps(): PrimitiveProps;
704
+ declare function getPaginationPageText<TData>(grid: Grid<TData>): string;
705
+ declare function getPaginationPageSizeSelectProps(pageSize: number): PrimitiveProps;
706
+ declare function getPaginationPageSizeOptions(options?: readonly number[], currentPageSize?: number): number[];
707
+ declare function getPaginationPageSizeOptionText(pageSize: number): string;
708
+ declare function getGridBodyProps(options?: GridBodyPrimitiveOptions): PrimitiveProps;
709
+ declare function getGridEmptyRowProps(options?: GridEmptyRowPrimitiveOptions): PrimitiveProps;
710
+ declare function getGridEmptyCellProps(options?: GridEmptyCellPrimitiveOptions): PrimitiveProps;
711
+ declare function getColumnSpacerProps(): PrimitiveProps;
712
+ declare function getHeaderCellProps<TData>(grid: Grid<TData>, column: Column<TData, unknown>, columnIndex: number, options?: HeaderCellPrimitiveOptions): PrimitiveProps;
713
+ declare function getHeaderPlaceholderCellProps<TData>(column: Column<TData, unknown>): PrimitiveProps;
714
+ declare function getHeaderCellLayoutProps(options?: HeaderCellLayoutPrimitiveOptions): PrimitiveProps;
715
+ declare function getHeaderButtonProps(options?: HeaderButtonPrimitiveOptions): PrimitiveProps;
716
+ declare function getHeaderSortIndicatorProps(): PrimitiveProps;
717
+ declare function getHeaderSortIndicatorText(sortDirection: "asc" | "desc" | false | null | undefined, options?: HeaderSortIndicatorTextOptions): string;
718
+ declare function getHeaderKeyboardMoveDirection(event: HeaderKeyboardMoveEventLike): "left" | "right" | null;
719
+ declare function getHeaderActionMenuTriggerFocusPosition(event: {
720
+ key: string;
721
+ }): "first" | "last" | null;
722
+ declare function getHeaderActionMenuKeyboardAction(event: {
723
+ key: string;
724
+ }): HeaderActionMenuKeyboardAction | null;
725
+ declare function isHeaderActionMenuCloseAction(action: HeaderActionMenuKeyboardAction | null | undefined): action is Extract<HeaderActionMenuKeyboardAction, {
726
+ type: "close";
727
+ }>;
728
+ declare function isHeaderActionMenuFocusAction(action: HeaderActionMenuKeyboardAction | null | undefined): action is Extract<HeaderActionMenuKeyboardAction, {
729
+ type: "focus";
730
+ }>;
731
+ declare function isHeaderActionMenuTabCloseAction(action: HeaderActionMenuKeyboardAction | null | undefined): action is Extract<HeaderActionMenuKeyboardAction, {
732
+ type: "tab-close";
733
+ }>;
734
+ declare function getGridKeyboardShortcutAction(event: GridKeyboardShortcutEventLike): GridKeyboardShortcutAction | null;
735
+ declare function getGridKeyboardEditAction(event: GridKeyboardShortcutEventLike): GridKeyboardEditAction | null;
736
+ declare function getCellEditorKeyboardAction(event: {
737
+ key: string;
738
+ }): CellEditorKeyboardAction | null;
739
+ declare function getGridKeyboardFocusMove(event: GridKeyboardShortcutEventLike): GridKeyboardFocusMove | null;
740
+ declare function getColumnResizeHandleProps<TData>(column: Column<TData, unknown>, options?: ColumnResizeHandlePrimitiveOptions): PrimitiveProps;
741
+ declare function getColumnResizeStartSize<TData>(grid: Grid<TData>, column: Column<TData, unknown>): number;
742
+ declare function getColumnResizeKeyboardSize<TData>(column: Column<TData, unknown>, startSize: number, event: ColumnResizeKeyboardEventLike, options?: ColumnResizeKeyboardSizeOptions): number | null;
743
+ declare function getColumnResizePointerSize(startSize: number, startX: number, event: ColumnResizePointerEventLike): number;
744
+ declare function getCanStartColumnResize(event: ColumnResizeDefaultPreventableEventLike): boolean;
745
+ declare function getCanApplyColumnResize(event: ColumnResizeDefaultPreventableEventLike): boolean;
746
+ declare function getColumnResizeFinalSize(startSize: number, event: ColumnResizeFinalSizeEventLike): number;
747
+ declare function isPointerCaptureTarget(target: unknown): target is PointerCaptureTargetLike;
748
+ declare function getPointerCaptureTarget(event: PointerCaptureEventLike): unknown;
749
+ declare function getDefaultPointerMoveUpListenerTarget(): PointerMoveUpListenerTargetLike | null;
750
+ declare function getDefaultPointerUpCancelListenerTarget(): PointerUpCancelListenerTargetLike | null;
751
+ declare function getDefaultPointerMoveUpCancelListenerTarget(): PointerMoveUpCancelListenerTargetLike | null;
752
+ declare function trySetPointerCapture(target: unknown, pointerId: number): boolean;
753
+ declare function tryReleasePointerCapture(target: unknown, pointerId: number): boolean;
754
+ declare function addPointerMoveUpListeners(listeners: PointerMoveUpListeners, target?: PointerMoveUpListenerTargetLike | null | undefined): () => void;
755
+ declare function addPointerUpCancelListeners(listeners: PointerUpCancelListeners, target?: PointerUpCancelListenerTargetLike | null | undefined): () => void;
756
+ declare function addPointerMoveUpCancelListeners(listeners: PointerMoveUpCancelListeners, target?: PointerMoveUpCancelListenerTargetLike | null | undefined): () => void;
757
+ declare function addPassiveScrollListener(listener: ScrollListener, target: ScrollListenerTargetLike): () => void;
758
+ declare function getColumnPinningControlsProps<TData>(column: Column<TData, unknown>): PrimitiveProps;
759
+ declare function getColumnPinningButtonText(position: ColumnPinningPosition): string;
760
+ declare function getColumnPinningButtonProps<TData>(column: Column<TData, unknown>, options: ColumnPinningButtonPrimitiveOptions): PrimitiveProps;
761
+ declare function getHeaderActionMenuTriggerProps<TData>(column: Column<TData, unknown>, options: HeaderActionMenuTriggerPrimitiveOptions): PrimitiveProps;
762
+ declare function getHeaderActionMenuId(columnId: string): string;
763
+ declare function getHeaderActionMenuTriggerId(columnId: string): string;
764
+ declare function getHeaderActionMenuProps<TData>(column: Column<TData, unknown>): PrimitiveProps;
765
+ declare function getHeaderActionMenuDefaultItemLabel(itemId: HeaderActionMenuDefaultItemId, options?: HeaderActionMenuDefaultItemLabelOptions): string;
766
+ declare function getHeaderActionMenuDefaultItemDescriptors(options: HeaderActionMenuDefaultItemDescriptorOptions): HeaderActionMenuDefaultItemDescriptor[];
767
+ declare function getHeaderActionMenuItemProps(options?: HeaderActionMenuItemPrimitiveOptions): PrimitiveProps;
768
+ declare function getHeaderActionMenuCustomItemProps(options?: HeaderActionMenuLabelPrimitiveOptions): PrimitiveProps;
769
+ declare function getHeaderActionMenuLabelProps(): PrimitiveProps;
770
+ declare function getHeaderActionMenuSeparatorProps(options?: HeaderActionMenuLabelPrimitiveOptions): PrimitiveProps;
771
+ declare function isHeaderActionMenuItem<TItem>(item: TItem | null | false | undefined): item is TItem;
772
+ declare function isHeaderActionMenuActionItem<TItem extends HeaderActionMenuPrimitiveItem>(item: TItem | null | false | undefined): item is Extract<TItem, {
773
+ type?: "action";
774
+ }>;
775
+ declare function isHeaderActionMenuCustomItem<TItem extends HeaderActionMenuPrimitiveItem>(item: TItem | null | false | undefined): item is Extract<TItem, {
776
+ type: "custom";
777
+ }>;
778
+ declare function isHeaderActionMenuLabelItem<TItem extends HeaderActionMenuPrimitiveItem>(item: TItem | null | false | undefined): item is Extract<TItem, {
779
+ type: "label";
780
+ }>;
781
+ declare function isHeaderActionMenuSeparatorItem<TItem extends HeaderActionMenuPrimitiveItem>(item: TItem | null | false | undefined): item is Extract<TItem, {
782
+ type: "separator";
783
+ }>;
784
+ declare function getHeaderActionMenuCustomItemUserProps(item: HeaderActionMenuPrimitiveCustomItem | null | false | undefined): Record<string, unknown>;
785
+ declare function getGroupingPanelProps(options?: GroupingPanelPrimitiveOptions): PrimitiveProps;
786
+ declare function getGroupingPanelPlaceholderProps(): PrimitiveProps;
787
+ declare function getGroupingPanelChipProps<TData>(column: Column<TData, unknown>): PrimitiveProps;
788
+ declare function getGroupingPanelMoveButtonProps<TData>(column: Column<TData, unknown>, options: GroupingPanelMoveButtonPrimitiveOptions): PrimitiveProps;
789
+ declare function getGroupingPanelRemoveButtonProps<TData>(column: Column<TData, unknown>): PrimitiveProps;
790
+ declare function getIsGroupLabelCell<TData>(row: Row<TData>, column: Column<TData, unknown>, visibleColumns: readonly Column<TData, unknown>[]): boolean;
791
+ declare function getGroupValueText(value: unknown): string;
792
+ declare function getGroupRowLabel<TData, TFallback = string>(row: Row<TData>, column: Column<TData, unknown>, options?: GroupRowLabelOptions<TFallback>): string | TFallback;
793
+ declare function getGroupCellIndent<TData>(row: Row<TData>, options?: GroupCellIndentOptions): number;
794
+ declare function getGroupCellIndentStyle<TData>(row: Row<TData>, options?: GroupCellIndentOptions): GroupCellIndentStyleProps;
795
+ declare function getGroupCellIndentStyleText<TData>(row: Row<TData>, options?: GroupCellIndentOptions): string;
796
+ declare function getGroupRowCountText<TData>(row: Row<TData>): string | undefined;
797
+ declare function getRowProps<TData>(row: Row<TData>, rowIndex: number, options?: RowPrimitiveOptions): PrimitiveProps;
798
+ declare function getRowLayoutProps<TData>(row: Row<TData>, options?: RowLayoutPrimitiveOptions): PrimitiveProps;
799
+ declare function getRowExpansionToggleProps<TData>(row: Row<TData>, options: RowExpansionTogglePrimitiveOptions): PrimitiveProps;
800
+ declare function getRowExpansionToggleText(expanded: boolean): string;
801
+ declare function getRowExpansionSpacerProps(): PrimitiveProps;
802
+ declare function getCellProps<TData>(row: Row<TData>, column: Column<TData, unknown>, _rowIndex: number, columnIndex: number, options?: CellPrimitiveOptions): PrimitiveProps;
803
+ declare function getCellLayoutProps(options?: CellLayoutPrimitiveOptions): PrimitiveProps;
804
+ declare function getCellFillHandleProps(): PrimitiveProps;
805
+ declare function getCanStartCellEdit<TData>(row: Row<TData>, column: Column<TData, unknown>): boolean;
806
+ declare function getCanStartFocusedCellEdit(focusedCell: CellCoordinate | null | undefined, editingCell: CellCoordinate | null | undefined): focusedCell is CellCoordinate;
807
+ declare function getCanRestoreFocusedCell(options: FocusedCellRestoreOptions): boolean;
808
+ declare function getShouldCancelFocusedCellRestoreOnFrameSync(options?: FocusedCellRestoreFrameSyncOptions): boolean;
809
+ declare function getCanCancelCellEdit(editingCell: CellCoordinate | null | undefined): editingCell is CellCoordinate;
810
+ declare function getCanRunGridKeyboardShortcut(editingCell: CellCoordinate | null | undefined): boolean;
811
+ declare function getFocusedRowSelectionTarget<TData>(rows: Array<Row<TData>>, focusedCell: CellCoordinate | null | undefined): FocusedRowSelectionTarget<TData> | null;
812
+ declare function getCanToggleRowSelection(event: RowSelectionToggleEventLike): boolean;
813
+ declare function getCellEditText(value: unknown): string;
814
+ declare function getCellEditorTargetValue(target: unknown): unknown;
815
+ declare function getCellEditorEventValue(event: CellEditorValueEventLike): string;
816
+ declare function parseCellEditValue<TData>(grid: Grid<TData>, row: Row<TData>, column: Column<TData, unknown>, value: string): unknown;
817
+ declare function getCellEditValidationMessage(event: CellEditValidationEventLike | null | undefined): string | null;
818
+ declare function getDefaultClipboardTextEnvironment(): ClipboardTextEnvironment;
819
+ declare function getDefaultBrowserDownloadEnvironment(): BrowserDownloadEnvironment;
820
+ declare function writeClipboardText(text: string, environment?: ClipboardTextEnvironment): Promise<boolean>;
821
+ declare function readClipboardText(environment?: ClipboardTextEnvironment): Promise<string>;
822
+ declare function downloadBrowserExportFile(file: BrowserExportFileLike, environment?: BrowserDownloadEnvironment): boolean;
823
+ declare function getCellDisplayText(value: unknown): string;
824
+ declare function escapeGridHtml(value: string): string;
825
+ declare function getColumnHeaderText<TData>(column: Column<TData, unknown>): string;
826
+ declare function getCellFillHandleVisible<TData>(row: Row<TData>, column: Column<TData, unknown>, options: CellFillHandleVisibilityOptions): boolean;
827
+ declare function getCanStartCellPointerDrag(event: PointerButtonEventLike, editingCell: CellCoordinate | null | undefined): boolean;
828
+ declare function getCellEditorProps<TData>(column: Column<TData, unknown>, options?: CellEditorPrimitiveOptions): PrimitiveProps;
829
+ declare function getCellEditorOptionProps(option: CellEditorOptionPrimitiveOptions): PrimitiveProps;
830
+ declare function getCellEditorOptionText(option: CellEditorOptionPrimitiveOptions): string;
831
+ declare function getCellValidationMessageProps(): PrimitiveProps;
832
+ declare function isFocusableElement(target: unknown): target is FocusableElementLike;
833
+ declare function getEnabledHeaderActionMenuItems(menu: ParentNode | null): HeaderActionMenuItemFocusTargetLike[];
834
+ declare function getHeaderActionMenuActiveElement(menu: HeaderActionMenuActiveElementTargetLike | null | undefined, fallbackDocument?: HeaderActionMenuActiveElementDocumentLike | null | undefined): unknown | null;
835
+ declare function focusHeaderActionMenuItem(menu: HeaderActionMenuFocusTargetLike | null, position: HeaderActionMenuItemFocusPosition): boolean;
836
+ declare function isHeaderActionMenuFocusTarget(target: unknown): target is HeaderActionMenuFocusTargetLike;
837
+ declare function getHeaderActionMenuFocusTarget(event: HeaderActionMenuFocusTargetEventLike): HeaderActionMenuFocusTargetLike | null;
838
+ declare function focusElement(element: FocusableElementLike | null | undefined): boolean;
839
+ declare function focusCellEditorElement(element: FocusableSelectableElementLike | null | undefined): boolean;
840
+ declare function focusElementById(lookup: ElementIdLookupLike, id: string): boolean;
841
+ declare function focusHeaderActionMenuTrigger(element: FocusableElementLike | null | undefined): boolean;
842
+ declare function focusHeaderActionMenuTriggerById(lookup: ElementIdLookupLike, id: string): boolean;
843
+ declare function focusHeaderActionMenuItemById(lookup: ElementIdLookupLike<HeaderActionMenuFocusTargetLike>, id: string, position: HeaderActionMenuItemFocusPosition): boolean;
844
+ declare function focusFocusedCellInGrid(container: FocusedCellContainerLike | null | undefined): boolean;
845
+ declare function scrollElementToPosition(element: ScrollPositionElementLike | null | undefined, position: FocusedCellScrollPosition | null | undefined): boolean;
846
+ declare function getScrollFrameOptionsFromElement(element: ScrollFrameElementLike, options?: ScrollFrameElementOptions): ScrollFrameOptionsLike;
847
+ declare function getFocusedCellScrollOptionsFromElement<TData>(element: ScrollFrameElementLike, options: FocusedCellScrollElementOptions<TData>): FocusedCellScrollOptions<TData>;
848
+ declare function isGridInteractiveKeyboardTarget(target: EventTarget | null, currentTarget: EventTarget | null): boolean;
849
+ declare function isGridInteractiveKeyboardEventTarget(event: KeyboardTargetEventLike): boolean;
850
+ declare function getShouldPreventEventDefault(event: DefaultPreventedEventLike): boolean;
851
+ declare function preventDefaultAndStopPropagation(event: DefaultPreventablePropagationEventLike): void;
852
+ declare function preventEventDefault(event: DefaultPreventableEventLike): void;
853
+ declare function stopEventPropagation(event: PropagationEventLike): void;
854
+ interface ClickSuppressionController {
855
+ suppress(): void;
856
+ consume(event?: DefaultPreventablePropagationEventLike): boolean;
857
+ }
858
+ declare function createClickSuppressionController(): ClickSuppressionController;
859
+ declare function isPointerInsideElement(event: PointerClientCoordinateLike, element: PointerHitTestElementLike | null | undefined): boolean;
860
+ declare function hasPointerMovedPastDragThreshold(event: PointerClientCoordinateLike, start: PointerDragStartLike, threshold?: number): boolean;
861
+ declare function updatePointerDragDidMovePastThreshold(drag: PointerDragMovementLike, event: PointerClientCoordinateLike, threshold?: number): boolean;
862
+ declare function isPrimaryPointerButton(event: PointerButtonEventLike): boolean;
863
+ declare function isPrimaryPointerDragActive(event: PointerButtonsEventLike): boolean;
864
+ declare function getCanContinuePointerDrag<TDrag extends PointerDragSessionLike>(drag: TDrag | null | undefined, event: PointerButtonsEventLike & PointerIdEventLike): drag is TDrag;
865
+ declare function getCanEndPointerDrag<TDrag extends PointerDragSessionLike>(drag: TDrag | null | undefined, event: PointerIdEventLike): drag is TDrag;
866
+ declare function getHeaderDragEndAction<TColumn extends HeaderDragEndColumnLike>(drag: HeaderDragEndLike, options: HeaderDragEndActionOptions<TColumn>): HeaderDragEndAction | null;
867
+ declare function isHeaderDragGroupAction(action: HeaderDragEndAction | null | undefined): action is Extract<HeaderDragEndAction, {
868
+ type: "group";
869
+ }>;
870
+ declare function isHeaderDragMoveAction(action: HeaderDragEndAction | null | undefined): action is Extract<HeaderDragEndAction, {
871
+ type: "move";
872
+ }>;
873
+ declare function getMeasuredElementBlockSize(element: MeasuredBlockElementLike, fallbackSize: number): number;
874
+ declare function isMeasuredBlockElement(target: unknown): target is MeasuredBlockElementLike;
875
+ declare function isMeasuredBlockRectElement(target: unknown): target is MeasuredBlockRectElementLike;
876
+ declare function isMeasuredBlockRectElementTarget(target: unknown): target is MeasuredBlockRectElementTargetLike;
877
+ declare function isMeasuredInlineElement(target: unknown): target is MeasuredInlineElementLike;
878
+ declare function isMeasuredInlineDatasetElementTarget(target: unknown): target is MeasuredInlineDatasetElementTargetLike;
879
+ declare function getMeasuredElementBlockSizeFromTarget(target: unknown, fallbackSize: number): number;
880
+ declare function getMeasuredElementBlockSizeFromRect(element: MeasuredBlockRectElementLike): number;
881
+ declare function getMeasuredElementInlineSize(element: MeasuredInlineElementLike): number;
882
+ declare function getElementOffsetBlockSize(element: OffsetBlockElementLike | null | undefined, fallbackSize: number): number;
883
+ declare function getResizeObserverEntryBlockSize(entry: ResizeObserverBlockSizeEntryLike): number;
884
+ declare function getResizeObserverEntryInlineSize(entry: ResizeObserverInlineSizeEntryLike): number;
885
+ declare function isResizeObserverDatasetTarget(target: unknown): target is ResizeObserverDatasetTargetLike;
886
+ declare function getResizeObserverEntryDatasetId(entry: ResizeObserverDatasetEntryLike, key: ResizeObserverEntryDatasetKey): string | null;
887
+ declare function setElementDatasetId(element: DatasetElementLike, key: ResizeObserverEntryDatasetKey, value: string): void;
888
+ declare function createResizeObserver(callback: ResizeObserverCallback, ResizeObserverConstructor?: ResizeObserverConstructorLike | undefined): ResizeObserver | null;
889
+ declare function observeElements(observer: ResizeObserverObserveLike, elements: Iterable<Element>): void;
890
+ declare function disconnectResizeObserver(observer: ResizeObserverDisconnectLike | null | undefined): void;
891
+ declare function removeObservedElement<TElement extends Element>(observer: ResizeObserverUnobserveLike | null | undefined, elements: ObservedElementMapLike<TElement>, id: string): void;
892
+ declare function replaceObservedElement<TElement extends Element>(observer: (ResizeObserverObserveLike & ResizeObserverUnobserveLike) | null | undefined, elements: ObservedElementMapLike<TElement>, id: string, element: TElement): void;
893
+ declare function applyResizeObserverMeasuredSizes(entries: readonly ResizeObserverEntry[], options: {
894
+ cache: MeasuredSizeCacheLike;
895
+ datasetKey: ResizeObserverEntryDatasetKey;
896
+ getSize: (entry: ResizeObserverEntry) => number;
897
+ }): boolean;
898
+ declare function getSizeOffset(index: number, getSize: (index: number) => number): number;
899
+ declare function getColumnLayoutTotalWidth(layout: readonly ColumnLayoutTotalWidthItemLike[]): number;
900
+ declare function getColumnLayoutById(layout: readonly ColumnLayout[]): ReadonlyMap<ColumnId, ColumnLayout>;
901
+ declare function getColumnById<TColumn extends ColumnIdItemLike>(columnId: ColumnId, columns: readonly TColumn[]): TColumn | undefined;
902
+ declare function getColumnIndexById<TColumn extends ColumnIdItemLike>(columnId: ColumnId, columns: readonly TColumn[]): number;
903
+ declare function getRowById<TRow extends RowIdItemLike>(rowId: string, rows: readonly TRow[]): TRow | undefined;
904
+ type ColumnMoveDirection = "left" | "right";
905
+ interface ColumnMoveGrid<TData> {
906
+ getVisibleLeafColumns: Grid<TData>["getVisibleLeafColumns"];
907
+ moveColumn: Grid<TData>["moveColumn"];
908
+ }
909
+ interface GroupingColumnMoveGrid<TData> {
910
+ moveGroupingColumn: Grid<TData>["moveGroupingColumn"];
911
+ }
912
+ declare function moveVisibleColumn<TData>(grid: ColumnMoveGrid<TData>, columnId: ColumnId, direction: ColumnMoveDirection): boolean;
913
+ declare function moveColumnToTarget<TData>(grid: ColumnMoveGrid<TData>, sourceColumnId: ColumnId, targetColumnId: ColumnId): boolean;
914
+ declare function moveGroupedColumn<TData>(grid: GroupingColumnMoveGrid<TData>, groupingColumns: readonly Column<TData, unknown>[], columnId: ColumnId, direction: ColumnMoveDirection): boolean;
915
+ declare function resolveRowVirtualizationOptions(rowVirtualization: boolean | RowVirtualizationPrimitiveOptions | null | undefined): ResolvedRowVirtualizationOptions;
916
+ declare function resolveColumnVirtualizationOptions(columnVirtualization: boolean | ColumnVirtualizationPrimitiveOptions | null | undefined): ResolvedColumnVirtualizationOptions;
917
+ declare function getScrollForFocusedCell<TData>(options: FocusedCellScrollOptions<TData>): FocusedCellScrollPosition | null;
918
+ declare function getVirtualRowStyle(virtualItem: VirtualRowStyleItemLike | null | undefined): VirtualRowStyleProps | undefined;
919
+ declare function getVirtualRowStyleText(virtualItem: VirtualRowStyleItemLike | null | undefined): string | undefined;
920
+ declare function getVirtualBodyStyle(virtualRange: VirtualBodyStyleRangeLike | null | undefined): VirtualBodyStyleProps | undefined;
921
+ declare function getVirtualBodyStyleText(virtualRange: VirtualBodyStyleRangeLike | null | undefined): string | undefined;
922
+ declare function getInlineSizeStyle(size: number): InlineSizeStyleProps;
923
+ declare function getInlineSizeStyleText(size: number): string;
924
+ declare function getVirtualizedInlineSizeStyle(size: number, enabled: boolean): VirtualizedInlineSizeStyleProps | undefined;
925
+ declare function getVirtualizedInlineSizeStyleText(size: number, enabled: boolean): string | undefined;
926
+ declare function getPinnedColumnOffsetStyle(layout: PinnedColumnOffsetStyleLayoutLike | null | undefined): PinnedColumnOffsetStyleProps | undefined;
927
+ declare function getPinnedColumnOffsetStyleText(layout: PinnedColumnOffsetStyleLayoutLike | null | undefined): string | undefined;
928
+ declare function isCellCoordinateEqual(left: CellCoordinate | null | undefined, right: CellCoordinate | null | undefined): boolean;
929
+ declare function isFocusedCell(focusedCell: CellCoordinate | null, rowId: string, columnId: string): boolean;
930
+
931
+ export { type BrowserDownloadAnchorLike, type BrowserDownloadBlobConstructorLike, type BrowserDownloadDocumentLike, type BrowserDownloadEnvironment, type BrowserDownloadParentLike, type BrowserDownloadUrlLike, type BrowserExportFileLike, type CellEditValidationEventLike, type CellEditorKeyboardAction, type CellEditorOptionPrimitiveOptions, type CellEditorPrimitiveOptions, type CellEditorValueEventLike, type CellEditorValueTargetLike, type CellFillHandleVisibilityOptions, type CellLayoutPrimitiveOptions, type CellPrimitiveOptions, type CheckboxIndeterminateTargetLike, type ClickSuppressionController, type ClipboardTextAreaLike, type ClipboardTextDocumentLike, type ClipboardTextEnvironment, type ClipboardTextNavigatorLike, type ClipboardTextParentLike, type ColumnFilterCellPrimitiveOptions, type ColumnFilterInputPrimitiveOptions, type ColumnIdItemLike, type ColumnLayoutTotalWidthItemLike, type ColumnMoveDirection, type ColumnMoveGrid, type ColumnPinningButtonPrimitiveOptions, type ColumnResizeDefaultPreventableEventLike, type ColumnResizeFinalSizeEventLike, type ColumnResizeHandlePrimitiveOptions, type ColumnResizeKeyboardEventLike, type ColumnResizeKeyboardSizeOptions, type ColumnResizePointerEventLike, type ColumnVirtualizationPrimitiveOptions, type ColumnVisibilityCheckboxPrimitiveOptions, DEFAULT_PAGINATION_PAGE_SIZE_OPTIONS, type DatasetElementLike, type DefaultPreventableEventLike, type DefaultPreventablePropagationEventLike, type DefaultPreventedEventLike, type ElementIdLookupLike, type FocusableElementLike, type FocusableSelectableElementLike, type FocusedCellContainerLike, type FocusedCellRestoreFrameSyncOptions, type FocusedCellRestoreOptions, type FocusedCellScrollElementOptions, type FocusedCellScrollOptions, type FocusedCellScrollPosition, type FocusedRowSelectionTarget, GRID_DENSITIES, GRID_FOCUSED_CELL_SELECTOR, GRID_INTERACTIVE_KEYBOARD_TARGET_SELECTOR, GRID_PREFERENCES_VERSION, GROUPING_PANEL_EMPTY_MESSAGE, type GridBodyPrimitiveOptions, type GridDensity, type GridEmptyCellPrimitiveOptions, type GridEmptyRowPrimitiveOptions, type GridHeaderRowPrimitiveOptions, type GridKeyboardEditAction, type GridKeyboardFocusMove, type GridKeyboardShortcutAction, type GridKeyboardShortcutEventLike, type GridPreferences, type GridPreferencesOptions, type GridPreferencesState, type GridPreferencesStorageEnvironmentLike, type GridPreferencesStorageLike, type GridRowCoordinateOptions, type GroupCellIndentOptions, type GroupCellIndentStyleProps, type GroupRowLabelOptions, type GroupingColumnMoveGrid, type GroupingPanelMoveButtonPrimitiveOptions, type GroupingPanelPrimitiveOptions, HEADER_ACTION_MENU_ENABLED_ITEM_SELECTOR, HEADER_ACTION_MENU_TRIGGER_TEXT, type HeaderActionMenuActiveElementDocumentLike, type HeaderActionMenuActiveElementTargetLike, type HeaderActionMenuDefaultItemDescriptor, type HeaderActionMenuDefaultItemDescriptorOptions, type HeaderActionMenuDefaultItemId, type HeaderActionMenuDefaultItemLabelOptions, type HeaderActionMenuFocusTargetEventLike, type HeaderActionMenuFocusTargetLike, type HeaderActionMenuItemFocusPosition, type HeaderActionMenuItemFocusTargetLike, type HeaderActionMenuItemPrimitiveOptions, type HeaderActionMenuKeyboardAction, type HeaderActionMenuLabelPrimitiveOptions, type HeaderActionMenuPrimitiveCustomItem, type HeaderActionMenuPrimitiveItem, type HeaderActionMenuPrimitiveLabelItem, type HeaderActionMenuPrimitiveSeparatorItem, type HeaderActionMenuTriggerPrimitiveOptions, type HeaderButtonPrimitiveOptions, type HeaderCellLayoutPrimitiveOptions, type HeaderCellPrimitiveOptions, type HeaderDragEndAction, type HeaderDragEndActionOptions, type HeaderDragEndColumnLike, type HeaderDragEndLike, type HeaderKeyboardMoveEventLike, type HeaderSortIndicatorTextOptions, type InlineSizeStyleProps, type KeyboardTargetEventLike, type MeasuredBlockElementLike, type MeasuredBlockRectElementLike, type MeasuredBlockRectElementTargetLike, type MeasuredInlineDatasetElementTargetLike, type MeasuredInlineElementLike, type MeasuredSizeCacheLike, type ObservedElementMapLike, type OffsetBlockElementLike, type PaginationAction, type PaginationButtonPrimitiveOptions, type PinnedColumnOffsetStyleLayoutLike, type PinnedColumnOffsetStyleProps, type PointerButtonEventLike, type PointerButtonsEventLike, type PointerCaptureEventLike, type PointerCaptureTargetLike, type PointerClientCoordinateLike, type PointerDragMovementLike, type PointerDragSessionLike, type PointerDragStartLike, type PointerHitTestElementLike, type PointerIdEventLike, type PointerListener, type PointerMoveUpCancelListenerTargetLike, type PointerMoveUpCancelListeners, type PointerMoveUpListenerTargetLike, type PointerMoveUpListeners, type PointerUpCancelListenerTargetLike, type PointerUpCancelListeners, type PrimitiveProps, type PropagationEventLike, type QuickFilterInputPrimitiveOptions, type ResizeObserverBlockSizeEntryLike, type ResizeObserverConstructorLike, type ResizeObserverDatasetEntryLike, type ResizeObserverDatasetTargetLike, type ResizeObserverDisconnectLike, type ResizeObserverEntryDatasetKey, type ResizeObserverInlineSizeEntryLike, type ResizeObserverObserveLike, type ResizeObserverUnobserveLike, type ResolvedColumnVirtualizationOptions, type ResolvedRowVirtualizationOptions, type RowExpansionTogglePrimitiveOptions, type RowIdItemLike, type RowLayoutPrimitiveOptions, type RowPrimitiveOptions, type RowSelectionCheckboxPrimitiveOptions, type RowSelectionToggleEventLike, type RowVirtualizationPrimitiveOptions, type ScrollFrameElementLike, type ScrollFrameElementOptions, type ScrollFrameOptionsLike, type ScrollListener, type ScrollListenerTargetLike, type ScrollPositionElementLike, type VirtualBodyStyleProps, type VirtualBodyStyleRangeLike, type VirtualRowStyleItemLike, type VirtualRowStyleProps, type VirtualizedInlineSizeStyleProps, addPassiveScrollListener, addPointerMoveUpCancelListeners, addPointerMoveUpListeners, addPointerUpCancelListeners, applyResizeObserverMeasuredSizes, createClickSuppressionController, createGridPreferences, createResizeObserver, disconnectResizeObserver, downloadBrowserExportFile, escapeGridHtml, focusCellEditorElement, focusElement, focusElementById, focusFocusedCellInGrid, focusHeaderActionMenuItem, focusHeaderActionMenuItemById, focusHeaderActionMenuTrigger, focusHeaderActionMenuTriggerById, getBrowserGridPreferencesStorage, getCanApplyColumnResize, getCanCancelCellEdit, getCanContinuePointerDrag, getCanEndPointerDrag, getCanRestoreFocusedCell, getCanRunGridKeyboardShortcut, getCanStartCellEdit, getCanStartCellPointerDrag, getCanStartColumnResize, getCanStartFocusedCellEdit, getCanToggleRowSelection, getCellDisplayText, getCellEditText, getCellEditValidationMessage, getCellEditorEventValue, getCellEditorKeyboardAction, getCellEditorOptionProps, getCellEditorOptionText, getCellEditorProps, getCellEditorTargetValue, getCellFillHandleProps, getCellFillHandleVisible, getCellLayoutProps, getCellProps, getCellValidationMessageProps, getColumnById, getColumnFilterCellProps, getColumnFilterInputProps, getColumnFilterText, getColumnHeaderText, getColumnIndexById, getColumnLayoutById, getColumnLayoutTotalWidth, getColumnPinningButtonProps, getColumnPinningButtonText, getColumnPinningControlsProps, getColumnResizeFinalSize, getColumnResizeHandleProps, getColumnResizeKeyboardSize, getColumnResizePointerSize, getColumnResizeStartSize, getColumnSpacerProps, getColumnVisibilityCheckboxProps, getColumnVisibilityControlsProps, getColumnVisibilityEmptyText, getColumnVisibilityListProps, getColumnVisibilityResetButtonProps, getColumnVisibilityResetButtonText, getColumnVisibilitySearchInputProps, getColumnVisibilityStatusProps, getColumnVisibilityStatusText, getColumnVisibilitySummaryProps, getColumnVisibilitySummaryText, getDefaultBrowserDownloadEnvironment, getDefaultClipboardTextEnvironment, getDefaultPointerMoveUpCancelListenerTarget, getDefaultPointerMoveUpListenerTarget, getDefaultPointerUpCancelListenerTarget, getDensityButtonProps, getDensityButtonText, getDensityControlsProps, getElementOffsetBlockSize, getEnabledHeaderActionMenuItems, getFilteredColumnVisibilityColumns, getFocusedCellScrollOptionsFromElement, getFocusedRowSelectionTarget, getGridBodyProps, getGridBodyRowIndexOffset, getGridDensityProps, getGridDensityRowHeight, getGridEmptyCellProps, getGridEmptyRowProps, getGridErrorOverlayProps, getGridErrorRetryButtonProps, getGridErrorRetryButtonText, getGridErrorText, getGridHeaderProps, getGridHeaderRowCount, getGridHeaderRowProps, getGridKeyboardEditAction, getGridKeyboardFocusMove, getGridKeyboardShortcutAction, getGridLoadingOverlayProps, getGridLoadingText, getGridProps, getGroupCellIndent, getGroupCellIndentStyle, getGroupCellIndentStyleText, getGroupRowCountText, getGroupRowLabel, getGroupValueText, getGroupingPanelChipProps, getGroupingPanelMoveButtonProps, getGroupingPanelPlaceholderProps, getGroupingPanelProps, getGroupingPanelRemoveButtonProps, getHeaderActionMenuActiveElement, getHeaderActionMenuCustomItemProps, getHeaderActionMenuCustomItemUserProps, getHeaderActionMenuDefaultItemDescriptors, getHeaderActionMenuDefaultItemLabel, getHeaderActionMenuFocusTarget, getHeaderActionMenuId, getHeaderActionMenuItemProps, getHeaderActionMenuKeyboardAction, getHeaderActionMenuLabelProps, getHeaderActionMenuProps, getHeaderActionMenuSeparatorProps, getHeaderActionMenuTriggerFocusPosition, getHeaderActionMenuTriggerId, getHeaderActionMenuTriggerProps, getHeaderButtonProps, getHeaderCellLayoutProps, getHeaderCellProps, getHeaderDragEndAction, getHeaderKeyboardMoveDirection, getHeaderPlaceholderCellProps, getHeaderSortIndicatorProps, getHeaderSortIndicatorText, getInlineSizeStyle, getInlineSizeStyleText, getIsGroupLabelCell, getMeasuredElementBlockSize, getMeasuredElementBlockSizeFromRect, getMeasuredElementBlockSizeFromTarget, getMeasuredElementInlineSize, getNextColumnFilters, getPaginationButtonProps, getPaginationButtonText, getPaginationPageSizeOptionText, getPaginationPageSizeOptions, getPaginationPageSizeSelectProps, getPaginationPageText, getPaginationProps, getPaginationStatusProps, getPinnedColumnOffsetStyle, getPinnedColumnOffsetStyleText, getPointerCaptureTarget, getQuickFilterClearButtonProps, getQuickFilterClearButtonText, getQuickFilterInputProps, getQuickFilterProps, getResizeObserverEntryBlockSize, getResizeObserverEntryDatasetId, getResizeObserverEntryInlineSize, getRowById, getRowExpansionSpacerProps, getRowExpansionToggleProps, getRowExpansionToggleText, getRowLayoutProps, getRowProps, getRowSelectionCheckboxProps, getRowSelectionCheckboxText, getRowSelectionClearButtonProps, getRowSelectionClearButtonText, getRowSelectionControlsProps, getRowSelectionStatusProps, getRowSelectionStatusText, getScrollForFocusedCell, getScrollFrameOptionsFromElement, getShouldCancelFocusedCellRestoreOnFrameSync, getShouldPreventEventDefault, getSizeOffset, getVirtualBodyStyle, getVirtualBodyStyleText, getVirtualRowStyle, getVirtualRowStyleText, getVirtualizedInlineSizeStyle, getVirtualizedInlineSizeStyleText, hasPointerMovedPastDragThreshold, isCellCoordinateEqual, isFocusableElement, isFocusedCell, isGridInteractiveKeyboardEventTarget, isGridInteractiveKeyboardTarget, isHeaderActionMenuActionItem, isHeaderActionMenuCloseAction, isHeaderActionMenuCustomItem, isHeaderActionMenuFocusAction, isHeaderActionMenuFocusTarget, isHeaderActionMenuItem, isHeaderActionMenuLabelItem, isHeaderActionMenuSeparatorItem, isHeaderActionMenuTabCloseAction, isHeaderDragGroupAction, isHeaderDragMoveAction, isMeasuredBlockElement, isMeasuredBlockRectElement, isMeasuredBlockRectElementTarget, isMeasuredInlineDatasetElementTarget, isMeasuredInlineElement, isPointerCaptureTarget, isPointerInsideElement, isPrimaryPointerButton, isPrimaryPointerDragActive, isResizeObserverDatasetTarget, moveColumnToTarget, moveGroupedColumn, moveVisibleColumn, normalizeGridDensity, observeElements, parseCellEditValue, parseGridPreferences, preventDefaultAndStopPropagation, preventEventDefault, readClipboardText, readGridPreferences, removeGridPreferences, removeObservedElement, replaceObservedElement, resolveColumnVirtualizationOptions, resolveRowVirtualizationOptions, scrollElementToPosition, serializeGridPreferences, setCheckboxIndeterminate, setElementDatasetId, stopEventPropagation, tryReleasePointerCapture, trySetPointerCapture, updatePointerDragDidMovePastThreshold, writeClipboardText, writeGridPreferences };