@progress/kendo-react-grid 9.4.0-develop.9 → 9.4.1-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/GridClientWrapper.js +1 -1
- package/GridClientWrapper.mjs +463 -374
- package/GridComponent.js +1 -1
- package/GridComponent.mjs +337 -307
- package/GridSearchBox.js +8 -0
- package/GridSearchBox.mjs +35 -0
- package/GridState.js +1 -1
- package/GridState.mjs +79 -67
- package/NOTICE.txt +40 -51
- package/cells/GridCell.js +1 -1
- package/cells/GridCell.mjs +24 -20
- package/cells/client/GridRowReorderContainer.js +1 -1
- package/cells/client/GridRowReorderContainer.mjs +15 -9
- package/columnMenu/GridColumnMenuCheckboxFilter.js +1 -1
- package/columnMenu/GridColumnMenuCheckboxFilter.mjs +56 -55
- package/columnMenu/GridColumnMenuColumnsChooser.js +9 -0
- package/columnMenu/GridColumnMenuColumnsChooser.mjs +82 -0
- package/columnMenu/GridColumnMenuFilter.js +1 -1
- package/columnMenu/GridColumnMenuFilter.mjs +19 -19
- package/columnMenu/GridColumnMenuSort.js +1 -1
- package/columnMenu/GridColumnMenuSort.mjs +1 -1
- package/components/noRecords/GridNoRecords.js +1 -1
- package/components/noRecords/GridNoRecords.mjs +8 -7
- package/dist/cdn/js/kendo-react-grid.js +1 -1
- package/header/client/GridHeaderCellContainer.js +1 -1
- package/header/client/GridHeaderCellContainer.mjs +20 -18
- package/index.d.mts +289 -48
- package/index.d.ts +289 -48
- package/index.js +1 -1
- package/index.mjs +76 -72
- package/messages/index.js +1 -1
- package/messages/index.mjs +38 -36
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +14 -14
- package/rows/GridRow.js +1 -1
- package/rows/GridRow.mjs +45 -45
- package/utils/index.js +1 -1
- package/utils/index.mjs +156 -146
- /package/{interfaces/GridSortSettings.js → sortCommon.js} +0 -0
- /package/{interfaces/GridSortSettings.mjs → sortCommon.mjs} +0 -0
package/index.d.mts
CHANGED
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { BaseEvent } from '@progress/kendo-react-common';
|
|
9
9
|
import { CellProps } from '@progress/kendo-react-data-tools';
|
|
10
|
-
import { ClipboardDataEvent } from '@progress/kendo-react-data-tools';
|
|
11
10
|
import { ClipboardSettings } from '@progress/kendo-react-data-tools';
|
|
12
11
|
import { ColumnBaseProps } from '@progress/kendo-react-data-tools';
|
|
13
12
|
import { ColumnSortSettings } from '@progress/kendo-react-data-tools';
|
|
@@ -22,6 +21,7 @@ import { FilterOperator } from '@progress/kendo-react-data-tools';
|
|
|
22
21
|
import { getSelectedState } from '@progress/kendo-react-data-tools';
|
|
23
22
|
import { getSelectedStateFromKeyDown } from '@progress/kendo-react-data-tools';
|
|
24
23
|
import { GridClassStructure } from '@progress/kendo-react-common';
|
|
24
|
+
import { GridClipboardEvent } from '@progress/kendo-react-data-tools';
|
|
25
25
|
import { GroupDescriptor } from '@progress/kendo-data-query';
|
|
26
26
|
import { GroupExpandDescriptor } from '@progress/kendo-react-data-tools';
|
|
27
27
|
import { GroupState } from '@progress/kendo-react-data-tools';
|
|
@@ -40,6 +40,7 @@ import { PagerProps } from '@progress/kendo-react-data-tools';
|
|
|
40
40
|
import { PagerTargetEvent } from '@progress/kendo-react-data-tools';
|
|
41
41
|
import * as React_2 from 'react';
|
|
42
42
|
import { ReactElement } from 'react';
|
|
43
|
+
import { SearchField } from '@progress/kendo-react-data-tools';
|
|
43
44
|
import { SelectDescriptor } from '@progress/kendo-react-data-tools';
|
|
44
45
|
import { setSelectedState } from '@progress/kendo-react-data-tools';
|
|
45
46
|
import { SortDescriptor } from '@progress/kendo-data-query';
|
|
@@ -55,6 +56,8 @@ import { TableKeyDownEvent } from '@progress/kendo-react-data-tools';
|
|
|
55
56
|
import { TableSelectableMode } from '@progress/kendo-react-data-tools';
|
|
56
57
|
import { TableSelectableSettings } from '@progress/kendo-react-data-tools';
|
|
57
58
|
import { TableSelectionChangeEvent } from '@progress/kendo-react-data-tools';
|
|
59
|
+
import { TextBoxChangeEvent } from '@progress/kendo-react-inputs';
|
|
60
|
+
import { TextBoxProps } from '@progress/kendo-react-inputs';
|
|
58
61
|
|
|
59
62
|
/**
|
|
60
63
|
* The value of the filter operators displayed in the boolean filter menu.
|
|
@@ -225,10 +228,6 @@ export declare const contextMenuItemsMap: {
|
|
|
225
228
|
};
|
|
226
229
|
};
|
|
227
230
|
|
|
228
|
-
export { DetailExpandDescriptor }
|
|
229
|
-
|
|
230
|
-
export { EditDescriptor }
|
|
231
|
-
|
|
232
231
|
/**
|
|
233
232
|
* @hidden
|
|
234
233
|
*/
|
|
@@ -249,6 +248,7 @@ declare interface ExtendedColumnProps extends GridColumnProps {
|
|
|
249
248
|
isAccessible: boolean;
|
|
250
249
|
/** @hidden _internal usage only */
|
|
251
250
|
_type?: 'edit' | 'expand';
|
|
251
|
+
rowSpannable?: Required<GridRowSpannableSettings>;
|
|
252
252
|
}
|
|
253
253
|
|
|
254
254
|
/**
|
|
@@ -302,7 +302,7 @@ export declare const GRID_PREVENT_SELECTION_ELEMENT = "data-prevent-selection";
|
|
|
302
302
|
/** The attribute required by the Grid selection on Grid `tr` elements. */
|
|
303
303
|
export declare const GRID_ROW_INDEX_ATTRIBUTE = "data-grid-row-index";
|
|
304
304
|
|
|
305
|
-
export declare const GridCell: (props: GridCellProps) => JSX_2.Element;
|
|
305
|
+
export declare const GridCell: (props: GridCellProps) => JSX_2.Element | null;
|
|
306
306
|
|
|
307
307
|
/**
|
|
308
308
|
* Represents the `GridCellBaseOptions` object that are passed to the handler.
|
|
@@ -407,6 +407,11 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
407
407
|
localization?: LocalizationService;
|
|
408
408
|
/** @hidden */
|
|
409
409
|
intl?: IntlService;
|
|
410
|
+
/** @hidden */
|
|
411
|
+
_rowSpan?: {
|
|
412
|
+
count: number | null;
|
|
413
|
+
value: any;
|
|
414
|
+
};
|
|
410
415
|
}
|
|
411
416
|
|
|
412
417
|
/**
|
|
@@ -550,6 +555,31 @@ export declare interface GridColumnMenuColumnProps {
|
|
|
550
555
|
id?: string;
|
|
551
556
|
}
|
|
552
557
|
|
|
558
|
+
/**
|
|
559
|
+
* Represents the KendoReact GridColumnMenuColumnsChooser component.
|
|
560
|
+
*/
|
|
561
|
+
export declare const GridColumnMenuColumnsChooser: React_2.FunctionComponent<GridColumnMenuColumnsChooserProps>;
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* The props passed to the ColumnMenu ColumnsChooser component.
|
|
565
|
+
*/
|
|
566
|
+
declare interface GridColumnMenuColumnsChooserBaseProps extends GridColumnMenuBaseProps {
|
|
567
|
+
/**
|
|
568
|
+
* The columns state of the KendoReact GridColumnMenuColumnsChooser component.
|
|
569
|
+
*/
|
|
570
|
+
columnsState?: GridColumnState[];
|
|
571
|
+
/**
|
|
572
|
+
* The method that will be called when the new columns state is applied.
|
|
573
|
+
*/
|
|
574
|
+
onColumnsStateChange?: Function;
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* The props of the GridColumnMenuColumnsChooser component.
|
|
579
|
+
*/
|
|
580
|
+
export declare interface GridColumnMenuColumnsChooserProps extends GridColumnMenuColumnsChooserBaseProps {
|
|
581
|
+
}
|
|
582
|
+
|
|
553
583
|
/**
|
|
554
584
|
* Represents the KendoReact GridColumnMenuColumnsList component.
|
|
555
585
|
*/
|
|
@@ -877,7 +907,7 @@ declare interface GridColumnMenuItemProps {
|
|
|
877
907
|
/**
|
|
878
908
|
* The props which the ColumnMenu passes to its children.
|
|
879
909
|
*/
|
|
880
|
-
export declare interface GridColumnMenuProps extends GridColumnMenuFilterBaseProps, GridColumnMenuSortBaseProps, GridColumnMenuGroupBaseProps {
|
|
910
|
+
export declare interface GridColumnMenuProps extends GridColumnMenuFilterBaseProps, GridColumnMenuSortBaseProps, GridColumnMenuGroupBaseProps, GridColumnMenuColumnsChooserBaseProps {
|
|
881
911
|
navigatable?: boolean;
|
|
882
912
|
show?: boolean;
|
|
883
913
|
}
|
|
@@ -1059,6 +1089,8 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1059
1089
|
media?: string;
|
|
1060
1090
|
/**
|
|
1061
1091
|
* Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
|
|
1092
|
+
*
|
|
1093
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
1062
1094
|
*/
|
|
1063
1095
|
cell?: ComponentType<GridCellProps>;
|
|
1064
1096
|
/**
|
|
@@ -1067,10 +1099,14 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1067
1099
|
cells?: GridCellsSettings;
|
|
1068
1100
|
/**
|
|
1069
1101
|
* Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
|
|
1102
|
+
*
|
|
1103
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
1070
1104
|
*/
|
|
1071
1105
|
filterCell?: ComponentType<GridFilterCellProps>;
|
|
1072
1106
|
/**
|
|
1073
1107
|
* Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
|
|
1108
|
+
*
|
|
1109
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
1074
1110
|
*/
|
|
1075
1111
|
headerCell?: ComponentType<GridHeaderCellProps>;
|
|
1076
1112
|
/**
|
|
@@ -1085,6 +1121,8 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1085
1121
|
* )}
|
|
1086
1122
|
* />
|
|
1087
1123
|
* ```
|
|
1124
|
+
*
|
|
1125
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
1088
1126
|
*/
|
|
1089
1127
|
footerCell?: ComponentType<GridFooterCellProps>;
|
|
1090
1128
|
/**
|
|
@@ -1093,6 +1131,10 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1093
1131
|
* @default "data"
|
|
1094
1132
|
*/
|
|
1095
1133
|
columnType?: GridColumnType;
|
|
1134
|
+
/**
|
|
1135
|
+
* Defines if the cells of the column should be spanned when their values are the same.
|
|
1136
|
+
*/
|
|
1137
|
+
rowSpannable?: boolean | GridRowSpannableSettings;
|
|
1096
1138
|
}
|
|
1097
1139
|
|
|
1098
1140
|
/**
|
|
@@ -1166,6 +1208,46 @@ export declare interface GridColumnResizeEvent {
|
|
|
1166
1208
|
declare interface GridColumnSortSettings extends ColumnSortSettings {
|
|
1167
1209
|
}
|
|
1168
1210
|
|
|
1211
|
+
/**
|
|
1212
|
+
* Represents the object of the `onColumnsStateChange` Grid event.
|
|
1213
|
+
*/
|
|
1214
|
+
export declare interface GridColumnsStateChangeEvent {
|
|
1215
|
+
/**
|
|
1216
|
+
* An event target.
|
|
1217
|
+
*/
|
|
1218
|
+
target: GridHandle;
|
|
1219
|
+
/**
|
|
1220
|
+
* The columns state collection.
|
|
1221
|
+
*/
|
|
1222
|
+
columnsState: GridColumnState[];
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
/**
|
|
1226
|
+
* The state of the GridColumn
|
|
1227
|
+
*/
|
|
1228
|
+
export declare interface GridColumnState {
|
|
1229
|
+
/**
|
|
1230
|
+
* The id of the column.
|
|
1231
|
+
*/
|
|
1232
|
+
id: string;
|
|
1233
|
+
/**
|
|
1234
|
+
* The field of the column.
|
|
1235
|
+
*/
|
|
1236
|
+
field?: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* The title of the column.
|
|
1239
|
+
*/
|
|
1240
|
+
title?: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* The value indicating whether a column is visible or not.
|
|
1243
|
+
*/
|
|
1244
|
+
hidden?: boolean;
|
|
1245
|
+
/**
|
|
1246
|
+
* A collection of child states.
|
|
1247
|
+
*/
|
|
1248
|
+
children?: GridColumnState[];
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1169
1251
|
/**
|
|
1170
1252
|
* Sets the column type.
|
|
1171
1253
|
*
|
|
@@ -1395,6 +1477,20 @@ export declare interface GridCustomHeaderCellProps extends GridHeaderCellProps {
|
|
|
1395
1477
|
index?: number;
|
|
1396
1478
|
}
|
|
1397
1479
|
|
|
1480
|
+
/**
|
|
1481
|
+
* The properties of the default Grid Row.
|
|
1482
|
+
*/
|
|
1483
|
+
export declare interface GridCustomRowProps extends GridRowProps {
|
|
1484
|
+
/**
|
|
1485
|
+
* The props and attributes that are applied to the tr element by default.
|
|
1486
|
+
*/
|
|
1487
|
+
trProps?: React.HTMLAttributes<HTMLTableRowElement> | null;
|
|
1488
|
+
/**
|
|
1489
|
+
* The default children of the table row.
|
|
1490
|
+
*/
|
|
1491
|
+
children?: React.ReactNode | React.ReactNode[];
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1398
1494
|
/**
|
|
1399
1495
|
* Represents the object of the `onDataStateChange` Grid event.
|
|
1400
1496
|
*/
|
|
@@ -1412,7 +1508,9 @@ export declare interface GridDataStateChangeEvent extends GridEvent {
|
|
|
1412
1508
|
*/
|
|
1413
1509
|
export declare type GridDataType = 'text' | 'numeric' | 'boolean' | 'date';
|
|
1414
1510
|
|
|
1415
|
-
/**
|
|
1511
|
+
/**
|
|
1512
|
+
* Represents the object of the `onDetailExpandChange` Grid event.
|
|
1513
|
+
*/
|
|
1416
1514
|
export declare interface GridDetailExpandChangeEvent extends GridEvent {
|
|
1417
1515
|
detailExpand: DetailExpandDescriptor;
|
|
1418
1516
|
}
|
|
@@ -1470,10 +1568,10 @@ export declare interface GridDragSelectionReleaseEvent extends TableDragSelectio
|
|
|
1470
1568
|
}
|
|
1471
1569
|
|
|
1472
1570
|
/**
|
|
1473
|
-
*
|
|
1474
|
-
*
|
|
1571
|
+
* Represents the Grid editable settings:
|
|
1572
|
+
* - `enabled` — Determines if the editing is enabled.
|
|
1573
|
+
* - `mode` — Determines the editing mode.
|
|
1475
1574
|
*
|
|
1476
|
-
* @hidden
|
|
1477
1575
|
*/
|
|
1478
1576
|
declare interface GridEditableSettings extends TableEditableSettings {
|
|
1479
1577
|
}
|
|
@@ -1483,7 +1581,9 @@ declare interface GridEditableSettings extends TableEditableSettings {
|
|
|
1483
1581
|
*/
|
|
1484
1582
|
export declare const GridEditCell: (props: GridCellProps) => JSX_2.Element;
|
|
1485
1583
|
|
|
1486
|
-
/**
|
|
1584
|
+
/**
|
|
1585
|
+
* Represents the object of the `onEditChange` Grid event.
|
|
1586
|
+
*/
|
|
1487
1587
|
export declare interface GridEditChangeEvent extends GridEvent {
|
|
1488
1588
|
edit: EditDescriptor;
|
|
1489
1589
|
}
|
|
@@ -1697,10 +1797,14 @@ export declare interface GridGroupChangeEvent extends GridEvent {
|
|
|
1697
1797
|
group: GroupDescriptor[];
|
|
1698
1798
|
}
|
|
1699
1799
|
|
|
1700
|
-
/**
|
|
1800
|
+
/**
|
|
1801
|
+
* Represents the Grid group expandable settings.
|
|
1802
|
+
*/
|
|
1701
1803
|
declare type GridGroupExpandableSettings = TableGroupExpandableSettings;
|
|
1702
1804
|
|
|
1703
|
-
/**
|
|
1805
|
+
/**
|
|
1806
|
+
* Represents the object of the `onGroupExpandChange` Grid event.
|
|
1807
|
+
*/
|
|
1704
1808
|
export declare interface GridGroupExpandChangeEvent extends GridEvent {
|
|
1705
1809
|
groupExpand: GroupExpandDescriptor[];
|
|
1706
1810
|
}
|
|
@@ -1825,10 +1929,7 @@ export declare interface GridHeaderCellProps extends Omit<HeaderCellBaseProps, '
|
|
|
1825
1929
|
*/
|
|
1826
1930
|
export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
1827
1931
|
/**
|
|
1828
|
-
*
|
|
1829
|
-
* The new [SelectDescriptor]({% slug api_kendo-react-grid_selectdescriptor %}) based on the user action.
|
|
1830
|
-
*
|
|
1831
|
-
* @hidden
|
|
1932
|
+
* The new [SelectDescriptor]({% slug api_data-tools_selectdescriptor %}) based on the user action.
|
|
1832
1933
|
*/
|
|
1833
1934
|
select: SelectDescriptor;
|
|
1834
1935
|
/**
|
|
@@ -1910,6 +2011,7 @@ export declare const gridMessages: {
|
|
|
1910
2011
|
"grid.pagerOf": string;
|
|
1911
2012
|
"grid.pagerTotalPages": string;
|
|
1912
2013
|
"grid.searchPlaceholder": string;
|
|
2014
|
+
"grid.searchboxPlaceholder": string;
|
|
1913
2015
|
"grid.filterCheckAll": string;
|
|
1914
2016
|
"grid.filterChooseOperator": string;
|
|
1915
2017
|
"grid.filterSelectedItems": string;
|
|
@@ -1973,7 +2075,7 @@ export declare interface GridNavigationActionEvent extends GridEvent {
|
|
|
1973
2075
|
* ```
|
|
1974
2076
|
*/
|
|
1975
2077
|
export declare const GridNoRecords: {
|
|
1976
|
-
(props: GridNoRecordsProps):
|
|
2078
|
+
(props: GridNoRecordsProps): JSX_2.Element;
|
|
1977
2079
|
displayName: string;
|
|
1978
2080
|
};
|
|
1979
2081
|
|
|
@@ -2068,9 +2170,15 @@ declare type GridPagerType = 'numeric' | 'input';
|
|
|
2068
2170
|
* Represents the props of the [KendoReact Grid component]({% slug overview_grid %}).
|
|
2069
2171
|
*/
|
|
2070
2172
|
export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
2071
|
-
/**
|
|
2173
|
+
/**
|
|
2174
|
+
* Enables data-processing inside the GridComponent based on it's state.
|
|
2175
|
+
* Provides an easy, built-in way to handle data operations like sorting, filtering, grouping, and paging.
|
|
2176
|
+
*
|
|
2177
|
+
* @default false
|
|
2178
|
+
*/
|
|
2072
2179
|
autoProcessData?: boolean | {
|
|
2073
2180
|
filter?: boolean;
|
|
2181
|
+
search?: boolean;
|
|
2074
2182
|
sort?: boolean;
|
|
2075
2183
|
group?: boolean;
|
|
2076
2184
|
page?: boolean;
|
|
@@ -2088,6 +2196,10 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2088
2196
|
* Sets a set of custom components that the Grid will render instead of the built-in cell.
|
|
2089
2197
|
*/
|
|
2090
2198
|
cells?: GridCellsSettings;
|
|
2199
|
+
/**
|
|
2200
|
+
* Sets a set of custom components that the Grid will render instead of the built-in row.
|
|
2201
|
+
*/
|
|
2202
|
+
rows?: GridRowsSettings;
|
|
2091
2203
|
/**
|
|
2092
2204
|
* Sets the data of the Grid ([see example]({% slug paging_grid %})). If you use paging, the `data` option has to contain only the items for the current page. It takes values of type null, any or [DataResult]({% slug api_kendo-data-query_dataresult%})
|
|
2093
2205
|
*/
|
|
@@ -2101,9 +2213,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2101
2213
|
*/
|
|
2102
2214
|
clipboard?: ClipboardSettings | boolean;
|
|
2103
2215
|
/**
|
|
2104
|
-
* Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [
|
|
2216
|
+
* Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [GridClipboardEvent]({% slug api_data-tools_gridclipboardevent %}). Only fired when the Grid is run as a client component.
|
|
2105
2217
|
*/
|
|
2106
|
-
onClipboard?: (event:
|
|
2218
|
+
onClipboard?: (event: GridClipboardEvent) => void;
|
|
2107
2219
|
/**
|
|
2108
2220
|
* Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})). You have to handle the event yourself and sort the data.
|
|
2109
2221
|
*/
|
|
@@ -2112,7 +2224,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2112
2224
|
* The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
|
|
2113
2225
|
*/
|
|
2114
2226
|
sort?: SortDescriptor[];
|
|
2115
|
-
/**
|
|
2227
|
+
/**
|
|
2228
|
+
* The default `sort` state that will be applied to the Grid when using uncontrolled mode.
|
|
2229
|
+
*/
|
|
2116
2230
|
defaultSort?: SortDescriptor[];
|
|
2117
2231
|
/**
|
|
2118
2232
|
* Enables the filtering of the columns with their `field` option set ([more information and examples]({% slug filtering_grid %})).
|
|
@@ -2122,7 +2236,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2122
2236
|
* 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.
|
|
2123
2237
|
*/
|
|
2124
2238
|
filter?: CompositeFilterDescriptor;
|
|
2125
|
-
/**
|
|
2239
|
+
/**
|
|
2240
|
+
* The default `filter` state that will be applied to the Grid when using uncontrolled mode.
|
|
2241
|
+
*/
|
|
2126
2242
|
defaultFilter?: CompositeFilterDescriptor;
|
|
2127
2243
|
/**
|
|
2128
2244
|
* The filter operators for the Grid filters.
|
|
@@ -2161,7 +2277,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2161
2277
|
* ([more information and examples]({% slug groupingbasics_grid %})).
|
|
2162
2278
|
*/
|
|
2163
2279
|
group?: GroupDescriptor[];
|
|
2164
|
-
/**
|
|
2280
|
+
/**
|
|
2281
|
+
* The default `group` state that will be applied to the Grid when using uncontrolled mode.
|
|
2282
|
+
*/
|
|
2165
2283
|
defaultGroup?: GroupDescriptor[];
|
|
2166
2284
|
/**
|
|
2167
2285
|
* Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
|
|
@@ -2192,7 +2310,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2192
2310
|
* Alias of `pageSize` property. If `take` is set, `pageSize` will be ignored.
|
|
2193
2311
|
*/
|
|
2194
2312
|
take?: number;
|
|
2195
|
-
/**
|
|
2313
|
+
/**
|
|
2314
|
+
* The default `take` state that will be applied to the Grid when using uncontrolled mode.
|
|
2315
|
+
*/
|
|
2196
2316
|
defaultTake?: number;
|
|
2197
2317
|
/**
|
|
2198
2318
|
* 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.
|
|
@@ -2206,36 +2326,60 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2206
2326
|
* Defines the number of records that will be skipped by the pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
|
|
2207
2327
|
*/
|
|
2208
2328
|
skip?: number;
|
|
2209
|
-
/**
|
|
2329
|
+
/**
|
|
2330
|
+
* The default `skip` state that will be applied to the Grid when using uncontrolled mode.
|
|
2331
|
+
*/
|
|
2210
2332
|
defaultSkip?: number;
|
|
2211
2333
|
/**
|
|
2212
2334
|
* Determines if the scroll position will be updated after data change. If set to `true` the scroll will remain on the same position.
|
|
2213
2335
|
*/
|
|
2214
2336
|
fixedScroll?: boolean;
|
|
2215
|
-
/**
|
|
2337
|
+
/**
|
|
2338
|
+
* The [descriptor]({% slug api_data-tools_detailexpanddescriptor %}) by which the detail-row is expanded.
|
|
2339
|
+
*/
|
|
2216
2340
|
detailExpand?: DetailExpandDescriptor;
|
|
2217
|
-
/**
|
|
2341
|
+
/**
|
|
2342
|
+
* The default `detailExpand` state that will be applied to the Grid when using uncontrolled mode.
|
|
2343
|
+
*/
|
|
2218
2344
|
defaultDetailExpand?: DetailExpandDescriptor;
|
|
2219
|
-
/**
|
|
2220
|
-
|
|
2345
|
+
/**
|
|
2346
|
+
* Fires when the user expand or collapse a detail-row.
|
|
2347
|
+
*/
|
|
2221
2348
|
onDetailExpandChange?: (event: GridDetailExpandChangeEvent) => void;
|
|
2222
|
-
/**
|
|
2349
|
+
/**
|
|
2350
|
+
* The [descriptor]({% slug api_data-tools_groupexpanddescriptor %}) by which the group is expanded.
|
|
2351
|
+
*/
|
|
2223
2352
|
groupExpand?: GroupExpandDescriptor[];
|
|
2224
|
-
/**
|
|
2353
|
+
/**
|
|
2354
|
+
* The default `groupExpand` state that will be applied to the Grid when using uncontrolled mode.
|
|
2355
|
+
*/
|
|
2225
2356
|
defaultGroupExpand?: GroupExpandDescriptor[];
|
|
2226
|
-
/**
|
|
2357
|
+
/**
|
|
2358
|
+
* Fires when the user expands or collapse a group.
|
|
2359
|
+
*/
|
|
2227
2360
|
onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
|
|
2228
2361
|
/**
|
|
2229
2362
|
* Fires when the user tries to expand or collapse a row.
|
|
2363
|
+
*
|
|
2364
|
+
* @deprecated This prop is deprecated in favor of the [onDetailExpandChange]({% slug api_grid_gridprops %}#toc-ondetailexpandchange) and [onGroupExpandChange]({% slug api_grid_gridprops %}#toc-ongroupexpandchange) props.
|
|
2365
|
+
* We’re removing this prop in version 11.0.0.
|
|
2230
2366
|
*/
|
|
2231
2367
|
onExpandChange?: (event: GridExpandChangeEvent) => void;
|
|
2232
2368
|
/**
|
|
2233
2369
|
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
|
|
2370
|
+
*
|
|
2371
|
+
* @deprecated This prop is deprecated in favor of the ([detailExpand]({% slug api_grid_gridprops %}#toc-detailexpand)) and ([groupExpand]({% slug api_grid_gridprops %}#toc-groupexpand)) props.
|
|
2372
|
+
* We’re removing this prop in version 11.0.0.
|
|
2234
2373
|
*/
|
|
2235
2374
|
expandField?: string;
|
|
2236
|
-
/**
|
|
2375
|
+
/**
|
|
2376
|
+
* The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
|
|
2377
|
+
* Passing a boolean value will select the whole row, while passing an array of strings will select individual.
|
|
2378
|
+
*/
|
|
2237
2379
|
select?: SelectDescriptor;
|
|
2238
|
-
/**
|
|
2380
|
+
/**
|
|
2381
|
+
* The default `select` state that will be applied to the Grid when using uncontrolled mode.
|
|
2382
|
+
*/
|
|
2239
2383
|
defaultSelect?: SelectDescriptor;
|
|
2240
2384
|
/**
|
|
2241
2385
|
* The Grid selectable settings.
|
|
@@ -2245,6 +2389,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2245
2389
|
* Specifies the name of the field which will provide a:
|
|
2246
2390
|
* - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
|
|
2247
2391
|
* - String array of the selected columns of the item for cell selection
|
|
2392
|
+
*
|
|
2393
|
+
* @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
|
|
2394
|
+
* We’re removing this prop in version 11.0.0.
|
|
2248
2395
|
*/
|
|
2249
2396
|
selectedField?: string;
|
|
2250
2397
|
/**
|
|
@@ -2267,16 +2414,27 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2267
2414
|
* 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 %})).
|
|
2268
2415
|
*/
|
|
2269
2416
|
onItemChange?: (event: GridItemChangeEvent) => void;
|
|
2270
|
-
/**
|
|
2417
|
+
/**
|
|
2418
|
+
* The [descriptor]({% slug api_data-tools_editdescriptor %}) by which the in-edit mode of an item is defined.
|
|
2419
|
+
*/
|
|
2271
2420
|
edit?: EditDescriptor;
|
|
2272
|
-
/**
|
|
2421
|
+
/**
|
|
2422
|
+
* The default `edit` state that will be applied to the Grid when using uncontrolled mode.
|
|
2423
|
+
*/
|
|
2273
2424
|
defaultEdit?: EditDescriptor;
|
|
2274
|
-
/**
|
|
2425
|
+
/**
|
|
2426
|
+
* The Grid editable settings.
|
|
2427
|
+
*/
|
|
2275
2428
|
editable?: boolean | GridEditableSettings;
|
|
2276
|
-
/**
|
|
2429
|
+
/**
|
|
2430
|
+
* Fires when the user enters or exits an in-edit mode of a row or cell.
|
|
2431
|
+
*/
|
|
2277
2432
|
onEditChange?: (event: GridEditChangeEvent) => void;
|
|
2278
2433
|
/**
|
|
2279
2434
|
* 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 %})).
|
|
2435
|
+
*
|
|
2436
|
+
* @deprecated This prop is deprecated in favor of the ([edit]({% slug api_grid_gridprops %}#toc-edit)) prop.
|
|
2437
|
+
* We’re removing this prop in version 11.0.0.
|
|
2280
2438
|
*/
|
|
2281
2439
|
editField?: string;
|
|
2282
2440
|
/**
|
|
@@ -2300,6 +2458,22 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2300
2458
|
* Specifies a React element that will be cloned and rendered inside the detail rows of the currently expanded items ([see example]({% slug hierarchy_grid %})). An item will be rendered as expanded if the value of its `expandField` is `true`.
|
|
2301
2459
|
*/
|
|
2302
2460
|
detail?: null | ComponentType<GridDetailRowProps>;
|
|
2461
|
+
/**
|
|
2462
|
+
* The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is searched. Its first FilterDescriptor populates the GridSearchBox.
|
|
2463
|
+
*/
|
|
2464
|
+
search?: CompositeFilterDescriptor;
|
|
2465
|
+
/**
|
|
2466
|
+
* The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is searched by default. Its first FilterDescriptor populates the GridSearchBox.
|
|
2467
|
+
*/
|
|
2468
|
+
defaultSearch?: CompositeFilterDescriptor;
|
|
2469
|
+
/**
|
|
2470
|
+
* Defines the fields of the data that are filtered by the GridSearchBox.
|
|
2471
|
+
*/
|
|
2472
|
+
searchFields?: (string | SearchField)[];
|
|
2473
|
+
/**
|
|
2474
|
+
* Fires when the search value of the GridSearchBox is changed.
|
|
2475
|
+
*/
|
|
2476
|
+
onSearchChange?: (event: GridSearchChangeEvent) => void;
|
|
2303
2477
|
/**
|
|
2304
2478
|
* Represents the `style` HTML attribute.
|
|
2305
2479
|
*/
|
|
@@ -2336,18 +2510,26 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2336
2510
|
onColumnReorder?: (event: GridColumnReorderEvent) => void;
|
|
2337
2511
|
/**
|
|
2338
2512
|
* Fires when a row is about to be rendered. Overrides the default appearance of the row.
|
|
2513
|
+
*
|
|
2514
|
+
* @deprecated This prop is deprecated in favor of the ([rows]({% slug api_grid_gridprops %}#toc-rows)) prop. We’re removing this prop in version 11.0.0.
|
|
2339
2515
|
*/
|
|
2340
2516
|
rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
2341
2517
|
/**
|
|
2342
2518
|
* Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
|
|
2519
|
+
*
|
|
2520
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
2343
2521
|
*/
|
|
2344
2522
|
cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
|
|
2345
2523
|
/**
|
|
2346
2524
|
* Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
|
|
2525
|
+
*
|
|
2526
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
2347
2527
|
*/
|
|
2348
2528
|
filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
|
|
2349
2529
|
/**
|
|
2350
2530
|
* Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
|
|
2531
|
+
*
|
|
2532
|
+
* @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
|
|
2351
2533
|
*/
|
|
2352
2534
|
headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
2353
2535
|
/**
|
|
@@ -2412,6 +2594,22 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2412
2594
|
* @hidden
|
|
2413
2595
|
*/
|
|
2414
2596
|
unstyled?: GridClassStructure;
|
|
2597
|
+
/**
|
|
2598
|
+
* Enables the built-in row span feature of the Grid.
|
|
2599
|
+
*/
|
|
2600
|
+
rowSpannable?: boolean | GridRowSpannableSettings;
|
|
2601
|
+
/**
|
|
2602
|
+
* @hidden
|
|
2603
|
+
*/
|
|
2604
|
+
columnsState?: GridColumnState[];
|
|
2605
|
+
/**
|
|
2606
|
+
* @hidden
|
|
2607
|
+
*/
|
|
2608
|
+
defaultColumnsState?: GridColumnState[];
|
|
2609
|
+
/**
|
|
2610
|
+
* Fires when the columns state of the Grid is changed.
|
|
2611
|
+
*/
|
|
2612
|
+
onColumnsStateChange?: (event: GridColumnsStateChangeEvent) => void;
|
|
2415
2613
|
}
|
|
2416
2614
|
|
|
2417
2615
|
/**
|
|
@@ -2488,6 +2686,10 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
2488
2686
|
* A function for overriding the default rendering of the row.
|
|
2489
2687
|
*/
|
|
2490
2688
|
render?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
2689
|
+
/**
|
|
2690
|
+
* Sets a set of rows components that the Grid will render instead of the built-in row.
|
|
2691
|
+
*/
|
|
2692
|
+
rows?: GridRowsSettings;
|
|
2491
2693
|
/**
|
|
2492
2694
|
* The index to be applied to the `aria-rowindex` attribute.
|
|
2493
2695
|
*/
|
|
@@ -2559,6 +2761,30 @@ export declare type GridRowReorderSettings = {
|
|
|
2559
2761
|
dragClue?: string | ((dataItem: any) => React.ReactNode);
|
|
2560
2762
|
};
|
|
2561
2763
|
|
|
2764
|
+
/**
|
|
2765
|
+
* Represents the settings for the row-spanning functionality of the Grid.
|
|
2766
|
+
*/
|
|
2767
|
+
export declare type GridRowSpannableSettings = {
|
|
2768
|
+
/**
|
|
2769
|
+
* Determines if the row-spanning functionality is enabled or disabled
|
|
2770
|
+
*/
|
|
2771
|
+
enabled?: boolean;
|
|
2772
|
+
/**
|
|
2773
|
+
* A function that returns the value of the cell that should span the row.
|
|
2774
|
+
* The value could be combined from multiple fields of the dataItem to create a unique identifier and prevent the cell from being row-spanned.
|
|
2775
|
+
*/
|
|
2776
|
+
valueGetter?: (dataItem: any, field: string) => any;
|
|
2777
|
+
};
|
|
2778
|
+
|
|
2779
|
+
/**
|
|
2780
|
+
* The settings of the rows prop options.
|
|
2781
|
+
*/
|
|
2782
|
+
export declare interface GridRowsSettings {
|
|
2783
|
+
groupHeader?: ComponentType<GridCustomRowProps>;
|
|
2784
|
+
data?: ComponentType<GridCustomRowProps>;
|
|
2785
|
+
groupFooter?: ComponentType<GridCustomRowProps>;
|
|
2786
|
+
}
|
|
2787
|
+
|
|
2562
2788
|
/**
|
|
2563
2789
|
* The type of the GridRow component.
|
|
2564
2790
|
*
|
|
@@ -2569,6 +2795,28 @@ export declare type GridRowReorderSettings = {
|
|
|
2569
2795
|
*/
|
|
2570
2796
|
export declare type GridRowType = 'groupFooter' | 'groupHeader' | 'data';
|
|
2571
2797
|
|
|
2798
|
+
/**
|
|
2799
|
+
* Represents the properties of the KendoReact GridSearchBox component.
|
|
2800
|
+
*/
|
|
2801
|
+
export declare const GridSearchBox: (props: GridSearchBoxProps) => JSX_2.Element;
|
|
2802
|
+
|
|
2803
|
+
export declare interface GridSearchBoxChangeEvent extends TextBoxChangeEvent {
|
|
2804
|
+
}
|
|
2805
|
+
|
|
2806
|
+
export declare interface GridSearchBoxProps extends TextBoxProps {
|
|
2807
|
+
onChange?: (event: GridSearchBoxChangeEvent) => void;
|
|
2808
|
+
}
|
|
2809
|
+
|
|
2810
|
+
/**
|
|
2811
|
+
* Represents the object of the `onSearchChange` Grid event.
|
|
2812
|
+
*/
|
|
2813
|
+
export declare interface GridSearchChangeEvent extends GridEvent {
|
|
2814
|
+
/**
|
|
2815
|
+
* The new search based on the user action.
|
|
2816
|
+
*/
|
|
2817
|
+
search: CompositeFilterDescriptor;
|
|
2818
|
+
}
|
|
2819
|
+
|
|
2572
2820
|
/**
|
|
2573
2821
|
* Represents the available selection modes.
|
|
2574
2822
|
*/
|
|
@@ -2598,10 +2846,7 @@ export declare const GridSelectionCell: (props: GridCellProps) => JSX_2.Element;
|
|
|
2598
2846
|
*/
|
|
2599
2847
|
export declare interface GridSelectionChangeEvent extends GridEvent, TableSelectionChangeEvent<GridHandle> {
|
|
2600
2848
|
/**
|
|
2601
|
-
*
|
|
2602
|
-
* The new [SelectDescriptor]({% slug api_kendo-data-tools_selectdescriptor %}) based on the user action.
|
|
2603
|
-
*
|
|
2604
|
-
* @hidden
|
|
2849
|
+
* The new [SelectDescriptor]({% slug api_data-tools_selectdescriptor %}) based on the user action.
|
|
2605
2850
|
*/
|
|
2606
2851
|
select: SelectDescriptor;
|
|
2607
2852
|
/**
|
|
@@ -2718,8 +2963,6 @@ export declare interface GridToolbarProps {
|
|
|
2718
2963
|
ariaControls?: string;
|
|
2719
2964
|
}
|
|
2720
2965
|
|
|
2721
|
-
export { GroupExpandDescriptor }
|
|
2722
|
-
|
|
2723
2966
|
/**
|
|
2724
2967
|
* @hidden
|
|
2725
2968
|
*/
|
|
@@ -2796,8 +3039,6 @@ export declare const rootFilterOrDefault: (rootFilter: CompositeFilterDescriptor
|
|
|
2796
3039
|
|
|
2797
3040
|
declare type ScrollMode = 'none' | 'scrollable' | 'virtual';
|
|
2798
3041
|
|
|
2799
|
-
export { SelectDescriptor }
|
|
2800
|
-
|
|
2801
3042
|
/**
|
|
2802
3043
|
* Represents a server counterpart of every Grid event. It strips out all arguments from the event that are not serializable to the server.
|
|
2803
3044
|
*/
|