@progress/kendo-react-grid 10.1.1-develop.1 → 10.2.0-develop.10
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/GridClientContextReader.js +1 -1
- package/GridClientContextReader.mjs +14 -13
- package/GridClientWrapper.js +1 -1
- package/GridClientWrapper.mjs +354 -353
- package/GridComponent.js +1 -1
- package/GridComponent.mjs +387 -384
- package/cells/GridFilterCell.js +1 -1
- package/cells/GridFilterCell.mjs +4 -2
- package/columnMenu/GridColumnMenuWrapper.js +1 -1
- package/columnMenu/GridColumnMenuWrapper.mjs +4 -4
- package/dist/cdn/js/kendo-react-grid.js +1 -1
- package/drag/CommonDragLogic.js +1 -1
- package/drag/CommonDragLogic.mjs +1 -1
- package/index.d.mts +669 -91
- package/index.d.ts +669 -91
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +13 -13
- package/utils/virtualColumns.js +8 -0
- package/utils/virtualColumns.mjs +32 -0
package/index.d.ts
CHANGED
|
@@ -28,7 +28,7 @@ import { GroupState } from '@progress/kendo-react-data-tools';
|
|
|
28
28
|
import { HeaderCellBaseProps } from '@progress/kendo-react-data-tools';
|
|
29
29
|
import { HeaderThElementProps } from '@progress/kendo-react-data-tools';
|
|
30
30
|
import { IntlService } from '@progress/kendo-react-intl';
|
|
31
|
-
import { JSX
|
|
31
|
+
import { JSX } from 'react/jsx-runtime';
|
|
32
32
|
import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
|
|
33
33
|
import { LocalizationService } from '@progress/kendo-react-intl';
|
|
34
34
|
import { MenuItemModel } from '@progress/kendo-react-layout';
|
|
@@ -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) =>
|
|
305
|
+
export declare const GridCell: (props: GridCellProps) => JSX.Element | null;
|
|
306
306
|
|
|
307
307
|
/**
|
|
308
308
|
* Represents the `GridCellBaseOptions` object that are passed to the handler.
|
|
@@ -318,23 +318,23 @@ export declare interface GridCellBaseOptions {
|
|
|
318
318
|
*/
|
|
319
319
|
export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'render'> {
|
|
320
320
|
/**
|
|
321
|
-
*
|
|
321
|
+
* The zero-based index of the data item in the data collection.
|
|
322
322
|
*/
|
|
323
323
|
dataIndex: number;
|
|
324
324
|
/**
|
|
325
|
-
* The index of the column in the rendered columns collection.
|
|
325
|
+
* The index of the column in the rendered columns collection. Optional.
|
|
326
326
|
*/
|
|
327
327
|
columnIndex?: number;
|
|
328
328
|
/**
|
|
329
|
-
* The number of rendered columns in the Grid.
|
|
329
|
+
* The total number of rendered columns in the Grid. Optional.
|
|
330
330
|
*/
|
|
331
331
|
columnsCount?: number;
|
|
332
332
|
/**
|
|
333
|
-
*
|
|
333
|
+
* Defines a set of custom cell components that the Grid will render instead of the default cell.
|
|
334
334
|
*/
|
|
335
335
|
cells?: GridCellsSettings;
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* Specifies the type of the row (e.g., data row, group header, etc.). Optional.
|
|
338
338
|
*/
|
|
339
339
|
rowType?: GridRowType;
|
|
340
340
|
/**
|
|
@@ -342,13 +342,13 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
342
342
|
*/
|
|
343
343
|
level?: number;
|
|
344
344
|
/**
|
|
345
|
-
*
|
|
345
|
+
* Triggered when the cell is selected. Provides the event object.
|
|
346
346
|
*/
|
|
347
347
|
selectionChange?: (event: {
|
|
348
348
|
syntheticEvent: React.SyntheticEvent<any>;
|
|
349
349
|
}) => void;
|
|
350
350
|
/**
|
|
351
|
-
*
|
|
351
|
+
* Triggered when the cell value is changed. Provides details about the change event.
|
|
352
352
|
*/
|
|
353
353
|
onChange?: (event: {
|
|
354
354
|
dataItem: any;
|
|
@@ -362,11 +362,13 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
362
362
|
_group?: GroupState;
|
|
363
363
|
}) => void;
|
|
364
364
|
/**
|
|
365
|
-
*
|
|
365
|
+
* Specifies the type of editor to be used when the cell is in edit mode.
|
|
366
|
+
* Supported values are `text`, `numeric`, `boolean`, and `date`.
|
|
366
367
|
*/
|
|
367
368
|
editor?: 'text' | 'numeric' | 'boolean' | 'date';
|
|
368
369
|
/**
|
|
369
|
-
* A function
|
|
370
|
+
* A function to override the default rendering of the cell.
|
|
371
|
+
* Accepts the default rendering and props as arguments and returns a React element.
|
|
370
372
|
*/
|
|
371
373
|
render?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | null;
|
|
372
374
|
/**
|
|
@@ -374,7 +376,8 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
374
376
|
*/
|
|
375
377
|
locked?: boolean | undefined;
|
|
376
378
|
/**
|
|
377
|
-
*
|
|
379
|
+
* Triggered when the ContextMenu is activated on the cell.
|
|
380
|
+
* Provides the event object, data item, and field name.
|
|
378
381
|
*/
|
|
379
382
|
onContextMenu?: (event: React.MouseEvent<HTMLElement>, dataItem: any, field?: string) => void;
|
|
380
383
|
/**
|
|
@@ -486,7 +489,7 @@ declare interface GridColumnMenuBaseProps {
|
|
|
486
489
|
onCloseMenu?: Function;
|
|
487
490
|
}
|
|
488
491
|
|
|
489
|
-
export declare const GridColumnMenuCheckboxFilter: (props: GridColumnMenuCheckboxFilterProps) =>
|
|
492
|
+
export declare const GridColumnMenuCheckboxFilter: (props: GridColumnMenuCheckboxFilterProps) => JSX.Element;
|
|
490
493
|
|
|
491
494
|
/**
|
|
492
495
|
* The props of the GridColumnMenuFilter component.
|
|
@@ -663,7 +666,7 @@ export declare interface GridColumnMenuColumnsListProps {
|
|
|
663
666
|
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
664
667
|
* ```
|
|
665
668
|
*/
|
|
666
|
-
export declare const GridColumnMenuFilter: (props: GridColumnMenuFilterProps) =>
|
|
669
|
+
export declare const GridColumnMenuFilter: (props: GridColumnMenuFilterProps) => JSX.Element;
|
|
667
670
|
|
|
668
671
|
/**
|
|
669
672
|
* The props passed to the ColumnMenu filter component.
|
|
@@ -690,7 +693,7 @@ declare interface GridColumnMenuFilterBaseProps extends GridColumnMenuBaseProps
|
|
|
690
693
|
/**
|
|
691
694
|
* @hidden
|
|
692
695
|
*/
|
|
693
|
-
export declare const GridColumnMenuFilterCell: (props: GridColumnMenuFilterCellProps) =>
|
|
696
|
+
export declare const GridColumnMenuFilterCell: (props: GridColumnMenuFilterCellProps) => JSX.Element;
|
|
694
697
|
|
|
695
698
|
/**
|
|
696
699
|
* @hidden
|
|
@@ -740,7 +743,7 @@ export declare interface GridColumnMenuFilterProps extends GridColumnMenuFilterB
|
|
|
740
743
|
/**
|
|
741
744
|
* @hidden
|
|
742
745
|
*/
|
|
743
|
-
export declare const GridColumnMenuFilterUI: (props: GridColumnMenuFilterUIProps) =>
|
|
746
|
+
export declare const GridColumnMenuFilterUI: (props: GridColumnMenuFilterUIProps) => JSX.Element;
|
|
744
747
|
|
|
745
748
|
/**
|
|
746
749
|
* The props that will be passed to the UI of the ColumnMenu filter component.
|
|
@@ -818,7 +821,7 @@ export declare interface GridColumnMenuFilterUIProps {
|
|
|
818
821
|
* export default App;
|
|
819
822
|
* ```
|
|
820
823
|
*/
|
|
821
|
-
export declare const GridColumnMenuGroup: (props: GridColumnMenuGroupProps) =>
|
|
824
|
+
export declare const GridColumnMenuGroup: (props: GridColumnMenuGroupProps) => JSX.Element;
|
|
822
825
|
|
|
823
826
|
/**
|
|
824
827
|
* The props passed to the ColumnMenu group component.
|
|
@@ -847,12 +850,12 @@ declare interface GridColumnMenuGroupProps extends GridColumnMenuGroupBaseProps
|
|
|
847
850
|
/**
|
|
848
851
|
* The GridColumnMenuItem component that is used inside the Grid ColumnMenu.
|
|
849
852
|
*/
|
|
850
|
-
export declare const GridColumnMenuItem: (props: GridColumnMenuItemProps) =>
|
|
853
|
+
export declare const GridColumnMenuItem: (props: GridColumnMenuItemProps) => JSX.Element;
|
|
851
854
|
|
|
852
855
|
/**
|
|
853
856
|
* The GridColumnMenuItemContent that will be used inside the Grid ColumnMenu.
|
|
854
857
|
*/
|
|
855
|
-
export declare const GridColumnMenuItemContent: (props: GridColumnMenuItemContentProps) =>
|
|
858
|
+
export declare const GridColumnMenuItemContent: (props: GridColumnMenuItemContentProps) => JSX.Element;
|
|
856
859
|
|
|
857
860
|
/**
|
|
858
861
|
* The props of the GridColumnMenuItemContent component.
|
|
@@ -867,7 +870,7 @@ declare interface GridColumnMenuItemContentProps extends KendoReactComponentBase
|
|
|
867
870
|
/**
|
|
868
871
|
* The GridColumnMenuItemGroup that will be used inside the Grid ColumnMenu.
|
|
869
872
|
*/
|
|
870
|
-
export declare const GridColumnMenuItemGroup: (props: GridColumnMenuItemGroupProps) =>
|
|
873
|
+
export declare const GridColumnMenuItemGroup: (props: GridColumnMenuItemGroupProps) => JSX.Element;
|
|
871
874
|
|
|
872
875
|
/**
|
|
873
876
|
* The props of the GridColumnMenuItemGroup component.
|
|
@@ -959,7 +962,7 @@ export declare interface GridColumnMenuProps extends GridColumnMenuFilterBasePro
|
|
|
959
962
|
* export default App;
|
|
960
963
|
* ```
|
|
961
964
|
*/
|
|
962
|
-
export declare const GridColumnMenuSort: (props: GridColumnMenuSortProps) =>
|
|
965
|
+
export declare const GridColumnMenuSort: (props: GridColumnMenuSortProps) => JSX.Element;
|
|
963
966
|
|
|
964
967
|
/**
|
|
965
968
|
* The props passed to the ColumnMenu sort component.
|
|
@@ -988,7 +991,7 @@ declare interface GridColumnMenuSortProps extends GridColumnMenuSortBaseProps {
|
|
|
988
991
|
/**
|
|
989
992
|
* The GridColumnMenuWrapper component.
|
|
990
993
|
*/
|
|
991
|
-
export declare const GridColumnMenuWrapper: (props: GridColumnMenuWrapperProps) =>
|
|
994
|
+
export declare const GridColumnMenuWrapper: (props: GridColumnMenuWrapperProps) => JSX.Element;
|
|
992
995
|
|
|
993
996
|
/**
|
|
994
997
|
* The props of the GridColumnMenuWrapper component.
|
|
@@ -1012,6 +1015,10 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1012
1015
|
* Allows the column headers to be clicked and the `sortChange` event emitted.
|
|
1013
1016
|
* You have to handle the `sortChange` event yourself and sort the data.
|
|
1014
1017
|
*
|
|
1018
|
+
* @example
|
|
1019
|
+
* ```jsx
|
|
1020
|
+
* <GridColumn sortable={true} />
|
|
1021
|
+
* ```
|
|
1015
1022
|
* @default true
|
|
1016
1023
|
*/
|
|
1017
1024
|
sortable?: boolean | GridColumnSortSettings;
|
|
@@ -1019,94 +1026,177 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1019
1026
|
* Defines if the column is locked (frozen or sticky).
|
|
1020
1027
|
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
1021
1028
|
*
|
|
1029
|
+
* @example
|
|
1030
|
+
* ```jsx
|
|
1031
|
+
* <GridColumn locked={true} />
|
|
1032
|
+
* ```
|
|
1022
1033
|
* @default false
|
|
1023
1034
|
*/
|
|
1024
1035
|
locked?: boolean;
|
|
1025
1036
|
/**
|
|
1026
1037
|
* A collection of child columns.
|
|
1038
|
+
*
|
|
1039
|
+
* @example
|
|
1040
|
+
* ```jsx
|
|
1041
|
+
* <GridColumn>
|
|
1042
|
+
* <GridColumn field="child1" />
|
|
1043
|
+
* <GridColumn field="child2" />
|
|
1044
|
+
* </GridColumn>
|
|
1045
|
+
* ```
|
|
1027
1046
|
*/
|
|
1028
1047
|
children?: GridColumnProps[] | ReactElement<GridColumnProps>[] | GridColumnChildrenProps[];
|
|
1029
1048
|
/**
|
|
1030
1049
|
* Specifies a React element that will be cloned and rendered inside the column menu of the Grid ([see example]({% slug column_menu_grid %}#toc-basic-usage)).
|
|
1050
|
+
*
|
|
1051
|
+
* @example
|
|
1052
|
+
* ```jsx
|
|
1053
|
+
* <GridColumn columnMenu={CustomColumnMenu} />
|
|
1054
|
+
* ```
|
|
1031
1055
|
*/
|
|
1032
1056
|
columnMenu?: ComponentType<GridColumnMenuProps>;
|
|
1033
1057
|
/**
|
|
1034
|
-
* Specifies the
|
|
1058
|
+
* Specifies the context menu settings that will be applied to the column.
|
|
1059
|
+
*
|
|
1060
|
+
* @example
|
|
1061
|
+
* ```jsx
|
|
1062
|
+
* <GridColumn contextMenu={{ enabled: true }} />
|
|
1063
|
+
* ```
|
|
1035
1064
|
*/
|
|
1036
1065
|
contextMenu?: boolean | GridContextMenuOptions | ((options: GridCellBaseOptions) => boolean | GridContextMenuOptions);
|
|
1037
1066
|
/**
|
|
1038
1067
|
* Determines if the column can be dragged to the group panel.
|
|
1039
1068
|
*
|
|
1069
|
+
* @example
|
|
1070
|
+
* ```jsx
|
|
1071
|
+
* <GridColumn groupable={false} />
|
|
1072
|
+
* ```
|
|
1040
1073
|
* @default true
|
|
1041
1074
|
*/
|
|
1042
1075
|
groupable?: boolean;
|
|
1043
1076
|
/**
|
|
1044
1077
|
* Defines whether the column is editable ([more information and examples]({% slug editing_inline_grid %})).
|
|
1078
|
+
*
|
|
1079
|
+
* @example
|
|
1080
|
+
* ```jsx
|
|
1081
|
+
* <GridColumn editable={true} />
|
|
1082
|
+
* ```
|
|
1045
1083
|
*/
|
|
1046
1084
|
editable?: boolean;
|
|
1047
1085
|
/**
|
|
1048
1086
|
* Defines if a filter UI will be rendered for this column.
|
|
1049
1087
|
*
|
|
1088
|
+
* @example
|
|
1089
|
+
* ```jsx
|
|
1090
|
+
* <GridColumn filterable={false} />
|
|
1091
|
+
* ```
|
|
1050
1092
|
* @default true
|
|
1051
1093
|
*/
|
|
1052
1094
|
filterable?: boolean;
|
|
1053
1095
|
/**
|
|
1054
1096
|
* Defines the title which will be set to the input element in the filter cell.
|
|
1097
|
+
*
|
|
1098
|
+
* @example
|
|
1099
|
+
* ```jsx
|
|
1100
|
+
* <GridColumn filterTitle="Custom Filter Title" />
|
|
1101
|
+
* ```
|
|
1055
1102
|
*/
|
|
1056
1103
|
filterTitle?: string;
|
|
1057
1104
|
/**
|
|
1058
1105
|
* Defines the filter type that will be rendered inside the filter row.
|
|
1059
1106
|
*
|
|
1107
|
+
* @example
|
|
1108
|
+
* ```jsx
|
|
1109
|
+
* <GridColumn filter="numeric" />
|
|
1110
|
+
* ```
|
|
1060
1111
|
* @default 'text'
|
|
1061
1112
|
*/
|
|
1062
1113
|
filter?: GridDataType;
|
|
1063
1114
|
/**
|
|
1064
1115
|
* Defines the editor type. Used when the column enters the edit mode ([more information and examples]({% slug editing_inline_grid %})).
|
|
1065
1116
|
*
|
|
1117
|
+
* @example
|
|
1118
|
+
* ```jsx
|
|
1119
|
+
* <GridColumn editor="date" />
|
|
1120
|
+
* ```
|
|
1066
1121
|
* @default 'text'
|
|
1067
1122
|
*/
|
|
1068
1123
|
editor?: GridDataType;
|
|
1069
1124
|
/**
|
|
1070
|
-
* Overrides the default(three vertical dots) column menu icon or the icon set through the ([`columnMenuIcon`]({% slug api_grid_gridprops %}#toc-columnmenuicon)) property.
|
|
1125
|
+
* Overrides the default (three vertical dots) column menu icon or the icon set through the ([`columnMenuIcon`]({% slug api_grid_gridprops %}#toc-columnmenuicon)) property.
|
|
1126
|
+
*
|
|
1127
|
+
* @example
|
|
1128
|
+
* ```jsx
|
|
1129
|
+
* <GridColumn menuIcon={CustomIcon} />
|
|
1130
|
+
* ```
|
|
1071
1131
|
*/
|
|
1072
1132
|
menuIcon?: SVGIcon;
|
|
1073
1133
|
/**
|
|
1074
|
-
* Sets the colSpan of the column which will make the row content
|
|
1075
|
-
* As arguments it takes either a number or a function that returns a number
|
|
1134
|
+
* Sets the colSpan of the column which will make the row content span over multiple cells.
|
|
1135
|
+
* As arguments, it takes either a number or a function that returns a number.
|
|
1076
1136
|
*
|
|
1137
|
+
* @example
|
|
1138
|
+
* ```jsx
|
|
1139
|
+
* <GridColumn colSpan={2} />
|
|
1140
|
+
* ```
|
|
1077
1141
|
* @default 1
|
|
1078
1142
|
*/
|
|
1079
1143
|
colSpan?: number | ((colSpanProps: GridColSpanProps) => number);
|
|
1080
1144
|
/**
|
|
1081
|
-
*
|
|
1145
|
+
* Controls the visibility of the Grid's column.
|
|
1082
1146
|
*
|
|
1147
|
+
* @example
|
|
1148
|
+
* ```jsx
|
|
1149
|
+
* <GridColumn hidden={true} />
|
|
1150
|
+
* ```
|
|
1083
1151
|
* @default false
|
|
1084
1152
|
*/
|
|
1085
1153
|
hidden?: boolean;
|
|
1086
1154
|
/**
|
|
1087
1155
|
* Sets the screen size condition that needs to be satisfied for a column to remain visible. If you set the hidden property, the behavior of media is overridden.
|
|
1156
|
+
*
|
|
1157
|
+
* @example
|
|
1158
|
+
* ```jsx
|
|
1159
|
+
* <GridColumn media="(min-width: 600px)" />
|
|
1160
|
+
* ```
|
|
1088
1161
|
*/
|
|
1089
1162
|
media?: string;
|
|
1090
1163
|
/**
|
|
1091
1164
|
* Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
|
|
1092
1165
|
*
|
|
1093
1166
|
* @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.
|
|
1167
|
+
* @example
|
|
1168
|
+
* ```jsx
|
|
1169
|
+
* <GridColumn cell={CustomCell} />
|
|
1170
|
+
* ```
|
|
1094
1171
|
*/
|
|
1095
1172
|
cell?: ComponentType<GridCellProps>;
|
|
1096
1173
|
/**
|
|
1097
|
-
*
|
|
1174
|
+
* Specifies a set of cell components that the Grid will render instead of the built-in cell.
|
|
1175
|
+
*
|
|
1176
|
+
* @example
|
|
1177
|
+
* ```jsx
|
|
1178
|
+
* <GridColumn cells={{ data: CustomDataCell }} />
|
|
1179
|
+
* ```
|
|
1098
1180
|
*/
|
|
1099
1181
|
cells?: GridCellsSettings;
|
|
1100
1182
|
/**
|
|
1101
1183
|
* Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
|
|
1102
1184
|
*
|
|
1103
1185
|
* @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.
|
|
1186
|
+
* @example
|
|
1187
|
+
* ```jsx
|
|
1188
|
+
* <GridColumn filterCell={CustomFilterCell} />
|
|
1189
|
+
* ```
|
|
1104
1190
|
*/
|
|
1105
1191
|
filterCell?: ComponentType<GridFilterCellProps>;
|
|
1106
1192
|
/**
|
|
1107
1193
|
* Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
|
|
1108
1194
|
*
|
|
1109
1195
|
* @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.
|
|
1196
|
+
* @example
|
|
1197
|
+
* ```jsx
|
|
1198
|
+
* <GridColumn headerCell={CustomHeaderCell} />
|
|
1199
|
+
* ```
|
|
1110
1200
|
*/
|
|
1111
1201
|
headerCell?: ComponentType<GridHeaderCellProps>;
|
|
1112
1202
|
/**
|
|
@@ -1128,11 +1218,20 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1128
1218
|
/**
|
|
1129
1219
|
* Sets the type of the column and renders a dedicated column for interaction.
|
|
1130
1220
|
*
|
|
1221
|
+
* @example
|
|
1222
|
+
* ```jsx
|
|
1223
|
+
* <GridColumn columnType="checkbox" />
|
|
1224
|
+
* ```
|
|
1131
1225
|
* @default "data"
|
|
1132
1226
|
*/
|
|
1133
1227
|
columnType?: GridColumnType;
|
|
1134
1228
|
/**
|
|
1135
1229
|
* Defines if the cells of the column should be spanned when their values are the same.
|
|
1230
|
+
*
|
|
1231
|
+
* @example
|
|
1232
|
+
* ```jsx
|
|
1233
|
+
* <GridColumn rowSpannable={true} />
|
|
1234
|
+
* ```
|
|
1136
1235
|
*/
|
|
1137
1236
|
rowSpannable?: boolean | GridRowSpannableSettings;
|
|
1138
1237
|
}
|
|
@@ -1267,11 +1366,12 @@ export declare type GridColumnType = 'data' | 'reorder' | 'checkbox';
|
|
|
1267
1366
|
* @hidden
|
|
1268
1367
|
*/
|
|
1269
1368
|
export declare class GridCommonDragLogic {
|
|
1270
|
-
refDragElementClue: React_2.RefObject<DragClue>;
|
|
1271
|
-
refDropElementClue: React_2.RefObject<DropClue>;
|
|
1369
|
+
refDragElementClue: React_2.RefObject<DragClue | null>;
|
|
1370
|
+
refDropElementClue: React_2.RefObject<DropClue | null>;
|
|
1272
1371
|
columns: ExtendedColumnProps[];
|
|
1273
1372
|
reorderable: boolean;
|
|
1274
1373
|
groupable: boolean;
|
|
1374
|
+
dir: string | undefined;
|
|
1275
1375
|
private startColumn;
|
|
1276
1376
|
private startGroup;
|
|
1277
1377
|
private currentColumn;
|
|
@@ -1301,7 +1401,7 @@ export declare class GridCommonDragLogic {
|
|
|
1301
1401
|
/**
|
|
1302
1402
|
* @hidden
|
|
1303
1403
|
*/
|
|
1304
|
-
export declare const GridContextMenu: (props: GridContextMenuProps) =>
|
|
1404
|
+
export declare const GridContextMenu: (props: GridContextMenuProps) => JSX.Element;
|
|
1305
1405
|
|
|
1306
1406
|
/**
|
|
1307
1407
|
* Represents the available types for the `GridContextMenuAnchorPart`.
|
|
@@ -1587,7 +1687,7 @@ declare interface GridEditableSettings extends TableEditableSettings {
|
|
|
1587
1687
|
/**
|
|
1588
1688
|
* @hidden
|
|
1589
1689
|
*/
|
|
1590
|
-
export declare const GridEditCell: (props: GridCellProps) =>
|
|
1690
|
+
export declare const GridEditCell: (props: GridCellProps) => JSX.Element;
|
|
1591
1691
|
|
|
1592
1692
|
/**
|
|
1593
1693
|
* Represents the object of the `onEditChange` Grid event.
|
|
@@ -1620,7 +1720,7 @@ export declare interface GridExpandChangeEvent extends GridEvent {
|
|
|
1620
1720
|
dataIndex: number;
|
|
1621
1721
|
}
|
|
1622
1722
|
|
|
1623
|
-
export declare const GridFilterCell: (props: GridFilterCellProps) => string | number | boolean | Iterable<React_2.ReactNode> |
|
|
1723
|
+
export declare const GridFilterCell: (props: GridFilterCellProps) => string | number | bigint | boolean | Iterable<React_2.ReactNode> | Promise<string | number | bigint | boolean | React_2.ReactPortal | React_2.ReactElement<unknown, string | React_2.JSXElementConstructor<any>> | Iterable<React_2.ReactNode> | null | undefined> | JSX.Element | null | undefined;
|
|
1624
1724
|
|
|
1625
1725
|
/**
|
|
1626
1726
|
* The props of the GridFilterCell component
|
|
@@ -1795,7 +1895,7 @@ export declare interface GridGroupableSettings {
|
|
|
1795
1895
|
/**
|
|
1796
1896
|
* @hidden
|
|
1797
1897
|
*/
|
|
1798
|
-
export declare const GridGroupCell: (props: GridCellProps) =>
|
|
1898
|
+
export declare const GridGroupCell: (props: GridCellProps) => JSX.Element;
|
|
1799
1899
|
|
|
1800
1900
|
/**
|
|
1801
1901
|
* Represents the object of the `onGroupChange` Grid event.
|
|
@@ -1914,7 +2014,7 @@ export declare interface GridHandle {
|
|
|
1914
2014
|
* export default App;
|
|
1915
2015
|
* ```
|
|
1916
2016
|
*/
|
|
1917
|
-
export declare const GridHeaderCell: (props: GridHeaderCellProps) => string | number | boolean | Iterable<React_2.ReactNode> |
|
|
2017
|
+
export declare const GridHeaderCell: (props: GridHeaderCellProps) => string | number | bigint | boolean | Iterable<React_2.ReactNode> | Promise<string | number | bigint | boolean | React_2.ReactPortal | React_2.ReactElement<unknown, string | React_2.JSXElementConstructor<any>> | Iterable<React_2.ReactNode> | null | undefined> | JSX.Element | null | undefined;
|
|
1918
2018
|
|
|
1919
2019
|
/**
|
|
1920
2020
|
* The props of the GridHeaderCell component
|
|
@@ -1960,7 +2060,7 @@ export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
|
1960
2060
|
/**
|
|
1961
2061
|
* @hidden
|
|
1962
2062
|
*/
|
|
1963
|
-
export declare const GridHierarchyCell: (props: GridCellProps) =>
|
|
2063
|
+
export declare const GridHierarchyCell: (props: GridCellProps) => JSX.Element;
|
|
1964
2064
|
|
|
1965
2065
|
/**
|
|
1966
2066
|
* Represents the object of the `onItemChange` Grid event.
|
|
@@ -2086,7 +2186,7 @@ export declare interface GridNavigationActionEvent extends GridEvent {
|
|
|
2086
2186
|
* ```
|
|
2087
2187
|
*/
|
|
2088
2188
|
export declare const GridNoRecords: {
|
|
2089
|
-
(props: GridNoRecordsProps):
|
|
2189
|
+
(props: GridNoRecordsProps): JSX.Element;
|
|
2090
2190
|
displayName: string;
|
|
2091
2191
|
};
|
|
2092
2192
|
|
|
@@ -2112,7 +2212,7 @@ export declare interface GridPageChangeEvent extends GridEvent {
|
|
|
2112
2212
|
* The pager settings of the Grid ([see example]({% slug paging_grid %})).
|
|
2113
2213
|
*
|
|
2114
2214
|
* @example
|
|
2115
|
-
* ```
|
|
2215
|
+
* ```jsx-no-run
|
|
2116
2216
|
*
|
|
2117
2217
|
* <Grid
|
|
2118
2218
|
* pageable="{{
|
|
@@ -2166,7 +2266,7 @@ export declare interface GridPagerSettings {
|
|
|
2166
2266
|
* * `input`—Input for typing the page number.
|
|
2167
2267
|
*
|
|
2168
2268
|
* @example
|
|
2169
|
-
* ```
|
|
2269
|
+
* ```jsx-no-run
|
|
2170
2270
|
*
|
|
2171
2271
|
* <Grid
|
|
2172
2272
|
* pageable="{{
|
|
@@ -2182,10 +2282,23 @@ declare type GridPagerType = 'numeric' | 'input';
|
|
|
2182
2282
|
*/
|
|
2183
2283
|
export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
2184
2284
|
/**
|
|
2185
|
-
* Enables data-processing inside the GridComponent based on
|
|
2285
|
+
* Enables data-processing inside the GridComponent based on its state.
|
|
2186
2286
|
* Provides an easy, built-in way to handle data operations like sorting, filtering, grouping, and paging.
|
|
2187
2287
|
*
|
|
2188
2288
|
* @default false
|
|
2289
|
+
*
|
|
2290
|
+
* @example
|
|
2291
|
+
* ```jsx
|
|
2292
|
+
* <Grid
|
|
2293
|
+
* autoProcessData={{
|
|
2294
|
+
* filter: true,
|
|
2295
|
+
* search: true,
|
|
2296
|
+
* sort: true,
|
|
2297
|
+
* group: true,
|
|
2298
|
+
* page: true
|
|
2299
|
+
* }}
|
|
2300
|
+
* />
|
|
2301
|
+
* ```
|
|
2189
2302
|
*/
|
|
2190
2303
|
autoProcessData?: boolean | {
|
|
2191
2304
|
filter?: boolean;
|
|
@@ -2196,109 +2309,272 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2196
2309
|
};
|
|
2197
2310
|
/**
|
|
2198
2311
|
* Sets the Grid row key prop to the value of this field in the dataItem.
|
|
2199
|
-
* If not set, the dataItem index will be used for the row key, which might lead to
|
|
2312
|
+
* If not set, the dataItem index will be used for the row key, which might lead to rows not updating during paging or scrolling.
|
|
2313
|
+
*
|
|
2314
|
+
* @example
|
|
2315
|
+
* ```jsx
|
|
2316
|
+
* <Grid dataItemKey="id" />
|
|
2317
|
+
* ```
|
|
2200
2318
|
*/
|
|
2201
2319
|
dataItemKey?: string;
|
|
2202
2320
|
/**
|
|
2203
|
-
* Sets a class
|
|
2321
|
+
* Sets a class for the Grid DOM element.
|
|
2322
|
+
*
|
|
2323
|
+
* @example
|
|
2324
|
+
* ```jsx
|
|
2325
|
+
* <Grid className="custom-grid-class" />
|
|
2326
|
+
* ```
|
|
2204
2327
|
*/
|
|
2205
2328
|
className?: string;
|
|
2206
2329
|
/**
|
|
2207
|
-
*
|
|
2330
|
+
* Defines a set of custom cell components that the Grid will render instead of the default cells.
|
|
2331
|
+
*
|
|
2332
|
+
* @example
|
|
2333
|
+
* ```jsx
|
|
2334
|
+
* import { GridCustomCellProps } from '@progress/kendo-react-grid';
|
|
2335
|
+
*
|
|
2336
|
+
* const CustomCell = (props: GridCustomCellProps) => (
|
|
2337
|
+
* <td {...props.tdProps}>
|
|
2338
|
+
* {props.dataItem[props.field]}
|
|
2339
|
+
* </td>
|
|
2340
|
+
* );
|
|
2341
|
+
*
|
|
2342
|
+
* <Grid
|
|
2343
|
+
* cells={{
|
|
2344
|
+
* data: CustomCell
|
|
2345
|
+
* }}
|
|
2346
|
+
* />
|
|
2347
|
+
* ```
|
|
2208
2348
|
*/
|
|
2209
2349
|
cells?: GridCellsSettings;
|
|
2210
2350
|
/**
|
|
2211
|
-
*
|
|
2351
|
+
*
|
|
2352
|
+
* @example
|
|
2353
|
+
* ```jsx
|
|
2354
|
+
* import { GridCustomRowProps } from '@progress/kendo-react-grid';
|
|
2355
|
+
*
|
|
2356
|
+
* const CustomRow = (props: GridCustomRowProps) => (
|
|
2357
|
+
* <tr {...props.trProps} style={{ backgroundColor: props.dataItem?.highlight ? 'yellow' : 'white' }}>
|
|
2358
|
+
* {props.children}
|
|
2359
|
+
* </tr>
|
|
2360
|
+
* );
|
|
2361
|
+
*
|
|
2362
|
+
* <Grid
|
|
2363
|
+
* rows={{
|
|
2364
|
+
* data: CustomRow
|
|
2365
|
+
* }}
|
|
2366
|
+
* />
|
|
2367
|
+
* ```
|
|
2212
2368
|
*/
|
|
2213
2369
|
rows?: GridRowsSettings;
|
|
2214
2370
|
/**
|
|
2215
2371
|
* 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%})
|
|
2372
|
+
* Accepts values of type `null`, `any[]`, or `DataResult`.
|
|
2373
|
+
*
|
|
2374
|
+
* @example
|
|
2375
|
+
* ```jsx
|
|
2376
|
+
* <Grid data={data} />
|
|
2377
|
+
* ```
|
|
2216
2378
|
*/
|
|
2217
2379
|
data?: any[] | DataResult | null;
|
|
2218
2380
|
/**
|
|
2219
|
-
* Enables
|
|
2381
|
+
* Enables sorting for the columns with their `field` option set.
|
|
2382
|
+
* ([see example]({% slug sorting_grid %}))
|
|
2383
|
+
*
|
|
2384
|
+
* @example
|
|
2385
|
+
* ```jsx
|
|
2386
|
+
* <Grid sortable={true} />
|
|
2387
|
+
* ```
|
|
2220
2388
|
*/
|
|
2221
2389
|
sortable?: GridSortSettings;
|
|
2222
2390
|
/**
|
|
2223
|
-
*
|
|
2391
|
+
* Enables clipboard copy, cut, and paste manipulations. Accepts `ClipboardSettings` or a boolean value.
|
|
2392
|
+
*
|
|
2393
|
+
* @example
|
|
2394
|
+
* ```jsx
|
|
2395
|
+
* <Grid clipboard={true} />
|
|
2396
|
+
* ```
|
|
2224
2397
|
*/
|
|
2225
2398
|
clipboard?: ClipboardSettings | boolean;
|
|
2226
2399
|
/**
|
|
2227
|
-
* Fires when clipboard support is enabled and
|
|
2400
|
+
* Fires when clipboard support is enabled, and one of the actions (e.g., copy) is triggered.
|
|
2401
|
+
* Accepts a `GridClipboardEvent` object.
|
|
2402
|
+
*
|
|
2403
|
+
* @example
|
|
2404
|
+
* ```jsx
|
|
2405
|
+
* <Grid
|
|
2406
|
+
* clipboard={true}
|
|
2407
|
+
* onClipboard={(event) => console.log('Clipboard action:', event.action)}
|
|
2408
|
+
* />
|
|
2409
|
+
* ```
|
|
2228
2410
|
*/
|
|
2229
2411
|
onClipboard?: (event: GridClipboardEvent) => void;
|
|
2230
2412
|
/**
|
|
2231
|
-
* Fires when the sorting of the Grid is changed
|
|
2413
|
+
* Fires when the sorting of the Grid is changed. You must handle the event and sort the data.
|
|
2414
|
+
* ([see example]({% slug sorting_grid %}))
|
|
2415
|
+
*
|
|
2416
|
+
* @example
|
|
2417
|
+
* ```jsx
|
|
2418
|
+
* <Grid
|
|
2419
|
+
* sortable={true}
|
|
2420
|
+
* onSortChange={(event) => console.log('Sort changed:', event.sort)}
|
|
2421
|
+
* />
|
|
2422
|
+
* ```
|
|
2232
2423
|
*/
|
|
2233
2424
|
onSortChange?: (event: GridSortChangeEvent) => void;
|
|
2234
2425
|
/**
|
|
2235
2426
|
* The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
|
|
2427
|
+
*
|
|
2428
|
+
* @example
|
|
2429
|
+
* ```jsx
|
|
2430
|
+
* <Grid sort={[{ field: 'name', dir: 'asc' }]} />
|
|
2431
|
+
* ```
|
|
2236
2432
|
*/
|
|
2237
2433
|
sort?: SortDescriptor[];
|
|
2238
2434
|
/**
|
|
2239
|
-
* The default `sort` state
|
|
2435
|
+
* The default `sort` state applied to the Grid when using uncontrolled mode.
|
|
2436
|
+
* ([see example]({% slug sorting_grid %}))
|
|
2437
|
+
*
|
|
2438
|
+
* @example
|
|
2439
|
+
* ```jsx
|
|
2440
|
+
* <Grid defaultSort={[{ field: 'name', dir: 'asc' }]} />
|
|
2441
|
+
* ```
|
|
2240
2442
|
*/
|
|
2241
2443
|
defaultSort?: SortDescriptor[];
|
|
2242
2444
|
/**
|
|
2243
|
-
* Enables
|
|
2445
|
+
* Enables filtering for the columns with their `field` option set.
|
|
2446
|
+
*
|
|
2447
|
+
* @example
|
|
2448
|
+
* ```jsx
|
|
2449
|
+
* <Grid filterable={true} />
|
|
2450
|
+
* ```
|
|
2244
2451
|
*/
|
|
2245
2452
|
filterable?: boolean;
|
|
2246
2453
|
/**
|
|
2247
|
-
* The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which
|
|
2454
|
+
* The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which
|
|
2455
|
+
* the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects
|
|
2456
|
+
* the values and buttons in the `FilterRow` of the Grid.
|
|
2457
|
+
*
|
|
2458
|
+
* @example
|
|
2459
|
+
* ```jsx
|
|
2460
|
+
* <Grid filter={{ logic: 'and', filters: [{ field: 'name', operator: 'contains', value: 'John' }] }} />
|
|
2461
|
+
* ```
|
|
2248
2462
|
*/
|
|
2249
2463
|
filter?: CompositeFilterDescriptor;
|
|
2250
2464
|
/**
|
|
2251
|
-
* The default `filter` state
|
|
2465
|
+
* The default `filter` state applied to the Grid when using uncontrolled mode.
|
|
2466
|
+
*
|
|
2467
|
+
* @example
|
|
2468
|
+
* ```jsx
|
|
2469
|
+
* <Grid defaultFilter={{ logic: 'and', filters: [{ field: 'name', operator: 'contains', value: 'John' }] }} />
|
|
2470
|
+
* ```
|
|
2252
2471
|
*/
|
|
2253
2472
|
defaultFilter?: CompositeFilterDescriptor;
|
|
2254
2473
|
/**
|
|
2255
2474
|
* The filter operators for the Grid filters.
|
|
2475
|
+
*
|
|
2476
|
+
* @example
|
|
2477
|
+
* ```jsx
|
|
2478
|
+
* <Grid filterOperators={{ text: [{ text: 'grid.filterContainsOperator', operator: 'contains' }] }} />
|
|
2479
|
+
* ```
|
|
2256
2480
|
*/
|
|
2257
2481
|
filterOperators?: GridFilterOperators;
|
|
2258
2482
|
/**
|
|
2259
|
-
* Fires when the Grid filter is modified through the UI
|
|
2483
|
+
* Fires when the Grid filter is modified through the UI. You must handle the event and filter the data.
|
|
2484
|
+
*
|
|
2485
|
+
* @example
|
|
2486
|
+
* ```jsx
|
|
2487
|
+
* <Grid
|
|
2488
|
+
* filterable={true}
|
|
2489
|
+
* onFilterChange={(event) => console.log('Filter changed:', event.filter)}
|
|
2490
|
+
* />
|
|
2491
|
+
* ```
|
|
2260
2492
|
*/
|
|
2261
2493
|
onFilterChange?: (event: GridFilterChangeEvent) => void;
|
|
2262
2494
|
/**
|
|
2263
|
-
* Specifies
|
|
2495
|
+
* Specifies whether the loader of the Grid will be displayed.
|
|
2496
|
+
*
|
|
2497
|
+
* @example
|
|
2498
|
+
* ```jsx
|
|
2499
|
+
* <Grid
|
|
2500
|
+
* showLoader={true}
|
|
2501
|
+
* loader={<div>Loading...</div>}
|
|
2502
|
+
* />
|
|
2503
|
+
* ```
|
|
2264
2504
|
*/
|
|
2265
2505
|
showLoader?: boolean;
|
|
2266
2506
|
/**
|
|
2267
2507
|
* A custom component that the Grid will render instead of the built-in loader.
|
|
2508
|
+
*
|
|
2509
|
+
* @example
|
|
2510
|
+
* ```jsx
|
|
2511
|
+
* <Grid loader={<div>Custom Loader...</div>} />
|
|
2512
|
+
* ```
|
|
2268
2513
|
*/
|
|
2269
2514
|
loader?: React.ReactNode;
|
|
2270
2515
|
/**
|
|
2271
2516
|
* Fires when the user reorders a row.
|
|
2517
|
+
*
|
|
2518
|
+
* @example
|
|
2519
|
+
* ```jsx
|
|
2520
|
+
* <Grid onRowReorder={(event) => console.log('Row reordered:', event)} />
|
|
2521
|
+
* ```
|
|
2272
2522
|
*/
|
|
2273
2523
|
onRowReorder?: (event: GridRowReorderEvent) => void;
|
|
2274
2524
|
/**
|
|
2275
|
-
* Specifies a React element that will be cloned and rendered inside the column menu of the Grid.
|
|
2525
|
+
* Specifies a React element that will be cloned and rendered inside the column menu of the Grid.
|
|
2526
|
+
*
|
|
2527
|
+
* @example
|
|
2528
|
+
* ```jsx
|
|
2529
|
+
* <Grid columnMenu={() => <div>Custom Column Menu</div>} />
|
|
2530
|
+
* ```
|
|
2276
2531
|
*/
|
|
2277
2532
|
columnMenu?: null | ComponentType<GridColumnMenuProps>;
|
|
2278
2533
|
/**
|
|
2279
|
-
* Specifies the
|
|
2534
|
+
* Specifies the context menu settings applied to the Grid.
|
|
2535
|
+
*
|
|
2536
|
+
* @example
|
|
2537
|
+
* ```jsx
|
|
2538
|
+
* <Grid contextMenu={true} />
|
|
2539
|
+
* ```
|
|
2280
2540
|
*/
|
|
2281
2541
|
contextMenu?: boolean | GridContextMenuOptions | ((options: GridCellBaseOptions) => boolean | GridContextMenuOptions);
|
|
2282
2542
|
/**
|
|
2283
|
-
* Globally overrides the default(three vertical dots) column menu icon for the whole Grid. If set, the prop can be overridden on column level
|
|
2543
|
+
* Globally overrides the default (three vertical dots) column menu icon for the whole Grid. If set, the prop can be overridden on column level
|
|
2544
|
+
* using the ([menuIcon]({% slug api_grid_gridcolumnprops %}#toc-menuicon)) property.
|
|
2284
2545
|
*/
|
|
2285
2546
|
columnMenuIcon?: SVGIcon_2;
|
|
2286
2547
|
/**
|
|
2287
2548
|
* The [descriptors]({% slug api_kendo-data-query_groupdescriptor %})[] by which the data will be grouped
|
|
2288
2549
|
* ([more information and examples]({% slug groupingbasics_grid %})).
|
|
2550
|
+
*
|
|
2551
|
+
* @example
|
|
2552
|
+
* ```jsx
|
|
2553
|
+
* <Grid group={[{ field: 'CategoryName' }]} />
|
|
2554
|
+
* ```
|
|
2289
2555
|
*/
|
|
2290
2556
|
group?: GroupDescriptor[];
|
|
2291
2557
|
/**
|
|
2292
|
-
* The default `group` state
|
|
2558
|
+
* The default `group` state applied to the Grid when using uncontrolled mode.
|
|
2559
|
+
*
|
|
2560
|
+
* @example
|
|
2561
|
+
* ```jsx
|
|
2562
|
+
* <Grid defaultGroup={[{ field: 'CategoryName' }]} />
|
|
2563
|
+
* ```
|
|
2293
2564
|
*/
|
|
2294
2565
|
defaultGroup?: GroupDescriptor[];
|
|
2295
2566
|
/**
|
|
2296
2567
|
* Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
|
|
2297
2568
|
* ([more information and examples]({% slug groupingbasics_grid %})).
|
|
2569
|
+
*
|
|
2570
|
+
* @example
|
|
2571
|
+
* ```jsx
|
|
2572
|
+
* <Grid onGroupChange={(event) => console.log('Group changed:', event.group)} />
|
|
2573
|
+
* ```
|
|
2298
2574
|
*/
|
|
2299
2575
|
onGroupChange?: (event: GridGroupChangeEvent) => void;
|
|
2300
2576
|
/**
|
|
2301
|
-
* Configures the pager of the Grid ([see example]({% slug paging_grid %}))
|
|
2577
|
+
* Configures the pager of the Grid. Accepts `GridPagerSettings` or a boolean value.([see example]({% slug paging_grid %}))
|
|
2302
2578
|
*
|
|
2303
2579
|
* The available options are:
|
|
2304
2580
|
* - `buttonCount: Number`—Sets the maximum numeric buttons count before the buttons are collapsed.
|
|
@@ -2307,66 +2583,143 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2307
2583
|
* - `pageSizes: Boolean` or `Array<number>`—Shows a menu for selecting the page size.
|
|
2308
2584
|
* - `previousNext: Boolean`—Toggles the **Previous** and **Next** buttons.
|
|
2309
2585
|
* - `navigatable: Boolean`—Defines if the pager will be navigatable.
|
|
2586
|
+
*
|
|
2587
|
+
* @example
|
|
2588
|
+
* ```jsx
|
|
2589
|
+
* <Grid pageable={{ pageSizes: true }} />
|
|
2590
|
+
* ```
|
|
2310
2591
|
*/
|
|
2311
2592
|
pageable?: GridPagerSettings | boolean;
|
|
2312
2593
|
/**
|
|
2313
|
-
* Defines the page size
|
|
2594
|
+
* Defines the page size used by the Grid pager. Required for paging functionality.
|
|
2595
|
+
*
|
|
2596
|
+
* @example
|
|
2597
|
+
* ```jsx
|
|
2598
|
+
* <Grid pageSize={10} />
|
|
2599
|
+
* ```
|
|
2314
2600
|
*/
|
|
2315
2601
|
pageSize?: number;
|
|
2316
2602
|
/**
|
|
2317
|
-
* The pager component that the Grid will render instead of the built-in pager.
|
|
2603
|
+
* The pager component that the Grid will render instead of the built-in pager.
|
|
2604
|
+
* It takes values of type null and ComponentType<[PagerProps]({% slug api_data-tools_pagerprops %})>
|
|
2605
|
+
*
|
|
2606
|
+
* @example
|
|
2607
|
+
* ```jsx
|
|
2608
|
+
* <Grid pager={() => <div>Custom Pager</div>} />
|
|
2609
|
+
* ```
|
|
2318
2610
|
*/
|
|
2319
2611
|
pager?: null | ComponentType<PagerProps>;
|
|
2320
2612
|
/**
|
|
2321
|
-
* Alias
|
|
2613
|
+
* Alias for the `pageSize` property. If `take` is set, `pageSize` will be ignored.
|
|
2614
|
+
*
|
|
2615
|
+
* @example
|
|
2616
|
+
* ```jsx
|
|
2617
|
+
* <Grid take={20} />
|
|
2618
|
+
* ```
|
|
2322
2619
|
*/
|
|
2323
2620
|
take?: number;
|
|
2324
2621
|
/**
|
|
2325
|
-
* The default `take` state
|
|
2622
|
+
* The default `take` state applied to the Grid when using uncontrolled mode.
|
|
2623
|
+
*
|
|
2624
|
+
* @example
|
|
2625
|
+
* ```jsx
|
|
2626
|
+
* <Grid defaultTake={20} />
|
|
2627
|
+
* ```
|
|
2326
2628
|
*/
|
|
2327
2629
|
defaultTake?: number;
|
|
2328
2630
|
/**
|
|
2329
|
-
* Fires when the page of the Grid is changed
|
|
2631
|
+
* Fires when the page of the Grid is changed.
|
|
2632
|
+
*
|
|
2633
|
+
* @example
|
|
2634
|
+
* ```jsx
|
|
2635
|
+
* <Grid onPageChange={(event) => console.log('Page changed:', event.page)} />
|
|
2636
|
+
* ```
|
|
2330
2637
|
*/
|
|
2331
2638
|
onPageChange?: (event: GridPageChangeEvent) => void;
|
|
2332
2639
|
/**
|
|
2333
|
-
* Defines the total number of data items in all pages
|
|
2640
|
+
* Defines the total number of data items in all pages. Required for paging functionality.
|
|
2641
|
+
*
|
|
2642
|
+
* @example
|
|
2643
|
+
* ```jsx
|
|
2644
|
+
* <Grid total={100} />
|
|
2645
|
+
* ```
|
|
2334
2646
|
*/
|
|
2335
2647
|
total?: number;
|
|
2336
2648
|
/**
|
|
2337
2649
|
* Defines the number of records that will be skipped by the pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
|
|
2650
|
+
*
|
|
2651
|
+
* @example
|
|
2652
|
+
* ```jsx
|
|
2653
|
+
* <Grid skip={10} />
|
|
2654
|
+
* ```
|
|
2338
2655
|
*/
|
|
2339
2656
|
skip?: number;
|
|
2340
2657
|
/**
|
|
2341
|
-
* The default `skip` state
|
|
2658
|
+
* The default `skip` state applied to the Grid when using uncontrolled mode.
|
|
2659
|
+
*
|
|
2660
|
+
* @example
|
|
2661
|
+
* ```jsx
|
|
2662
|
+
* <Grid defaultSkip={10} />
|
|
2663
|
+
* ```
|
|
2342
2664
|
*/
|
|
2343
2665
|
defaultSkip?: number;
|
|
2344
2666
|
/**
|
|
2345
|
-
* Determines if the scroll position will be updated after data change.
|
|
2667
|
+
* Determines if the scroll position will be updated after a data change.
|
|
2668
|
+
* If set to `true`, the scroll will remain in the same position.
|
|
2346
2669
|
*/
|
|
2347
2670
|
fixedScroll?: boolean;
|
|
2348
2671
|
/**
|
|
2349
|
-
* The
|
|
2672
|
+
* The descriptor by which the detail row is expanded.
|
|
2673
|
+
*
|
|
2674
|
+
* @example
|
|
2675
|
+
* ```jsx
|
|
2676
|
+
* <Grid detailExpand={{ ['item-data-key-id']: true }} />
|
|
2677
|
+
* ```
|
|
2350
2678
|
*/
|
|
2351
2679
|
detailExpand?: DetailExpandDescriptor;
|
|
2352
2680
|
/**
|
|
2353
|
-
* The default `detailExpand` state
|
|
2681
|
+
* The default `detailExpand` state applied to the Grid when using uncontrolled mode.
|
|
2682
|
+
*
|
|
2683
|
+
* @example
|
|
2684
|
+
* ```jsx
|
|
2685
|
+
* <Grid defaultDetailExpand={{ ['item-data-key-id']: true }} />
|
|
2686
|
+
* ```
|
|
2354
2687
|
*/
|
|
2355
2688
|
defaultDetailExpand?: DetailExpandDescriptor;
|
|
2356
2689
|
/**
|
|
2357
|
-
* Fires when the user
|
|
2690
|
+
* Fires when the user expands or collapses a detail row.
|
|
2691
|
+
*
|
|
2692
|
+
* @example
|
|
2693
|
+
* ```jsx
|
|
2694
|
+
* <Grid onDetailExpandChange={(event) => console.log('Detail expand changed:', event)} />
|
|
2695
|
+
* ```
|
|
2358
2696
|
*/
|
|
2359
2697
|
onDetailExpandChange?: (event: GridDetailExpandChangeEvent) => void;
|
|
2360
2698
|
/**
|
|
2361
|
-
* The
|
|
2699
|
+
* The descriptor by which the group is expanded.
|
|
2700
|
+
*
|
|
2701
|
+
* @example
|
|
2702
|
+
* ```jsx
|
|
2703
|
+
* <Grid groupExpand={[{ field: 'CategoryName', expanded: true }]} />
|
|
2704
|
+
* ```
|
|
2362
2705
|
*/
|
|
2363
2706
|
groupExpand?: GroupExpandDescriptor[];
|
|
2364
2707
|
/**
|
|
2365
|
-
* The default `groupExpand` state
|
|
2708
|
+
* The default `groupExpand` state applied to the Grid when using uncontrolled mode.
|
|
2709
|
+
*
|
|
2710
|
+
* @example
|
|
2711
|
+
* ```jsx
|
|
2712
|
+
* <Grid defaultGroupExpand={[{ field: 'CategoryName', expanded: true }]} />
|
|
2713
|
+
* ```
|
|
2366
2714
|
*/
|
|
2367
2715
|
defaultGroupExpand?: GroupExpandDescriptor[];
|
|
2368
2716
|
/**
|
|
2369
|
-
* Fires when the user expands or
|
|
2717
|
+
* Fires when the user expands or collapses a group.
|
|
2718
|
+
*
|
|
2719
|
+
* @example
|
|
2720
|
+
* ```jsx
|
|
2721
|
+
* <Grid onGroupExpandChange={(event) => console.log('Group expand changed:', event)} />
|
|
2722
|
+
* ```
|
|
2370
2723
|
*/
|
|
2371
2724
|
onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
|
|
2372
2725
|
/**
|
|
@@ -2374,26 +2727,45 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2374
2727
|
*
|
|
2375
2728
|
* @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.
|
|
2376
2729
|
* We’re removing this prop in version 11.0.0.
|
|
2730
|
+
* ```
|
|
2377
2731
|
*/
|
|
2378
2732
|
onExpandChange?: (event: GridExpandChangeEvent) => void;
|
|
2379
2733
|
/**
|
|
2734
|
+
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
|
|
2735
|
+
*
|
|
2380
2736
|
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
|
|
2381
2737
|
*
|
|
2382
2738
|
* @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.
|
|
2383
2739
|
* We’re removing this prop in version 11.0.0.
|
|
2740
|
+
* ```
|
|
2384
2741
|
*/
|
|
2385
2742
|
expandField?: string;
|
|
2386
2743
|
/**
|
|
2387
2744
|
* The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
|
|
2388
2745
|
* Passing a boolean value will select the whole row, while passing an array of strings will select individual.
|
|
2746
|
+
*
|
|
2747
|
+
* @example
|
|
2748
|
+
* ```jsx
|
|
2749
|
+
* <Grid select={{ ['item-data-key-id']: true }} />
|
|
2750
|
+
* ```
|
|
2389
2751
|
*/
|
|
2390
2752
|
select?: SelectDescriptor;
|
|
2391
2753
|
/**
|
|
2392
|
-
* The default `select` state
|
|
2754
|
+
* The default `select` state applied to the Grid when using uncontrolled mode.
|
|
2755
|
+
*
|
|
2756
|
+
* @example
|
|
2757
|
+
* ```jsx
|
|
2758
|
+
* <Grid defaultSelect={{ ['item-data-key-id']: true }} />
|
|
2759
|
+
* ```
|
|
2393
2760
|
*/
|
|
2394
2761
|
defaultSelect?: SelectDescriptor;
|
|
2395
2762
|
/**
|
|
2396
2763
|
* The Grid selectable settings.
|
|
2764
|
+
*
|
|
2765
|
+
* @example
|
|
2766
|
+
* ```jsx
|
|
2767
|
+
* <Grid selectable={{ enabled: true, mode: 'single' }} />
|
|
2768
|
+
* ```
|
|
2397
2769
|
*/
|
|
2398
2770
|
selectable?: boolean | GridSelectableSettings;
|
|
2399
2771
|
/**
|
|
@@ -2403,120 +2775,247 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2403
2775
|
*
|
|
2404
2776
|
* @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
|
|
2405
2777
|
* We’re removing this prop in version 11.0.0.
|
|
2778
|
+
* ```
|
|
2406
2779
|
*/
|
|
2407
2780
|
selectedField?: string;
|
|
2408
2781
|
/**
|
|
2409
2782
|
* Fires when the user tries to select or deselect a row or cell.
|
|
2783
|
+
*
|
|
2784
|
+
* @example
|
|
2785
|
+
* ```jsx
|
|
2786
|
+
* <Grid onSelectionChange={(event) => console.log('Selection changed:', event)} />
|
|
2787
|
+
* ```
|
|
2410
2788
|
*/
|
|
2411
2789
|
onSelectionChange?: (event: GridSelectionChangeEvent) => void;
|
|
2412
2790
|
/**
|
|
2413
|
-
* Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField
|
|
2791
|
+
* Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField`.
|
|
2792
|
+
*
|
|
2793
|
+
* @example
|
|
2794
|
+
* ```jsx
|
|
2795
|
+
* <Grid onHeaderSelectionChange={(event) => console.log('Header selection changed:', event)} />
|
|
2796
|
+
* ```
|
|
2414
2797
|
*/
|
|
2415
2798
|
onHeaderSelectionChange?: (event: GridHeaderSelectionChangeEvent) => void;
|
|
2416
2799
|
/**
|
|
2417
2800
|
* Fires when the user clicks a row.
|
|
2801
|
+
*
|
|
2802
|
+
* @example
|
|
2803
|
+
* ```jsx
|
|
2804
|
+
* <Grid onRowClick={(event) => console.log('Row clicked:', event)} />
|
|
2805
|
+
* ```
|
|
2418
2806
|
*/
|
|
2419
2807
|
onRowClick?: (event: GridRowClickEvent) => void;
|
|
2420
2808
|
/**
|
|
2421
2809
|
* Fires when the user double clicks a row.
|
|
2810
|
+
*
|
|
2811
|
+
* @example
|
|
2812
|
+
* ```jsx
|
|
2813
|
+
* <Grid onRowDoubleClick={(event) => console.log('Row double clicked:', event)} />
|
|
2814
|
+
* ```
|
|
2422
2815
|
*/
|
|
2423
2816
|
onRowDoubleClick?: (event: GridRowDoubleClickEvent) => void;
|
|
2424
2817
|
/**
|
|
2425
|
-
* Fires when the user changes the values of the item.
|
|
2818
|
+
* Fires when the user changes the values of the item.
|
|
2819
|
+
*
|
|
2820
|
+
* @example
|
|
2821
|
+
* ```jsx
|
|
2822
|
+
* <Grid onItemChange={(event) => console.log('Item changed:', event)} />
|
|
2823
|
+
* ```
|
|
2426
2824
|
*/
|
|
2427
2825
|
onItemChange?: (event: GridItemChangeEvent) => void;
|
|
2428
2826
|
/**
|
|
2429
|
-
* The
|
|
2827
|
+
* The descriptor by which the in-edit mode of an item is defined.
|
|
2828
|
+
*
|
|
2829
|
+
* @example
|
|
2830
|
+
* ```jsx
|
|
2831
|
+
* <Grid edit={{ ['item-data-key-id']: true }} />
|
|
2832
|
+
* ```
|
|
2430
2833
|
*/
|
|
2431
2834
|
edit?: EditDescriptor;
|
|
2432
2835
|
/**
|
|
2433
|
-
* The default `edit` state
|
|
2836
|
+
* The default `edit` state applied to the Grid when using uncontrolled mode.
|
|
2837
|
+
*
|
|
2838
|
+
* @example
|
|
2839
|
+
* ```jsx
|
|
2840
|
+
* <Grid defaultEdit={{ ['item-data-key-id']: true }} />
|
|
2841
|
+
* ```
|
|
2434
2842
|
*/
|
|
2435
2843
|
defaultEdit?: EditDescriptor;
|
|
2436
2844
|
/**
|
|
2437
2845
|
* The Grid editable settings.
|
|
2846
|
+
*
|
|
2847
|
+
* @example
|
|
2848
|
+
* ```jsx
|
|
2849
|
+
* <Grid editable={{ enabled: true, mode: 'inline' }} />
|
|
2850
|
+
* ```
|
|
2438
2851
|
*/
|
|
2439
2852
|
editable?: boolean | GridEditableSettings;
|
|
2440
2853
|
/**
|
|
2441
2854
|
* Fires when the user enters or exits an in-edit mode of a row or cell.
|
|
2855
|
+
*
|
|
2856
|
+
* @example
|
|
2857
|
+
* ```jsx
|
|
2858
|
+
* <Grid onEditChange={(event) => console.log('Edit changed:', event)} />
|
|
2859
|
+
* ```
|
|
2442
2860
|
*/
|
|
2443
2861
|
onEditChange?: (event: GridEditChangeEvent) => void;
|
|
2444
2862
|
/**
|
|
2445
|
-
* Specifies the name of the field which will provide a Boolean representation of the edit state
|
|
2863
|
+
* Specifies the name of the field which will provide a Boolean representation of the edit state
|
|
2864
|
+
* of the current item ([more information and examples]({% slug editing_inline_grid %})).
|
|
2446
2865
|
*
|
|
2447
|
-
* @
|
|
2448
|
-
*
|
|
2866
|
+
* @example
|
|
2867
|
+
* ```jsx
|
|
2868
|
+
* <Grid editField="inEdit" />
|
|
2869
|
+
* ```
|
|
2449
2870
|
*/
|
|
2450
2871
|
editField?: string;
|
|
2451
2872
|
/**
|
|
2452
2873
|
* Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmodes_grid %})).
|
|
2453
2874
|
*
|
|
2454
|
-
*
|
|
2875
|
+
* The available options are:
|
|
2455
2876
|
* - `none`—Renders no scrollbar.
|
|
2456
2877
|
* - `scrollable`—This is the default scroll mode. It requires the setting of the `height` option.
|
|
2457
2878
|
* - `virtual`—Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
|
|
2879
|
+
*
|
|
2880
|
+
* @example
|
|
2881
|
+
* ```jsx
|
|
2882
|
+
* <Grid scrollable="virtual" />
|
|
2883
|
+
* ```
|
|
2458
2884
|
*/
|
|
2459
2885
|
scrollable?: ScrollMode;
|
|
2460
2886
|
/**
|
|
2461
2887
|
* Defines the row height and forces an equal height to all rows ([see example]({% slug scrollmodes_grid %})).
|
|
2888
|
+
*
|
|
2889
|
+
* @example
|
|
2890
|
+
* ```jsx
|
|
2891
|
+
* <Grid rowHeight={50} />
|
|
2892
|
+
* ```
|
|
2462
2893
|
*/
|
|
2463
2894
|
rowHeight?: number;
|
|
2464
2895
|
/**
|
|
2465
2896
|
* Defines the detail row height and forces an equal height to all detail rows.
|
|
2897
|
+
*
|
|
2898
|
+
* @example
|
|
2899
|
+
* ```jsx
|
|
2900
|
+
* <Grid detailRowHeight={100} />
|
|
2901
|
+
* ```
|
|
2466
2902
|
*/
|
|
2467
2903
|
detailRowHeight?: number;
|
|
2468
2904
|
/**
|
|
2469
|
-
* Specifies a React element that will be cloned and rendered inside the detail rows of the currently expanded items ([see example]({% slug hierarchy_grid %})).
|
|
2905
|
+
* Specifies a React element that will be cloned and rendered inside the detail rows of the currently expanded items ([see example]({% slug hierarchy_grid %})).
|
|
2906
|
+
*
|
|
2907
|
+
* @example
|
|
2908
|
+
* ```jsx
|
|
2909
|
+
* <Grid detail={()=>(<div>Detail Content</div>)} />
|
|
2910
|
+
* ```
|
|
2470
2911
|
*/
|
|
2471
2912
|
detail?: null | ComponentType<GridDetailRowProps>;
|
|
2472
2913
|
/**
|
|
2473
|
-
* The
|
|
2914
|
+
* The descriptor by which the data is searched. Its first FilterDescriptor populates the GridSearchBox.
|
|
2915
|
+
*
|
|
2916
|
+
* @example
|
|
2917
|
+
* ```jsx
|
|
2918
|
+
* <Grid search={{ logic: 'and', filters: [{ field: 'name', operator: 'contains', value: 'test' }] }} />
|
|
2919
|
+
* ```
|
|
2474
2920
|
*/
|
|
2475
2921
|
search?: CompositeFilterDescriptor;
|
|
2476
2922
|
/**
|
|
2477
|
-
* The
|
|
2923
|
+
* The descriptor by which the data is searched by default. Its first FilterDescriptor populates the GridSearchBox.
|
|
2924
|
+
*
|
|
2925
|
+
* @example
|
|
2926
|
+
* ```jsx
|
|
2927
|
+
* <Grid defaultSearch={{ logic: 'or', filters: [{ field: 'category', operator: 'eq', value: 'electronics' }] }} />
|
|
2928
|
+
* ```
|
|
2478
2929
|
*/
|
|
2479
2930
|
defaultSearch?: CompositeFilterDescriptor;
|
|
2480
2931
|
/**
|
|
2481
2932
|
* Defines the fields of the data that are filtered by the GridSearchBox.
|
|
2933
|
+
*
|
|
2934
|
+
* @example
|
|
2935
|
+
* ```jsx
|
|
2936
|
+
* <Grid searchFields={['name', 'category']} />
|
|
2937
|
+
* ```
|
|
2482
2938
|
*/
|
|
2483
2939
|
searchFields?: (string | SearchField)[];
|
|
2484
2940
|
/**
|
|
2485
2941
|
* Fires when the search value of the GridSearchBox is changed.
|
|
2942
|
+
*
|
|
2943
|
+
* @example
|
|
2944
|
+
* ```jsx
|
|
2945
|
+
* <Grid onSearchChange={(event) => console.log('Search changed:', event)} />
|
|
2946
|
+
* ```
|
|
2486
2947
|
*/
|
|
2487
2948
|
onSearchChange?: (event: GridSearchChangeEvent) => void;
|
|
2488
2949
|
/**
|
|
2489
2950
|
* Represents the `style` HTML attribute.
|
|
2951
|
+
*
|
|
2952
|
+
* @example
|
|
2953
|
+
* ```jsx
|
|
2954
|
+
* <Grid style={{ backgroundColor: 'lightblue' }} />
|
|
2955
|
+
* ```
|
|
2490
2956
|
*/
|
|
2491
2957
|
style?: React.CSSProperties;
|
|
2492
2958
|
/**
|
|
2493
2959
|
* Fires when the data state of the Grid is changed ([more information]({% slug localoperations_grid %}) and [example]({% slug odataserveroperations_grid %})).
|
|
2960
|
+
*
|
|
2961
|
+
* @example
|
|
2962
|
+
* ```jsx
|
|
2963
|
+
* <Grid onDataStateChange={(event) => console.log('Data state changed:', event)} />
|
|
2964
|
+
* ```
|
|
2494
2965
|
*/
|
|
2495
2966
|
onDataStateChange?: (event: GridDataStateChangeEvent) => void;
|
|
2496
2967
|
/**
|
|
2497
2968
|
* If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells ([see example]({% slug resizing_columns_grid %})).
|
|
2969
|
+
*
|
|
2970
|
+
* @example
|
|
2971
|
+
* ```jsx
|
|
2972
|
+
* <Grid resizable={true} />
|
|
2973
|
+
* ```
|
|
2498
2974
|
*/
|
|
2499
2975
|
resizable?: boolean;
|
|
2500
2976
|
/**
|
|
2501
2977
|
* If set to `true`, the user can reorder columns by dragging their header cells ([see example]({% slug reordering_columns_grid %})).
|
|
2978
|
+
*
|
|
2979
|
+
* @example
|
|
2980
|
+
* ```jsx
|
|
2981
|
+
* <Grid reorderable={true} />
|
|
2982
|
+
* ```
|
|
2502
2983
|
*/
|
|
2503
2984
|
reorderable?: boolean;
|
|
2504
2985
|
/**
|
|
2505
2986
|
* Defines the row reorder settings.
|
|
2506
2987
|
*
|
|
2507
|
-
* @
|
|
2988
|
+
* @example
|
|
2989
|
+
* ```jsx
|
|
2990
|
+
* <Grid rowReorderable={true} />
|
|
2991
|
+
* ```
|
|
2508
2992
|
*/
|
|
2509
2993
|
rowReorderable?: boolean | GridRowReorderSettings;
|
|
2510
2994
|
/**
|
|
2511
2995
|
* Determines if grouping by dragging and dropping the column headers is allowed ([more information and examples]({% slug groupingbasics_grid %})).
|
|
2996
|
+
*
|
|
2997
|
+
* @example
|
|
2998
|
+
* ```jsx
|
|
2999
|
+
* <Grid groupable={true} />
|
|
3000
|
+
* ```
|
|
2512
3001
|
*/
|
|
2513
3002
|
groupable?: GridGroupableSettings | boolean;
|
|
2514
3003
|
/**
|
|
2515
3004
|
* Fires when a column is resized. Only fired when the Grid is run as a client component.
|
|
3005
|
+
*
|
|
3006
|
+
* @example
|
|
3007
|
+
* ```jsx
|
|
3008
|
+
* <Grid onColumnResize={(event) => console.log('Column resized:', event)} />
|
|
3009
|
+
* ```
|
|
2516
3010
|
*/
|
|
2517
3011
|
onColumnResize?: (event: GridColumnResizeEvent) => void;
|
|
2518
3012
|
/**
|
|
2519
3013
|
* Fires when the columns are reordered.
|
|
3014
|
+
*
|
|
3015
|
+
* @example
|
|
3016
|
+
* ```jsx
|
|
3017
|
+
* <Grid onColumnReorder={(event) => console.log('Column reordered:', event)} />
|
|
3018
|
+
* ```
|
|
2520
3019
|
*/
|
|
2521
3020
|
onColumnReorder?: (event: GridColumnReorderEvent) => void;
|
|
2522
3021
|
/**
|
|
@@ -2545,23 +3044,48 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2545
3044
|
headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
2546
3045
|
/**
|
|
2547
3046
|
* Fires when Grid is scrolled. Only fired when the Grid is run as a client component.
|
|
3047
|
+
*
|
|
3048
|
+
* @example
|
|
3049
|
+
* ```jsx
|
|
3050
|
+
* <Grid onScroll={(event) => console.log('Grid scrolled:', event)} />
|
|
3051
|
+
* ```
|
|
2548
3052
|
*/
|
|
2549
3053
|
onScroll?: (event: GridEvent) => void;
|
|
2550
3054
|
/**
|
|
2551
3055
|
* Enables virtualization of the columns. If virtualization is enabled, the columns outside the view are not rendered.
|
|
3056
|
+
*
|
|
3057
|
+
* @example
|
|
3058
|
+
* ```jsx
|
|
3059
|
+
* <Grid columnVirtualization={true} />
|
|
3060
|
+
* ```
|
|
2552
3061
|
*/
|
|
2553
3062
|
columnVirtualization?: boolean;
|
|
2554
3063
|
/**
|
|
2555
3064
|
* If set to `true`, the user can use dedicated shortcuts to interact with the Grid.
|
|
2556
3065
|
* By default, navigation is disabled and the Grid content is accessible in the normal tab sequence.
|
|
3066
|
+
*
|
|
3067
|
+
* @example
|
|
3068
|
+
* ```jsx
|
|
3069
|
+
* <Grid navigatable={true} />
|
|
3070
|
+
* ```
|
|
2557
3071
|
*/
|
|
2558
3072
|
navigatable?: boolean | NavigatableSettings;
|
|
2559
3073
|
/**
|
|
2560
3074
|
* Fires when Grid keyboard navigation position is changed. Only fired when the Grid is run as a client component.
|
|
3075
|
+
*
|
|
3076
|
+
* @example
|
|
3077
|
+
* ```jsx
|
|
3078
|
+
* <Grid onNavigationAction={(event) => console.log('Navigation action:', event)} />
|
|
3079
|
+
* ```
|
|
2561
3080
|
*/
|
|
2562
3081
|
onNavigationAction?: (event: GridNavigationActionEvent) => void;
|
|
2563
3082
|
/**
|
|
2564
3083
|
* Fires when the user press keyboard key. Only fired when the Grid is run as a client component.
|
|
3084
|
+
*
|
|
3085
|
+
* @example
|
|
3086
|
+
* ```jsx
|
|
3087
|
+
* <Grid onKeyDown={(event) => console.log('Key pressed:', event)} />
|
|
3088
|
+
* ```
|
|
2565
3089
|
*/
|
|
2566
3090
|
onKeyDown?: (event: GridKeyDownEvent) => void;
|
|
2567
3091
|
/**
|
|
@@ -2577,6 +3101,11 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2577
3101
|
* Defines if the group descriptor columns are locked (frozen or sticky).
|
|
2578
3102
|
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
2579
3103
|
* Defaults to `false`.
|
|
3104
|
+
*
|
|
3105
|
+
* @example
|
|
3106
|
+
* ```jsx
|
|
3107
|
+
* <Grid lockGroups={true} />
|
|
3108
|
+
* ```
|
|
2580
3109
|
*/
|
|
2581
3110
|
lockGroups?: boolean;
|
|
2582
3111
|
/**
|
|
@@ -2587,18 +3116,37 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2587
3116
|
* - medium
|
|
2588
3117
|
*
|
|
2589
3118
|
* @default `medium`
|
|
3119
|
+
* @example
|
|
3120
|
+
* ```jsx
|
|
3121
|
+
* <Grid size="small" />
|
|
3122
|
+
* ```
|
|
2590
3123
|
*/
|
|
2591
3124
|
size?: 'small' | 'medium';
|
|
2592
3125
|
/**
|
|
2593
3126
|
* The event that is fired when the ContextMenu is activated. Only fired when the Grid is run as a client component.
|
|
3127
|
+
*
|
|
3128
|
+
* @example
|
|
3129
|
+
* ```jsx
|
|
3130
|
+
* <Grid onContextMenu={(event) => console.log('Context menu activated:', event)} />
|
|
3131
|
+
* ```
|
|
2594
3132
|
*/
|
|
2595
3133
|
onContextMenu?: (event: GridContextMenuEvent) => void;
|
|
2596
3134
|
/**
|
|
2597
3135
|
* The event that is fired when the ContextMenu item is clicked. Only fired when the Grid is run as a client component.
|
|
3136
|
+
*
|
|
3137
|
+
* @example
|
|
3138
|
+
* ```jsx
|
|
3139
|
+
* <Grid onContextMenuItemClick={(event) => console.log('Context menu item clicked:', event)} />
|
|
3140
|
+
* ```
|
|
2598
3141
|
*/
|
|
2599
3142
|
onContextMenuItemClick?: (event: GridContextMenuItemClickEvent) => void;
|
|
2600
3143
|
/**
|
|
2601
3144
|
* Sets the `id` property of the top div element of the component.
|
|
3145
|
+
*
|
|
3146
|
+
* @example
|
|
3147
|
+
* ```jsx
|
|
3148
|
+
* <Grid id="custom-grid-id" />
|
|
3149
|
+
* ```
|
|
2602
3150
|
*/
|
|
2603
3151
|
id?: string;
|
|
2604
3152
|
/**
|
|
@@ -2607,28 +3155,58 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2607
3155
|
unstyled?: GridClassStructure;
|
|
2608
3156
|
/**
|
|
2609
3157
|
* Enables the built-in row span feature of the Grid.
|
|
3158
|
+
*
|
|
3159
|
+
* @example
|
|
3160
|
+
* ```jsx
|
|
3161
|
+
* <Grid rowSpannable={true} />
|
|
3162
|
+
* ```
|
|
2610
3163
|
*/
|
|
2611
3164
|
rowSpannable?: boolean | GridRowSpannableSettings;
|
|
2612
3165
|
/**
|
|
2613
3166
|
* The collection of column states of the grid.
|
|
3167
|
+
*
|
|
3168
|
+
* @example
|
|
3169
|
+
* ```jsx
|
|
3170
|
+
* <Grid columnsState={[{ field: 'ProductName', locked: true }]} />
|
|
3171
|
+
* ```
|
|
2614
3172
|
*/
|
|
2615
3173
|
columnsState?: GridColumnState[];
|
|
2616
3174
|
/**
|
|
2617
3175
|
* The default columns state, used only for the initial load.
|
|
3176
|
+
*
|
|
3177
|
+
* @example
|
|
3178
|
+
* ```jsx
|
|
3179
|
+
* <Grid defaultColumnsState={[{ field: 'ProductName', locked: false }]} />
|
|
3180
|
+
* ```
|
|
2618
3181
|
*/
|
|
2619
3182
|
defaultColumnsState?: GridColumnState[];
|
|
2620
3183
|
/**
|
|
2621
3184
|
* Fires when the columns state of the Grid is changed.
|
|
3185
|
+
*
|
|
3186
|
+
* @example
|
|
3187
|
+
* ```jsx
|
|
3188
|
+
* <Grid onColumnsStateChange={(event) => console.log('Columns state changed:', event)} />
|
|
3189
|
+
* ```
|
|
2622
3190
|
*/
|
|
2623
3191
|
onColumnsStateChange?: (event: GridColumnsStateChangeEvent) => void;
|
|
2624
3192
|
/**
|
|
2625
3193
|
* Sets the locale of the Grid when used as a server component.
|
|
2626
3194
|
* Have not effect when the Grid is used as a client component.
|
|
3195
|
+
*
|
|
3196
|
+
* @example
|
|
3197
|
+
* ```jsx
|
|
3198
|
+
* <Grid locale="en-US" />
|
|
3199
|
+
* ```
|
|
2627
3200
|
*/
|
|
2628
3201
|
locale?: string;
|
|
2629
3202
|
/**
|
|
2630
3203
|
* Sets the language of the Grid when used as a server component.
|
|
2631
3204
|
* Have not effect when the Grid is used as a client component.
|
|
3205
|
+
*
|
|
3206
|
+
* @example
|
|
3207
|
+
* ```jsx
|
|
3208
|
+
* <Grid language="en" />
|
|
3209
|
+
* ```
|
|
2632
3210
|
*/
|
|
2633
3211
|
language?: string;
|
|
2634
3212
|
}
|
|
@@ -2641,7 +3219,7 @@ export declare type GridReorderDropPosition = 'before' | 'after' | 'forbidden';
|
|
|
2641
3219
|
/**
|
|
2642
3220
|
* The component for each of the items in the `data` property which the Grid renders.
|
|
2643
3221
|
*/
|
|
2644
|
-
export declare const GridRow: (props: GridRowProps) => string | number | boolean | Iterable<React_2.ReactNode> |
|
|
3222
|
+
export declare const GridRow: (props: GridRowProps) => string | number | bigint | boolean | Iterable<React_2.ReactNode> | Promise<string | number | bigint | boolean | React_2.ReactPortal | React_2.ReactElement<unknown, string | React_2.JSXElementConstructor<any>> | Iterable<React_2.ReactNode> | null | undefined> | JSX.Element | null | undefined;
|
|
2645
3223
|
|
|
2646
3224
|
/**
|
|
2647
3225
|
* Represents the object of the `onRowClick` Grid event.
|
|
@@ -2819,7 +3397,7 @@ export declare type GridRowType = 'groupFooter' | 'groupHeader' | 'data';
|
|
|
2819
3397
|
/**
|
|
2820
3398
|
* Represents the properties of the KendoReact GridSearchBox component.
|
|
2821
3399
|
*/
|
|
2822
|
-
export declare const GridSearchBox: (props: GridSearchBoxProps) =>
|
|
3400
|
+
export declare const GridSearchBox: (props: GridSearchBoxProps) => JSX.Element;
|
|
2823
3401
|
|
|
2824
3402
|
export declare interface GridSearchBoxChangeEvent extends TextBoxChangeEvent {
|
|
2825
3403
|
}
|
|
@@ -2860,7 +3438,7 @@ export declare interface GridSelectableSettings extends TableSelectableSettings
|
|
|
2860
3438
|
/**
|
|
2861
3439
|
* @hidden
|
|
2862
3440
|
*/
|
|
2863
|
-
export declare const GridSelectionCell: (props: GridCellProps) =>
|
|
3441
|
+
export declare const GridSelectionCell: (props: GridCellProps) => JSX.Element;
|
|
2864
3442
|
|
|
2865
3443
|
/**
|
|
2866
3444
|
* Represents the object of the `onSelectionChange` Grid event.
|
|
@@ -2894,7 +3472,7 @@ export declare interface GridSortChangeEvent extends GridEvent {
|
|
|
2894
3472
|
* The sorting settings of the Grid ([see example]({% slug sorting_grid %})).
|
|
2895
3473
|
*
|
|
2896
3474
|
* @example
|
|
2897
|
-
* ```
|
|
3475
|
+
* ```jsx-no-run
|
|
2898
3476
|
*
|
|
2899
3477
|
* <Grid
|
|
2900
3478
|
* sortable={true}
|
|
@@ -2946,7 +3524,7 @@ export declare interface GridThAttributes extends HeaderThElementProps {
|
|
|
2946
3524
|
* ```
|
|
2947
3525
|
*/
|
|
2948
3526
|
export declare const GridToolbar: {
|
|
2949
|
-
(props: GridToolbarProps):
|
|
3527
|
+
(props: GridToolbarProps): JSX.Element;
|
|
2950
3528
|
displayName: string;
|
|
2951
3529
|
};
|
|
2952
3530
|
|