@progress/kendo-react-grid 9.3.1-develop.1 → 9.4.0-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Grid.js +1 -1
- package/Grid.mjs +80 -1042
- package/GridClientContextReader.js +8 -0
- package/GridClientContextReader.mjs +30 -0
- package/GridClientWrapper.js +8 -0
- package/GridClientWrapper.mjs +759 -0
- package/GridComponent.js +8 -0
- package/GridComponent.mjs +584 -0
- package/GridState.js +8 -0
- package/GridState.mjs +93 -0
- package/GridWatermarkOverlay.js +8 -0
- package/GridWatermarkOverlay.mjs +15 -0
- package/StatusBar.js +1 -1
- package/StatusBar.mjs +24 -24
- package/cells/GridCell.js +1 -1
- package/cells/GridCell.mjs +23 -33
- package/cells/GridDetailCell.js +1 -1
- package/cells/GridDetailCell.mjs +11 -18
- package/cells/GridDetailHierarchyCell.js +1 -1
- package/cells/GridDetailHierarchyCell.mjs +5 -5
- package/cells/GridEditCell.js +1 -1
- package/cells/GridEditCell.mjs +22 -130
- package/cells/GridGroupCell.js +1 -1
- package/cells/GridGroupCell.mjs +60 -95
- package/cells/GridHierarchyCell.js +1 -1
- package/cells/GridHierarchyCell.mjs +22 -61
- package/cells/GridRowReorderCell.js +8 -0
- package/cells/GridRowReorderCell.mjs +42 -0
- package/cells/GridSelectionCell.js +1 -1
- package/cells/GridSelectionCell.mjs +17 -35
- package/cells/client/DetailCellContainer.js +8 -0
- package/cells/client/DetailCellContainer.mjs +26 -0
- package/cells/client/GridCellContainer.js +8 -0
- package/cells/client/GridCellContainer.mjs +68 -0
- package/cells/client/GridEditCellContainer.js +8 -0
- package/cells/client/GridEditCellContainer.mjs +60 -0
- package/cells/client/GridEditCellEditor.js +8 -0
- package/cells/client/GridEditCellEditor.mjs +81 -0
- package/cells/client/GridGroupCellContainer.js +8 -0
- package/cells/client/GridGroupCellContainer.mjs +87 -0
- package/cells/client/GridGroupCellToggle.js +8 -0
- package/cells/client/GridGroupCellToggle.mjs +52 -0
- package/cells/client/GridHierarchyCellContainer.js +8 -0
- package/cells/client/GridHierarchyCellContainer.mjs +63 -0
- package/cells/client/GridHierarchyCellToggle.js +8 -0
- package/cells/client/GridHierarchyCellToggle.mjs +43 -0
- package/cells/client/GridRowReorderContainer.js +8 -0
- package/cells/client/GridRowReorderContainer.mjs +24 -0
- package/cells/client/GridSelectionCellContainer.js +8 -0
- package/cells/client/GridSelectionCellContainer.mjs +60 -0
- package/cells/client/GridSelectionCellInput.js +8 -0
- package/cells/client/GridSelectionCellInput.mjs +43 -0
- package/columnMenu/GridColumnMenuSort.js +1 -1
- package/columnMenu/GridColumnMenuSort.mjs +23 -34
- package/components/GridContainerElementContainer.js +8 -0
- package/components/GridContainerElementContainer.mjs +21 -0
- package/components/GridCustomCellClientContainer.js +8 -0
- package/components/GridCustomCellClientContainer.mjs +28 -0
- package/components/GridDragClue.js +8 -0
- package/components/GridDragClue.mjs +18 -0
- package/components/GridDraggableRowsContainer.js +8 -0
- package/components/GridDraggableRowsContainer.mjs +127 -0
- package/components/GridDropClue.js +8 -0
- package/components/GridDropClue.mjs +18 -0
- package/components/GridElementContainer.js +8 -0
- package/components/GridElementContainer.mjs +22 -0
- package/components/PagerContainer.js +8 -0
- package/components/PagerContainer.mjs +23 -0
- package/components/VirtualScrollHeightContainer.js +8 -0
- package/components/VirtualScrollHeightContainer.mjs +17 -0
- package/components/colGroup/GridColGroup.js +8 -0
- package/components/colGroup/GridColGroup.mjs +25 -0
- package/components/icons/reorder-row-svg.js +8 -0
- package/components/icons/reorder-row-svg.mjs +14 -0
- package/{GridNoRecords.js → components/noRecords/GridNoRecords.js} +1 -1
- package/{GridNoRecords.mjs → components/noRecords/GridNoRecords.mjs} +1 -1
- package/components/noRecords/GridNoRecordsContainer.js +8 -0
- package/components/noRecords/GridNoRecordsContainer.mjs +30 -0
- package/components/table/GridTable.js +8 -0
- package/components/table/GridTable.mjs +28 -0
- package/components/table/GridTableBody.js +8 -0
- package/components/table/GridTableBody.mjs +21 -0
- package/components/table/GridTableScrollable.js +8 -0
- package/components/table/GridTableScrollable.mjs +37 -0
- package/components/utils.js +8 -0
- package/components/utils.mjs +26 -0
- package/contextMenu/GridContextMenu.js +8 -0
- package/contextMenu/GridContextMenu.mjs +191 -0
- package/contextMenu/enums.js +8 -0
- package/contextMenu/enums.mjs +13 -0
- package/dist/cdn/js/kendo-react-grid.js +1 -1
- package/footer/Footer.js +1 -1
- package/footer/Footer.mjs +22 -21
- package/footer/FooterCell.js +8 -0
- package/footer/FooterCell.mjs +43 -0
- package/footer/FooterRow.js +1 -1
- package/footer/FooterRow.mjs +10 -39
- package/footer/client/FooterCellContainer.js +8 -0
- package/footer/client/FooterCellContainer.mjs +26 -0
- package/header/FilterRow.js +1 -1
- package/header/FilterRow.mjs +58 -54
- package/header/GridHeaderCell.js +1 -1
- package/header/GridHeaderCell.mjs +11 -11
- package/header/GridHeaderSelectionCell.js +1 -1
- package/header/GridHeaderSelectionCell.mjs +10 -9
- package/header/GroupPanel.js +1 -1
- package/header/GroupPanel.mjs +36 -32
- package/header/Header.js +1 -1
- package/header/Header.mjs +35 -33
- package/header/HeaderRow.js +1 -1
- package/header/HeaderRow.mjs +97 -125
- package/header/client/GridFilterCellContainer.js +8 -0
- package/header/client/GridFilterCellContainer.mjs +38 -0
- package/header/client/GridFilterCellElementContainer.js +8 -0
- package/header/client/GridFilterCellElementContainer.mjs +21 -0
- package/header/client/GridHeaderCellContainer.js +8 -0
- package/header/client/GridHeaderCellContainer.mjs +54 -0
- package/header/client/GridHeaderCellElementContainer.js +8 -0
- package/header/client/GridHeaderCellElementContainer.mjs +28 -0
- package/header/client/GridHeaderRowContainer.js +8 -0
- package/header/client/GridHeaderRowContainer.mjs +35 -0
- package/header/client/GridHeaderRowReorderCell.js +8 -0
- package/header/client/GridHeaderRowReorderCell.mjs +13 -0
- package/header/client/HeaderCellResizer.js +8 -0
- package/header/client/HeaderCellResizer.mjs +25 -0
- package/header/client/HeaderRowDraggable.js +8 -0
- package/header/client/HeaderRowDraggable.mjs +30 -0
- package/index.d.mts +543 -24
- package/index.d.ts +543 -24
- package/index.js +1 -1
- package/index.mjs +58 -52
- package/interfaces/GridSortSettings.js +1 -1
- package/interfaces/GridSortSettings.mjs +18 -2
- package/messages/index.js +1 -1
- package/messages/index.mjs +76 -82
- package/messages/messagesMap.js +8 -0
- package/messages/messagesMap.mjs +19 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +12 -11
- package/rows/GridRow.js +1 -1
- package/rows/GridRow.mjs +42 -20
- package/utils/_clientModule.js +8 -0
- package/utils/_clientModule.mjs +13 -0
- package/utils/_serverModule.js +8 -0
- package/utils/_serverModule.mjs +13 -0
- package/utils/index.js +1 -1
- package/utils/index.mjs +213 -101
package/index.d.mts
CHANGED
|
@@ -14,22 +14,31 @@ import { ColumnSortSettings } from '@progress/kendo-react-data-tools';
|
|
|
14
14
|
import { ComponentType } from 'react';
|
|
15
15
|
import { CompositeFilterDescriptor } from '@progress/kendo-data-query';
|
|
16
16
|
import { DataResult } from '@progress/kendo-data-query';
|
|
17
|
+
import { DetailExpandDescriptor } from '@progress/kendo-react-data-tools';
|
|
17
18
|
import { DragClue } from '@progress/kendo-react-data-tools';
|
|
18
19
|
import { DropClue } from '@progress/kendo-react-data-tools';
|
|
20
|
+
import { EditDescriptor } from '@progress/kendo-react-data-tools';
|
|
19
21
|
import { FilterOperator } from '@progress/kendo-react-data-tools';
|
|
20
22
|
import { getSelectedState } from '@progress/kendo-react-data-tools';
|
|
21
23
|
import { getSelectedStateFromKeyDown } from '@progress/kendo-react-data-tools';
|
|
22
24
|
import { GridClassStructure } from '@progress/kendo-react-common';
|
|
23
25
|
import { GroupDescriptor } from '@progress/kendo-data-query';
|
|
26
|
+
import { GroupExpandDescriptor } from '@progress/kendo-react-data-tools';
|
|
27
|
+
import { GroupState } from '@progress/kendo-react-data-tools';
|
|
24
28
|
import { HeaderCellBaseProps } from '@progress/kendo-react-data-tools';
|
|
25
29
|
import { HeaderThElementProps } from '@progress/kendo-react-data-tools';
|
|
26
30
|
import { JSX as JSX_2 } from 'react/jsx-runtime';
|
|
27
31
|
import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
|
|
32
|
+
import { MenuItemModel } from '@progress/kendo-react-layout';
|
|
33
|
+
import { MenuSelectEvent } from '@progress/kendo-react-layout';
|
|
28
34
|
import { NavigatableSettings } from '@progress/kendo-react-data-tools';
|
|
35
|
+
import { NormalizedDragEvent } from '@progress/kendo-react-common';
|
|
36
|
+
import { Offset } from '@progress/kendo-react-popup';
|
|
29
37
|
import { PagerProps } from '@progress/kendo-react-data-tools';
|
|
30
38
|
import { PagerTargetEvent } from '@progress/kendo-react-data-tools';
|
|
31
39
|
import * as React_2 from 'react';
|
|
32
40
|
import { ReactElement } from 'react';
|
|
41
|
+
import { SelectDescriptor } from '@progress/kendo-react-data-tools';
|
|
33
42
|
import { setSelectedState } from '@progress/kendo-react-data-tools';
|
|
34
43
|
import { SortDescriptor } from '@progress/kendo-data-query';
|
|
35
44
|
import { SortSettings } from '@progress/kendo-react-data-tools';
|
|
@@ -38,6 +47,8 @@ import { SVGIcon } from '@progress/kendo-react-common';
|
|
|
38
47
|
import { SVGIcon as SVGIcon_2 } from '@progress/kendo-svg-icons';
|
|
39
48
|
import { TABLE_COL_INDEX_ATTRIBUTE } from '@progress/kendo-react-data-tools';
|
|
40
49
|
import { TableDragSelectionReleaseEvent } from '@progress/kendo-react-data-tools';
|
|
50
|
+
import { TableEditableSettings } from '@progress/kendo-react-data-tools';
|
|
51
|
+
import { TableGroupExpandableSettings } from '@progress/kendo-react-data-tools';
|
|
41
52
|
import { TableKeyDownEvent } from '@progress/kendo-react-data-tools';
|
|
42
53
|
import { TableSelectableMode } from '@progress/kendo-react-data-tools';
|
|
43
54
|
import { TableSelectableSettings } from '@progress/kendo-react-data-tools';
|
|
@@ -69,23 +80,173 @@ export declare const cellInputChange: (value: any, e: React_2.SyntheticEvent<any
|
|
|
69
80
|
*/
|
|
70
81
|
export declare const cellOperatorChange: (event: any, currentValue: any, onChange: Function) => void;
|
|
71
82
|
|
|
83
|
+
/**
|
|
84
|
+
* @hidden
|
|
85
|
+
*/
|
|
86
|
+
export declare const contextMenuItemsMap: {
|
|
87
|
+
create: {
|
|
88
|
+
name: string;
|
|
89
|
+
text: string;
|
|
90
|
+
icon: string;
|
|
91
|
+
svgIcon: SVGIcon_2;
|
|
92
|
+
data: {
|
|
93
|
+
action: string;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
edit: {
|
|
97
|
+
name: string;
|
|
98
|
+
text: string;
|
|
99
|
+
icon: string;
|
|
100
|
+
svgIcon: SVGIcon_2;
|
|
101
|
+
data: {
|
|
102
|
+
action: string;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
delete: {
|
|
106
|
+
name: string;
|
|
107
|
+
text: string;
|
|
108
|
+
icon: string;
|
|
109
|
+
svgIcon: SVGIcon_2;
|
|
110
|
+
data: {
|
|
111
|
+
action: string;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
select: {
|
|
115
|
+
name: string;
|
|
116
|
+
text: string;
|
|
117
|
+
icon: string;
|
|
118
|
+
svgIcon: SVGIcon_2;
|
|
119
|
+
items: {
|
|
120
|
+
name: string;
|
|
121
|
+
text: string;
|
|
122
|
+
icon: string;
|
|
123
|
+
svgIcon: SVGIcon_2;
|
|
124
|
+
data: {
|
|
125
|
+
action: string;
|
|
126
|
+
};
|
|
127
|
+
}[];
|
|
128
|
+
};
|
|
129
|
+
copySelection: {
|
|
130
|
+
name: string;
|
|
131
|
+
text: string;
|
|
132
|
+
icon: string;
|
|
133
|
+
svgIcon: SVGIcon_2;
|
|
134
|
+
data: {
|
|
135
|
+
action: string;
|
|
136
|
+
};
|
|
137
|
+
options: string;
|
|
138
|
+
};
|
|
139
|
+
copySelectionNoHeaders: {
|
|
140
|
+
name: string;
|
|
141
|
+
text: string;
|
|
142
|
+
icon: string;
|
|
143
|
+
svgIcon: SVGIcon_2;
|
|
144
|
+
data: {
|
|
145
|
+
action: string;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
paste: {
|
|
149
|
+
name: string;
|
|
150
|
+
text: string;
|
|
151
|
+
icon: string;
|
|
152
|
+
svgIcon: SVGIcon_2;
|
|
153
|
+
data: {
|
|
154
|
+
action: string;
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
reorderRow: {
|
|
158
|
+
name: string;
|
|
159
|
+
text: string;
|
|
160
|
+
icon: string;
|
|
161
|
+
svgIcon: SVGIcon_2;
|
|
162
|
+
items: {
|
|
163
|
+
name: string;
|
|
164
|
+
text: string;
|
|
165
|
+
icon: string;
|
|
166
|
+
svgIcon: SVGIcon_2;
|
|
167
|
+
data: {
|
|
168
|
+
action: string;
|
|
169
|
+
};
|
|
170
|
+
}[];
|
|
171
|
+
};
|
|
172
|
+
exportPDF: {
|
|
173
|
+
name: string;
|
|
174
|
+
text: string;
|
|
175
|
+
icon: string;
|
|
176
|
+
svgIcon: SVGIcon_2;
|
|
177
|
+
data: {
|
|
178
|
+
action: string;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
exportExcel: {
|
|
182
|
+
name: string;
|
|
183
|
+
text: string;
|
|
184
|
+
icon: string;
|
|
185
|
+
svgIcon: SVGIcon_2;
|
|
186
|
+
items: ({
|
|
187
|
+
name: string;
|
|
188
|
+
text: string;
|
|
189
|
+
data: {
|
|
190
|
+
action: string;
|
|
191
|
+
};
|
|
192
|
+
options?: undefined;
|
|
193
|
+
} | {
|
|
194
|
+
name: string;
|
|
195
|
+
text: string;
|
|
196
|
+
data: {
|
|
197
|
+
action: string;
|
|
198
|
+
};
|
|
199
|
+
options: string;
|
|
200
|
+
})[];
|
|
201
|
+
};
|
|
202
|
+
separator: {
|
|
203
|
+
name: string;
|
|
204
|
+
separator: boolean;
|
|
205
|
+
};
|
|
206
|
+
sortAsc: {
|
|
207
|
+
name: string;
|
|
208
|
+
text: string;
|
|
209
|
+
icon: string;
|
|
210
|
+
svgIcon: SVGIcon_2;
|
|
211
|
+
data: {
|
|
212
|
+
action: string;
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
sortDesc: {
|
|
216
|
+
name: string;
|
|
217
|
+
text: string;
|
|
218
|
+
icon: string;
|
|
219
|
+
svgIcon: SVGIcon_2;
|
|
220
|
+
data: {
|
|
221
|
+
action: string;
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
};
|
|
225
|
+
|
|
226
|
+
export { DetailExpandDescriptor }
|
|
227
|
+
|
|
228
|
+
export { EditDescriptor }
|
|
229
|
+
|
|
72
230
|
/**
|
|
73
231
|
* @hidden
|
|
74
232
|
*/
|
|
75
233
|
declare interface ExtendedColumnProps extends GridColumnProps {
|
|
76
234
|
declarationIndex: number;
|
|
77
235
|
parentIndex: number;
|
|
78
|
-
colSpan: number;
|
|
79
236
|
rowSpan: number;
|
|
80
237
|
depth: number;
|
|
238
|
+
colSpan: number;
|
|
81
239
|
kFirst?: boolean;
|
|
82
240
|
index: number;
|
|
241
|
+
headerColSpan: number;
|
|
83
242
|
children: ExtendedColumnProps[];
|
|
84
243
|
left: number;
|
|
85
244
|
right: number;
|
|
86
245
|
rightBorder: boolean;
|
|
87
246
|
ariaColumnIndex: number;
|
|
88
247
|
isAccessible: boolean;
|
|
248
|
+
/** @hidden _internal usage only */
|
|
249
|
+
_type?: 'edit' | 'expand';
|
|
89
250
|
}
|
|
90
251
|
|
|
91
252
|
/**
|
|
@@ -139,7 +300,15 @@ export declare const GRID_PREVENT_SELECTION_ELEMENT = "data-prevent-selection";
|
|
|
139
300
|
/** The attribute required by the Grid selection on Grid `tr` elements. */
|
|
140
301
|
export declare const GRID_ROW_INDEX_ATTRIBUTE = "data-grid-row-index";
|
|
141
302
|
|
|
142
|
-
export declare const GridCell: (props: GridCellProps) => JSX_2.Element
|
|
303
|
+
export declare const GridCell: (props: GridCellProps) => JSX_2.Element;
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Represents the `GridCellBaseOptions` object that are passed to the handler.
|
|
307
|
+
*/
|
|
308
|
+
export declare interface GridCellBaseOptions {
|
|
309
|
+
dataItem?: any;
|
|
310
|
+
field?: string;
|
|
311
|
+
}
|
|
143
312
|
|
|
144
313
|
/**
|
|
145
314
|
* Represents the props of the GridCell component
|
|
@@ -185,6 +354,10 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
185
354
|
syntheticEvent: React.SyntheticEvent<any>;
|
|
186
355
|
field?: string;
|
|
187
356
|
value?: any;
|
|
357
|
+
/** @hidden */
|
|
358
|
+
_expand?: boolean;
|
|
359
|
+
/** @hidden */
|
|
360
|
+
_group?: GroupState;
|
|
188
361
|
}) => void;
|
|
189
362
|
/**
|
|
190
363
|
* The type of the editor which will be used when the cell is in edit mode.
|
|
@@ -206,6 +379,28 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
206
379
|
* @hidden
|
|
207
380
|
*/
|
|
208
381
|
isRtl?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* @hidden
|
|
384
|
+
*/
|
|
385
|
+
unstyled?: GridClassStructure;
|
|
386
|
+
/**
|
|
387
|
+
* @hidden
|
|
388
|
+
*/
|
|
389
|
+
rowDataIndex?: number;
|
|
390
|
+
/**
|
|
391
|
+
* @hidden
|
|
392
|
+
*/
|
|
393
|
+
columnType?: GridColumnType;
|
|
394
|
+
/**
|
|
395
|
+
* @hidden
|
|
396
|
+
*/
|
|
397
|
+
rowReorderable?: boolean;
|
|
398
|
+
/**
|
|
399
|
+
* @hidden
|
|
400
|
+
*/
|
|
401
|
+
columnPosition: any;
|
|
402
|
+
/** @hidden */
|
|
403
|
+
group?: GroupState;
|
|
209
404
|
}
|
|
210
405
|
|
|
211
406
|
/**
|
|
@@ -241,6 +436,20 @@ export declare interface GridCellsSettings {
|
|
|
241
436
|
};
|
|
242
437
|
}
|
|
243
438
|
|
|
439
|
+
/**
|
|
440
|
+
* Represents the properties of the callback used when spanning a column.
|
|
441
|
+
*/
|
|
442
|
+
export declare type GridColSpanProps = {
|
|
443
|
+
/**
|
|
444
|
+
* Represents the properties of the spanned column.
|
|
445
|
+
*/
|
|
446
|
+
column: GridColumnProps;
|
|
447
|
+
/**
|
|
448
|
+
* Represents the current row data item.
|
|
449
|
+
*/
|
|
450
|
+
dataItem: any;
|
|
451
|
+
};
|
|
452
|
+
|
|
244
453
|
/**
|
|
245
454
|
* @hidden
|
|
246
455
|
*/
|
|
@@ -766,13 +975,15 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
766
975
|
/**
|
|
767
976
|
* Allows the column headers to be clicked and the `sortChange` event emitted.
|
|
768
977
|
* You have to handle the `sortChange` event yourself and sort the data.
|
|
769
|
-
*
|
|
978
|
+
*
|
|
979
|
+
* @default true
|
|
770
980
|
*/
|
|
771
981
|
sortable?: boolean | GridColumnSortSettings;
|
|
772
982
|
/**
|
|
773
983
|
* Defines if the column is locked (frozen or sticky).
|
|
774
984
|
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
775
|
-
*
|
|
985
|
+
*
|
|
986
|
+
* @default false
|
|
776
987
|
*/
|
|
777
988
|
locked?: boolean;
|
|
778
989
|
/**
|
|
@@ -784,7 +995,13 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
784
995
|
*/
|
|
785
996
|
columnMenu?: ComponentType<GridColumnMenuProps>;
|
|
786
997
|
/**
|
|
787
|
-
*
|
|
998
|
+
* Specifies the contactMenu settings that will be applied to the column.
|
|
999
|
+
*/
|
|
1000
|
+
contextMenu?: boolean | GridContextMenuOptions | ((options: GridCellBaseOptions) => boolean | GridContextMenuOptions);
|
|
1001
|
+
/**
|
|
1002
|
+
* Determines if the column can be dragged to the group panel.
|
|
1003
|
+
*
|
|
1004
|
+
* @default true
|
|
788
1005
|
*/
|
|
789
1006
|
groupable?: boolean;
|
|
790
1007
|
/**
|
|
@@ -792,7 +1009,9 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
792
1009
|
*/
|
|
793
1010
|
editable?: boolean;
|
|
794
1011
|
/**
|
|
795
|
-
* Defines if a filter UI will be rendered for this column.
|
|
1012
|
+
* Defines if a filter UI will be rendered for this column.
|
|
1013
|
+
*
|
|
1014
|
+
* @default true
|
|
796
1015
|
*/
|
|
797
1016
|
filterable?: boolean;
|
|
798
1017
|
/**
|
|
@@ -800,19 +1019,32 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
800
1019
|
*/
|
|
801
1020
|
filterTitle?: string;
|
|
802
1021
|
/**
|
|
803
|
-
* Defines the filter type that will be rendered inside the filter row.
|
|
1022
|
+
* Defines the filter type that will be rendered inside the filter row.
|
|
1023
|
+
*
|
|
1024
|
+
* @default 'text'
|
|
804
1025
|
*/
|
|
805
|
-
filter?:
|
|
1026
|
+
filter?: GridDataType;
|
|
806
1027
|
/**
|
|
807
|
-
* Defines the editor type. Used when the column enters the edit mode ([more information and examples]({% slug editing_inline_grid %})).
|
|
1028
|
+
* Defines the editor type. Used when the column enters the edit mode ([more information and examples]({% slug editing_inline_grid %})).
|
|
1029
|
+
*
|
|
1030
|
+
* @default 'text'
|
|
808
1031
|
*/
|
|
809
|
-
editor?:
|
|
1032
|
+
editor?: GridDataType;
|
|
810
1033
|
/**
|
|
811
1034
|
* Overrides the default(three vertical dots) column menu icon or the icon set through the ([`columnMenuIcon`]({% slug api_grid_gridprops %}#toc-columnmenuicon)) property.
|
|
812
1035
|
*/
|
|
813
1036
|
menuIcon?: SVGIcon;
|
|
814
1037
|
/**
|
|
815
|
-
*
|
|
1038
|
+
* Sets the colSpan of the column which will make the row content to span over multiple cells.
|
|
1039
|
+
* As arguments it takes either a number or a function that returns a number based on.
|
|
1040
|
+
*
|
|
1041
|
+
* @default 1
|
|
1042
|
+
*/
|
|
1043
|
+
colSpan?: number | ((colSpanProps: GridColSpanProps) => number);
|
|
1044
|
+
/**
|
|
1045
|
+
* Controls the visibility of Grid's column.
|
|
1046
|
+
*
|
|
1047
|
+
* @default false
|
|
816
1048
|
*/
|
|
817
1049
|
hidden?: boolean;
|
|
818
1050
|
/**
|
|
@@ -849,6 +1081,12 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
849
1081
|
* ```
|
|
850
1082
|
*/
|
|
851
1083
|
footerCell?: ComponentType<GridFooterCellProps>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Sets the type of the column and renders a dedicated column for interaction.
|
|
1086
|
+
*
|
|
1087
|
+
* @default "data"
|
|
1088
|
+
*/
|
|
1089
|
+
columnType?: GridColumnType;
|
|
852
1090
|
}
|
|
853
1091
|
|
|
854
1092
|
/**
|
|
@@ -922,6 +1160,13 @@ export declare interface GridColumnResizeEvent {
|
|
|
922
1160
|
declare interface GridColumnSortSettings extends ColumnSortSettings {
|
|
923
1161
|
}
|
|
924
1162
|
|
|
1163
|
+
/**
|
|
1164
|
+
* Sets the column type.
|
|
1165
|
+
*
|
|
1166
|
+
* @default "data"
|
|
1167
|
+
*/
|
|
1168
|
+
export declare type GridColumnType = 'data' | 'reorder' | 'select';
|
|
1169
|
+
|
|
925
1170
|
/**
|
|
926
1171
|
* @hidden
|
|
927
1172
|
*/
|
|
@@ -957,6 +1202,23 @@ export declare class GridCommonDragLogic {
|
|
|
957
1202
|
private updateDropElementClue;
|
|
958
1203
|
}
|
|
959
1204
|
|
|
1205
|
+
/**
|
|
1206
|
+
* @hidden
|
|
1207
|
+
*/
|
|
1208
|
+
export declare const GridContextMenu: (props: GridContextMenuProps) => JSX_2.Element;
|
|
1209
|
+
|
|
1210
|
+
/**
|
|
1211
|
+
* Represents the available types for the `GridContextMenuAnchorPart`.
|
|
1212
|
+
*
|
|
1213
|
+
* The available anchor parts are:
|
|
1214
|
+
* - `head`
|
|
1215
|
+
* - `body`
|
|
1216
|
+
*/
|
|
1217
|
+
export declare enum GridContextMenuAnchorPart {
|
|
1218
|
+
head = "head",
|
|
1219
|
+
body = "body"
|
|
1220
|
+
}
|
|
1221
|
+
|
|
960
1222
|
/**
|
|
961
1223
|
* Represents the object of the `onContextMenu` Grid event.
|
|
962
1224
|
*/
|
|
@@ -975,6 +1237,85 @@ export declare interface GridContextMenuEvent extends GridEvent {
|
|
|
975
1237
|
syntheticEvent: React.MouseEvent<any>;
|
|
976
1238
|
}
|
|
977
1239
|
|
|
1240
|
+
/**
|
|
1241
|
+
* Represents the object of the `onContextMenuItemClick` Grid event.
|
|
1242
|
+
*/
|
|
1243
|
+
export declare interface GridContextMenuItemClickEvent extends GridEvent {
|
|
1244
|
+
/**
|
|
1245
|
+
* The Context menu item click event.
|
|
1246
|
+
*/
|
|
1247
|
+
event: MenuSelectEvent;
|
|
1248
|
+
/**
|
|
1249
|
+
* The data object that represents the current row.
|
|
1250
|
+
*/
|
|
1251
|
+
dataItem?: any;
|
|
1252
|
+
/**
|
|
1253
|
+
* The data object that represents the clicked menu item.
|
|
1254
|
+
*/
|
|
1255
|
+
menuItem: any;
|
|
1256
|
+
/**
|
|
1257
|
+
* The field to which the cell is bound.
|
|
1258
|
+
*/
|
|
1259
|
+
field?: string;
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
/**
|
|
1263
|
+
* Represents the available predefined items names for the `GridContextMenu` items.
|
|
1264
|
+
*/
|
|
1265
|
+
export declare enum GridContextMenuItemNames {
|
|
1266
|
+
create = "create",
|
|
1267
|
+
edit = "edit",
|
|
1268
|
+
delete = "delete",
|
|
1269
|
+
select = "select",
|
|
1270
|
+
copySelection = "copySelection",
|
|
1271
|
+
copySelectionNoHeaders = "copySelectionNoHeaders",
|
|
1272
|
+
paste = "paste",
|
|
1273
|
+
reorderRow = "reorderRow",
|
|
1274
|
+
exportPDF = "exportPDF",
|
|
1275
|
+
exportExcel = "exportExcel",
|
|
1276
|
+
separator = "separator",
|
|
1277
|
+
sortAsc = "sortAsc",
|
|
1278
|
+
sortDesc = "sortDesc"
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
/**
|
|
1282
|
+
* @hidden
|
|
1283
|
+
*/
|
|
1284
|
+
export declare interface GridContextMenuOpenArgs extends GridCellBaseOptions {
|
|
1285
|
+
event: React_2.MouseEvent<HTMLElement, MouseEvent>;
|
|
1286
|
+
}
|
|
1287
|
+
|
|
1288
|
+
/**
|
|
1289
|
+
* Represents the `GridContextMenuOptions`.
|
|
1290
|
+
*/
|
|
1291
|
+
export declare interface GridContextMenuOptions {
|
|
1292
|
+
/**
|
|
1293
|
+
* The contextmenu settings for the head of the data table.
|
|
1294
|
+
*/
|
|
1295
|
+
head?: boolean | (GridContextMenuItemNames | MenuItemModel)[];
|
|
1296
|
+
/**
|
|
1297
|
+
* The contextmenu settings for the body of the data table.
|
|
1298
|
+
*/
|
|
1299
|
+
body?: boolean | (GridContextMenuItemNames | MenuItemModel)[];
|
|
1300
|
+
}
|
|
1301
|
+
|
|
1302
|
+
/**
|
|
1303
|
+
* @hidden
|
|
1304
|
+
*/
|
|
1305
|
+
export declare interface GridContextMenuProps {
|
|
1306
|
+
show: boolean;
|
|
1307
|
+
offset: Offset;
|
|
1308
|
+
onClose: (event: React_2.SyntheticEvent<HTMLElement>) => void;
|
|
1309
|
+
onSelect: (e: {
|
|
1310
|
+
event: MenuSelectEvent;
|
|
1311
|
+
dataItem?: any;
|
|
1312
|
+
field?: string;
|
|
1313
|
+
}) => void;
|
|
1314
|
+
dataItem?: any;
|
|
1315
|
+
field?: string;
|
|
1316
|
+
items?: (GridContextMenuItemNames | MenuItemModel)[];
|
|
1317
|
+
}
|
|
1318
|
+
|
|
978
1319
|
/**
|
|
979
1320
|
* The properties of the default Grid Cell.
|
|
980
1321
|
*/
|
|
@@ -1059,6 +1400,17 @@ export declare interface GridDataStateChangeEvent extends GridEvent {
|
|
|
1059
1400
|
targetEvent?: PagerTargetEvent;
|
|
1060
1401
|
}
|
|
1061
1402
|
|
|
1403
|
+
/**
|
|
1404
|
+
* Exposes the data types available when setting the [filter](slug:api_grid_gridcolumnprops#toc-filter) or
|
|
1405
|
+
* [editor](slug:api_grid_gridcolumnprops#toc-editor) property of the Grid columns.
|
|
1406
|
+
*/
|
|
1407
|
+
export declare type GridDataType = 'text' | 'numeric' | 'boolean' | 'date';
|
|
1408
|
+
|
|
1409
|
+
/** @hidden */
|
|
1410
|
+
export declare interface GridDetailExpandChangeEvent extends GridEvent {
|
|
1411
|
+
detailExpand: DetailExpandDescriptor;
|
|
1412
|
+
}
|
|
1413
|
+
|
|
1062
1414
|
/**
|
|
1063
1415
|
* Represents the detail row class of the KendoReact Grid. Used to define custom details for each row. Can be applied for building the hierarchy. If `expandField` is set, the details for each row will be visible or hidden depending on the current data item and its `expandField` value.
|
|
1064
1416
|
*
|
|
@@ -1112,9 +1464,23 @@ export declare interface GridDragSelectionReleaseEvent extends TableDragSelectio
|
|
|
1112
1464
|
}
|
|
1113
1465
|
|
|
1114
1466
|
/**
|
|
1467
|
+
* TODO: uncomment
|
|
1468
|
+
* Represents the Grid editable settings.
|
|
1469
|
+
*
|
|
1115
1470
|
* @hidden
|
|
1116
1471
|
*/
|
|
1117
|
-
|
|
1472
|
+
declare interface GridEditableSettings extends TableEditableSettings {
|
|
1473
|
+
}
|
|
1474
|
+
|
|
1475
|
+
/**
|
|
1476
|
+
* @hidden
|
|
1477
|
+
*/
|
|
1478
|
+
export declare const GridEditCell: (props: GridCellProps) => JSX_2.Element;
|
|
1479
|
+
|
|
1480
|
+
/** @hidden TODO: document */
|
|
1481
|
+
export declare interface GridEditChangeEvent extends GridEvent {
|
|
1482
|
+
edit: EditDescriptor;
|
|
1483
|
+
}
|
|
1118
1484
|
|
|
1119
1485
|
/**
|
|
1120
1486
|
* Represents the base event object of the Grid.
|
|
@@ -1131,7 +1497,7 @@ export declare interface GridExpandChangeEvent extends GridEvent {
|
|
|
1131
1497
|
*/
|
|
1132
1498
|
dataItem: any;
|
|
1133
1499
|
/**
|
|
1134
|
-
*
|
|
1500
|
+
* Indicates whether the data item is expanded or collapsed
|
|
1135
1501
|
*/
|
|
1136
1502
|
value: boolean;
|
|
1137
1503
|
/**
|
|
@@ -1306,12 +1672,14 @@ export declare interface GridGroupableSettings {
|
|
|
1306
1672
|
* Determines if the group footer row is visible when the group is collapsed. Defaults to `none`.
|
|
1307
1673
|
*/
|
|
1308
1674
|
footer?: 'always' | 'visible' | 'none';
|
|
1675
|
+
/** @hidden */
|
|
1676
|
+
expandable?: boolean | GridGroupExpandableSettings;
|
|
1309
1677
|
}
|
|
1310
1678
|
|
|
1311
1679
|
/**
|
|
1312
1680
|
* @hidden
|
|
1313
1681
|
*/
|
|
1314
|
-
export declare const GridGroupCell: (props: GridCellProps) => JSX_2.Element
|
|
1682
|
+
export declare const GridGroupCell: (props: GridCellProps) => JSX_2.Element;
|
|
1315
1683
|
|
|
1316
1684
|
/**
|
|
1317
1685
|
* Represents the object of the `onGroupChange` Grid event.
|
|
@@ -1323,6 +1691,14 @@ export declare interface GridGroupChangeEvent extends GridEvent {
|
|
|
1323
1691
|
group: GroupDescriptor[];
|
|
1324
1692
|
}
|
|
1325
1693
|
|
|
1694
|
+
/** @hidden */
|
|
1695
|
+
declare type GridGroupExpandableSettings = TableGroupExpandableSettings;
|
|
1696
|
+
|
|
1697
|
+
/** @hidden */
|
|
1698
|
+
export declare interface GridGroupExpandChangeEvent extends GridEvent {
|
|
1699
|
+
groupExpand: GroupExpandDescriptor[];
|
|
1700
|
+
}
|
|
1701
|
+
|
|
1326
1702
|
/**
|
|
1327
1703
|
* Represent the `ref` of the Grid component.
|
|
1328
1704
|
*/
|
|
@@ -1442,6 +1818,13 @@ export declare interface GridHeaderCellProps extends Omit<HeaderCellBaseProps, '
|
|
|
1442
1818
|
* Represents the object of the `onHeaderSelectionChange` Grid event.
|
|
1443
1819
|
*/
|
|
1444
1820
|
export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
1821
|
+
/**
|
|
1822
|
+
* TODO: uncomment
|
|
1823
|
+
* The new [SelectDescriptor]({% slug api_kendo-react-grid_selectdescriptor %}) based on the user action.
|
|
1824
|
+
*
|
|
1825
|
+
* @hidden
|
|
1826
|
+
*/
|
|
1827
|
+
select: SelectDescriptor;
|
|
1445
1828
|
/**
|
|
1446
1829
|
* The field of the column in which the cell is located.
|
|
1447
1830
|
*/
|
|
@@ -1459,7 +1842,7 @@ export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
|
1459
1842
|
/**
|
|
1460
1843
|
* @hidden
|
|
1461
1844
|
*/
|
|
1462
|
-
export declare const GridHierarchyCell: (props: GridCellProps) => JSX_2.Element
|
|
1845
|
+
export declare const GridHierarchyCell: (props: GridCellProps) => JSX_2.Element;
|
|
1463
1846
|
|
|
1464
1847
|
/**
|
|
1465
1848
|
* Represents the object of the `onItemChange` Grid event.
|
|
@@ -1528,6 +1911,7 @@ export declare const gridMessages: {
|
|
|
1528
1911
|
"grid.filterAriaLabel": string;
|
|
1529
1912
|
"grid.groupPanelAriaLabel": string;
|
|
1530
1913
|
"grid.gridAriaLabel": string;
|
|
1914
|
+
"grid.gridRowReorderAriaLabel": string;
|
|
1531
1915
|
"grid.selectRow": string;
|
|
1532
1916
|
'grid.filterEqOperator': string;
|
|
1533
1917
|
'grid.filterNotEqOperator': string;
|
|
@@ -1678,6 +2062,13 @@ declare type GridPagerType = 'numeric' | 'input';
|
|
|
1678
2062
|
* Represents the props of the [KendoReact Grid component]({% slug overview_grid %}).
|
|
1679
2063
|
*/
|
|
1680
2064
|
export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
2065
|
+
/** @hidden */
|
|
2066
|
+
autoProcessData?: boolean | {
|
|
2067
|
+
filter?: boolean;
|
|
2068
|
+
sort?: boolean;
|
|
2069
|
+
group?: boolean;
|
|
2070
|
+
page?: boolean;
|
|
2071
|
+
};
|
|
1681
2072
|
/**
|
|
1682
2073
|
* Sets the Grid row key prop to the value of this field in the dataItem.
|
|
1683
2074
|
* If not set, the dataItem index will be used for the row key, which might lead to row not updated during paging or scrolling.
|
|
@@ -1704,7 +2095,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1704
2095
|
*/
|
|
1705
2096
|
clipboard?: ClipboardSettings | boolean;
|
|
1706
2097
|
/**
|
|
1707
|
-
* Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [ClipboardDataEvent]({% slug api_data-tools_clipboarddataevent %}).
|
|
2098
|
+
* Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [ClipboardDataEvent]({% slug api_data-tools_clipboarddataevent %}). Only fired when the Grid is run as a client component.
|
|
1708
2099
|
*/
|
|
1709
2100
|
onClipboard?: (event: ClipboardDataEvent) => void;
|
|
1710
2101
|
/**
|
|
@@ -1715,6 +2106,8 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1715
2106
|
* The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
|
|
1716
2107
|
*/
|
|
1717
2108
|
sort?: SortDescriptor[];
|
|
2109
|
+
/** @hidden */
|
|
2110
|
+
defaultSort?: SortDescriptor[];
|
|
1718
2111
|
/**
|
|
1719
2112
|
* Enables the filtering of the columns with their `field` option set ([more information and examples]({% slug filtering_grid %})).
|
|
1720
2113
|
*/
|
|
@@ -1723,6 +2116,8 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1723
2116
|
* The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
|
|
1724
2117
|
*/
|
|
1725
2118
|
filter?: CompositeFilterDescriptor;
|
|
2119
|
+
/** @hidden */
|
|
2120
|
+
defaultFilter?: CompositeFilterDescriptor;
|
|
1726
2121
|
/**
|
|
1727
2122
|
* The filter operators for the Grid filters.
|
|
1728
2123
|
*/
|
|
@@ -1731,10 +2126,18 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1731
2126
|
* Fires when the Grid filter is modified through the UI ([more information and examples]({% slug filtering_grid %})). You have to handle the event yourself and filter the data.
|
|
1732
2127
|
*/
|
|
1733
2128
|
onFilterChange?: (event: GridFilterChangeEvent) => void;
|
|
2129
|
+
/**
|
|
2130
|
+
* Fires when the user reorders a row.
|
|
2131
|
+
*/
|
|
2132
|
+
onRowReorder?: (event: GridRowReorderEvent) => void;
|
|
1734
2133
|
/**
|
|
1735
2134
|
* Specifies a React element that will be cloned and rendered inside the column menu of the Grid. Can be overridden on column level.
|
|
1736
2135
|
*/
|
|
1737
2136
|
columnMenu?: null | ComponentType<GridColumnMenuProps>;
|
|
2137
|
+
/**
|
|
2138
|
+
* Specifies the contactMenu settings that will be applied to the Grid.
|
|
2139
|
+
*/
|
|
2140
|
+
contextMenu?: boolean | GridContextMenuOptions | ((options: GridCellBaseOptions) => boolean | GridContextMenuOptions);
|
|
1738
2141
|
/**
|
|
1739
2142
|
* Globally overrides the default(three vertical dots) column menu icon for the whole Grid. If set, the prop can be overridden on column level using the ([menuIcon]({% slug api_grid_gridcolumnprops %}#toc-menuicon)) property.
|
|
1740
2143
|
*/
|
|
@@ -1744,6 +2147,8 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1744
2147
|
* ([more information and examples]({% slug groupingbasics_grid %})).
|
|
1745
2148
|
*/
|
|
1746
2149
|
group?: GroupDescriptor[];
|
|
2150
|
+
/** @hidden */
|
|
2151
|
+
defaultGroup?: GroupDescriptor[];
|
|
1747
2152
|
/**
|
|
1748
2153
|
* Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
|
|
1749
2154
|
* ([more information and examples]({% slug groupingbasics_grid %})).
|
|
@@ -1773,6 +2178,8 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1773
2178
|
* Alias of `pageSize` property. If `take` is set, `pageSize` will be ignored.
|
|
1774
2179
|
*/
|
|
1775
2180
|
take?: number;
|
|
2181
|
+
/** @hidden */
|
|
2182
|
+
defaultTake?: number;
|
|
1776
2183
|
/**
|
|
1777
2184
|
* Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})). You have to handle the event yourself and page the data.
|
|
1778
2185
|
*/
|
|
@@ -1785,10 +2192,25 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1785
2192
|
* Defines the number of records that will be skipped by the pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
|
|
1786
2193
|
*/
|
|
1787
2194
|
skip?: number;
|
|
2195
|
+
/** @hidden */
|
|
2196
|
+
defaultSkip?: number;
|
|
1788
2197
|
/**
|
|
1789
2198
|
* Determines if the scroll position will be updated after data change. If set to `true` the scroll will remain on the same position.
|
|
1790
2199
|
*/
|
|
1791
2200
|
fixedScroll?: boolean;
|
|
2201
|
+
/** @hidden */
|
|
2202
|
+
detailExpand?: DetailExpandDescriptor;
|
|
2203
|
+
/** @hidden */
|
|
2204
|
+
defaultDetailExpand?: DetailExpandDescriptor;
|
|
2205
|
+
/** @hidden */
|
|
2206
|
+
/** @hidden */
|
|
2207
|
+
onDetailExpandChange?: (event: GridDetailExpandChangeEvent) => void;
|
|
2208
|
+
/** @hidden */
|
|
2209
|
+
groupExpand?: GroupExpandDescriptor[];
|
|
2210
|
+
/** @hidden */
|
|
2211
|
+
defaultGroupExpand?: GroupExpandDescriptor[];
|
|
2212
|
+
/** @hidden */
|
|
2213
|
+
onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
|
|
1792
2214
|
/**
|
|
1793
2215
|
* Fires when the user tries to expand or collapse a row.
|
|
1794
2216
|
*/
|
|
@@ -1797,6 +2219,10 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1797
2219
|
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
|
|
1798
2220
|
*/
|
|
1799
2221
|
expandField?: string;
|
|
2222
|
+
/** @hidden */
|
|
2223
|
+
select?: SelectDescriptor;
|
|
2224
|
+
/** @hidden */
|
|
2225
|
+
defaultSelect?: SelectDescriptor;
|
|
1800
2226
|
/**
|
|
1801
2227
|
* The Grid selectable settings.
|
|
1802
2228
|
*/
|
|
@@ -1827,6 +2253,14 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1827
2253
|
* Fires when the user changes the values of the item. The event is not debounced and fires on every `onChange` event of the input in the current `EditCell` ([more information and examples]({% slug editing_inline_grid %})).
|
|
1828
2254
|
*/
|
|
1829
2255
|
onItemChange?: (event: GridItemChangeEvent) => void;
|
|
2256
|
+
/** @hidden */
|
|
2257
|
+
edit?: EditDescriptor;
|
|
2258
|
+
/** @hidden */
|
|
2259
|
+
defaultEdit?: EditDescriptor;
|
|
2260
|
+
/** @hidden */
|
|
2261
|
+
editable?: boolean | GridEditableSettings;
|
|
2262
|
+
/** @hidden */
|
|
2263
|
+
onEditChange?: (event: GridEditChangeEvent) => void;
|
|
1830
2264
|
/**
|
|
1831
2265
|
* Specifies the name of the field which will provide a Boolean representation of the edit state of the current item ([more information and examples]({% slug editing_inline_grid %})).
|
|
1832
2266
|
*/
|
|
@@ -1868,12 +2302,18 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1868
2302
|
* If set to `true`, the user can reorder columns by dragging their header cells ([see example]({% slug reordering_columns_grid %})).
|
|
1869
2303
|
*/
|
|
1870
2304
|
reorderable?: boolean;
|
|
2305
|
+
/**
|
|
2306
|
+
* Defines the row reorder settings.
|
|
2307
|
+
*
|
|
2308
|
+
* @default false
|
|
2309
|
+
*/
|
|
2310
|
+
rowReorderable?: boolean | GridRowReorderSettings;
|
|
1871
2311
|
/**
|
|
1872
2312
|
* Determines if grouping by dragging and dropping the column headers is allowed ([more information and examples]({% slug groupingbasics_grid %})).
|
|
1873
2313
|
*/
|
|
1874
2314
|
groupable?: GridGroupableSettings | boolean;
|
|
1875
2315
|
/**
|
|
1876
|
-
* Fires when a column is resized.
|
|
2316
|
+
* Fires when a column is resized. Only fired when the Grid is run as a client component.
|
|
1877
2317
|
*/
|
|
1878
2318
|
onColumnResize?: (event: GridColumnResizeEvent) => void;
|
|
1879
2319
|
/**
|
|
@@ -1897,7 +2337,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1897
2337
|
*/
|
|
1898
2338
|
headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
1899
2339
|
/**
|
|
1900
|
-
* Fires when Grid is scrolled.
|
|
2340
|
+
* Fires when Grid is scrolled. Only fired when the Grid is run as a client component.
|
|
1901
2341
|
*/
|
|
1902
2342
|
onScroll?: (event: GridEvent) => void;
|
|
1903
2343
|
/**
|
|
@@ -1910,11 +2350,11 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1910
2350
|
*/
|
|
1911
2351
|
navigatable?: boolean | NavigatableSettings;
|
|
1912
2352
|
/**
|
|
1913
|
-
* Fires when Grid keyboard navigation position is changed.
|
|
2353
|
+
* Fires when Grid keyboard navigation position is changed. Only fired when the Grid is run as a client component.
|
|
1914
2354
|
*/
|
|
1915
2355
|
onNavigationAction?: (event: GridNavigationActionEvent) => void;
|
|
1916
2356
|
/**
|
|
1917
|
-
* Fires when the user press keyboard key.
|
|
2357
|
+
* Fires when the user press keyboard key. Only fired when the Grid is run as a client component.
|
|
1918
2358
|
*/
|
|
1919
2359
|
onKeyDown?: (event: GridKeyDownEvent) => void;
|
|
1920
2360
|
/**
|
|
@@ -1943,9 +2383,13 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1943
2383
|
*/
|
|
1944
2384
|
size?: 'small' | 'medium';
|
|
1945
2385
|
/**
|
|
1946
|
-
* The event that is fired when the ContextMenu is activated.
|
|
2386
|
+
* The event that is fired when the ContextMenu is activated. Only fired when the Grid is run as a client component.
|
|
1947
2387
|
*/
|
|
1948
2388
|
onContextMenu?: (event: GridContextMenuEvent) => void;
|
|
2389
|
+
/**
|
|
2390
|
+
* The event that is fired when the ContextMenu item is clicked. Only fired when the Grid is run as a client component.
|
|
2391
|
+
*/
|
|
2392
|
+
onContextMenuItemClick?: (event: GridContextMenuItemClickEvent) => void;
|
|
1949
2393
|
/**
|
|
1950
2394
|
* Sets the `id` property of the top div element of the component.
|
|
1951
2395
|
*/
|
|
@@ -1956,6 +2400,11 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
1956
2400
|
unstyled?: GridClassStructure;
|
|
1957
2401
|
}
|
|
1958
2402
|
|
|
2403
|
+
/**
|
|
2404
|
+
* The direction in which a row can be dragged and dropped.
|
|
2405
|
+
*/
|
|
2406
|
+
export declare type GridReorderDropPosition = 'before' | 'after' | 'forbidden';
|
|
2407
|
+
|
|
1959
2408
|
/**
|
|
1960
2409
|
* The component for each of the items in the `data` property which the Grid renders.
|
|
1961
2410
|
*/
|
|
@@ -2041,8 +2490,61 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
2041
2490
|
* @hidden
|
|
2042
2491
|
*/
|
|
2043
2492
|
absoluteRowIndex: number;
|
|
2493
|
+
/**
|
|
2494
|
+
* @hidden
|
|
2495
|
+
*/
|
|
2496
|
+
isRowReorderable?: boolean;
|
|
2497
|
+
}
|
|
2498
|
+
|
|
2499
|
+
/**
|
|
2500
|
+
* Represents the object of the `onReorderRow` Grid event.
|
|
2501
|
+
*/
|
|
2502
|
+
export declare interface GridRowReorderEvent extends Omit<GridEvent, 'syntheticEvent'> {
|
|
2503
|
+
/**
|
|
2504
|
+
* Represents the currently dragged row.
|
|
2505
|
+
*/
|
|
2506
|
+
draggedDataItems: any[];
|
|
2507
|
+
/**
|
|
2508
|
+
* Represents the row over which the dragged row is dropped.
|
|
2509
|
+
*/
|
|
2510
|
+
droppedDataItem: any;
|
|
2511
|
+
/**
|
|
2512
|
+
* The exact dragged row position relative to the position of the drop target row..
|
|
2513
|
+
*/
|
|
2514
|
+
dropPosition: GridReorderDropPosition;
|
|
2515
|
+
/**
|
|
2516
|
+
* A native DOM event.
|
|
2517
|
+
*/
|
|
2518
|
+
nativeEvent: PointerEvent | MouseEvent | TouchEvent | Event;
|
|
2519
|
+
/**
|
|
2520
|
+
* Represents a unified drag event that is triggered regardless if the native event underneath is a pointer, mouse, touch, or scroll event.
|
|
2521
|
+
*/
|
|
2522
|
+
dragEvent: NormalizedDragEvent;
|
|
2523
|
+
/**
|
|
2524
|
+
* The reference of the Grid in which the row is dropped.
|
|
2525
|
+
*/
|
|
2526
|
+
target: GridHandle;
|
|
2044
2527
|
}
|
|
2045
2528
|
|
|
2529
|
+
/**
|
|
2530
|
+
* Represents the settings for the row reordering functionality of the Grid.
|
|
2531
|
+
*/
|
|
2532
|
+
export declare type GridRowReorderSettings = {
|
|
2533
|
+
/**
|
|
2534
|
+
* Determines if the row reordering functionality is enabled.
|
|
2535
|
+
*
|
|
2536
|
+
* @default false
|
|
2537
|
+
*/
|
|
2538
|
+
enabled?: boolean;
|
|
2539
|
+
/**
|
|
2540
|
+
* Determines what the text of the drag clue will be.
|
|
2541
|
+
* Can also be a function giving the dataItem as an argument and returning a new custom drag clue as a ReactNode.
|
|
2542
|
+
*
|
|
2543
|
+
* Default value will be the text of the first visible data column of the row.
|
|
2544
|
+
*/
|
|
2545
|
+
dragClue?: string | ((dataItem: any) => React.ReactNode);
|
|
2546
|
+
};
|
|
2547
|
+
|
|
2046
2548
|
/**
|
|
2047
2549
|
* The type of the GridRow component.
|
|
2048
2550
|
*
|
|
@@ -2075,12 +2577,19 @@ export declare interface GridSelectableSettings extends TableSelectableSettings
|
|
|
2075
2577
|
/**
|
|
2076
2578
|
* @hidden
|
|
2077
2579
|
*/
|
|
2078
|
-
export declare const GridSelectionCell: (props: GridCellProps) => JSX_2.Element
|
|
2580
|
+
export declare const GridSelectionCell: (props: GridCellProps) => JSX_2.Element;
|
|
2079
2581
|
|
|
2080
2582
|
/**
|
|
2081
2583
|
* Represents the object of the `onSelectionChange` Grid event.
|
|
2082
2584
|
*/
|
|
2083
2585
|
export declare interface GridSelectionChangeEvent extends GridEvent, TableSelectionChangeEvent<GridHandle> {
|
|
2586
|
+
/**
|
|
2587
|
+
* TODO: uncomment
|
|
2588
|
+
* The new [SelectDescriptor]({% slug api_kendo-data-tools_selectdescriptor %}) based on the user action.
|
|
2589
|
+
*
|
|
2590
|
+
* @hidden
|
|
2591
|
+
*/
|
|
2592
|
+
select?: SelectDescriptor;
|
|
2084
2593
|
/**
|
|
2085
2594
|
* The dataItem from which the selection starts(Valid for scenarios without checkbox selection).
|
|
2086
2595
|
*/
|
|
@@ -2195,6 +2704,8 @@ export declare interface GridToolbarProps {
|
|
|
2195
2704
|
ariaControls?: string;
|
|
2196
2705
|
}
|
|
2197
2706
|
|
|
2707
|
+
export { GroupExpandDescriptor }
|
|
2708
|
+
|
|
2198
2709
|
/**
|
|
2199
2710
|
* @hidden
|
|
2200
2711
|
*/
|
|
@@ -2271,6 +2782,13 @@ export declare const rootFilterOrDefault: (rootFilter: CompositeFilterDescriptor
|
|
|
2271
2782
|
|
|
2272
2783
|
declare type ScrollMode = 'none' | 'scrollable' | 'virtual';
|
|
2273
2784
|
|
|
2785
|
+
export { SelectDescriptor }
|
|
2786
|
+
|
|
2787
|
+
/**
|
|
2788
|
+
* Represents a server counterpart of every Grid event. It strips out all arguments from the event that are not serializable to the server.
|
|
2789
|
+
*/
|
|
2790
|
+
export declare type ServerEvent<T> = Omit<T, 'nativeEvent' | 'syntheticEvent' | 'target' | 'targetEvent'>;
|
|
2791
|
+
|
|
2274
2792
|
export { setSelectedState }
|
|
2275
2793
|
|
|
2276
2794
|
/**
|
|
@@ -2288,8 +2806,9 @@ export declare interface StatusBarProps {
|
|
|
2288
2806
|
/**
|
|
2289
2807
|
* Represents the arguments of the getStatusData function.
|
|
2290
2808
|
*/
|
|
2291
|
-
export declare
|
|
2292
|
-
|
|
2809
|
+
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 'selectedField'> | (Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 'select'> & {
|
|
2810
|
+
dataItemKey: Required<GridProps>['dataItemKey'];
|
|
2811
|
+
});
|
|
2293
2812
|
|
|
2294
2813
|
/**
|
|
2295
2814
|
* Represents the KendoReact Grid's StatusItem object.
|