@progress/kendo-react-grid 11.0.0-develop.2 → 11.0.0-develop.20
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/BasePDFExport.js +8 -0
- package/BasePDFExport.mjs +52 -0
- package/Grid.js +1 -1
- package/Grid.mjs +13 -18
- package/GridClientContextReader.js +1 -1
- package/GridClientContextReader.mjs +16 -13
- package/GridClientWrapper.js +1 -1
- package/GridClientWrapper.mjs +459 -449
- package/GridComponent.js +1 -1
- package/GridComponent.mjs +397 -414
- package/GridPdfExportButton.js +8 -0
- package/GridPdfExportButton.mjs +35 -0
- package/GridSearchBox.js +1 -1
- package/GridSearchBox.mjs +1 -1
- package/GridToolbar.js +1 -1
- package/GridToolbar.mjs +15 -20
- package/StatusBar.js +1 -1
- package/StatusBar.mjs +23 -23
- package/VirtualScroll.js +1 -1
- package/VirtualScroll.mjs +65 -107
- package/cells/GridDetailHierarchyCell.js +1 -1
- package/cells/GridDetailHierarchyCell.mjs +4 -4
- package/cells/GridFilterCell.js +1 -1
- package/cells/GridFilterCell.mjs +46 -46
- package/cells/datacell/GridCell.js +9 -0
- package/cells/datacell/GridCell.mjs +23 -0
- package/cells/datacell/GridCellServer.js +8 -0
- package/cells/datacell/GridCellServer.mjs +27 -0
- package/cells/datacell/GridCellServerContainer.js +9 -0
- package/cells/datacell/GridCellServerContainer.mjs +26 -0
- package/cells/datacell/useCellClientTdProps.js +9 -0
- package/cells/datacell/useCellClientTdProps.mjs +30 -0
- package/cells/datacell/utils.js +8 -0
- package/cells/datacell/utils.mjs +47 -0
- package/cells/detailcell/GridDetailCell.js +9 -0
- package/cells/detailcell/GridDetailCell.mjs +18 -0
- package/cells/detailcell/GridDetailCellServer.js +8 -0
- package/cells/detailcell/GridDetailCellServer.mjs +17 -0
- package/{codemods/index.js → cells/detailcell/GridDetailCellServerContainer.js} +2 -1
- package/cells/detailcell/GridDetailCellServerContainer.mjs +19 -0
- package/cells/detailcell/useDetailCellClientTdProps.js +9 -0
- package/cells/detailcell/useDetailCellClientTdProps.mjs +20 -0
- package/cells/detailcell/utils.js +8 -0
- package/cells/detailcell/utils.mjs +20 -0
- package/cells/editcell/GridEditCell.js +9 -0
- package/cells/editcell/GridEditCell.mjs +20 -0
- package/cells/{client → editcell}/GridEditCellEditor.js +1 -1
- package/cells/{client → editcell}/GridEditCellEditor.mjs +1 -1
- package/cells/editcell/GridEditCellServer.js +8 -0
- package/cells/editcell/GridEditCellServer.mjs +32 -0
- package/cells/editcell/GridEditCellServerContainer.js +9 -0
- package/cells/editcell/GridEditCellServerContainer.mjs +26 -0
- package/cells/editcell/useEditCellClientTdProps.js +9 -0
- package/cells/editcell/useEditCellClientTdProps.mjs +21 -0
- package/cells/editcell/utils.js +8 -0
- package/cells/editcell/utils.mjs +29 -0
- package/cells/groupcell/GridGroupCell.js +9 -0
- package/cells/groupcell/GridGroupCell.mjs +22 -0
- package/cells/groupcell/GridGroupCellServer.js +8 -0
- package/cells/groupcell/GridGroupCellServer.mjs +44 -0
- package/cells/groupcell/GridGroupCellServerContainer.js +9 -0
- package/cells/groupcell/GridGroupCellServerContainer.mjs +38 -0
- package/cells/{client → groupcell}/GridGroupCellToggle.js +1 -1
- package/cells/{client → groupcell}/GridGroupCellToggle.mjs +1 -1
- package/cells/groupcell/useGroupCellClientTdProps.js +9 -0
- package/cells/groupcell/useGroupCellClientTdProps.mjs +44 -0
- package/cells/groupcell/utils.js +8 -0
- package/cells/groupcell/utils.mjs +48 -0
- package/cells/hierarchycell/GridHierarchyCell.js +9 -0
- package/cells/hierarchycell/GridHierarchyCell.mjs +19 -0
- package/cells/hierarchycell/GridHierarchyCellServer.js +8 -0
- package/cells/hierarchycell/GridHierarchyCellServer.mjs +32 -0
- package/cells/hierarchycell/GridHierarchyCellServerContainer.js +9 -0
- package/cells/hierarchycell/GridHierarchyCellServerContainer.mjs +26 -0
- package/cells/{client → hierarchycell}/GridHierarchyCellToggle.js +1 -1
- package/cells/{client → hierarchycell}/GridHierarchyCellToggle.mjs +1 -1
- package/cells/hierarchycell/useHierarchyCellClientTdProps.js +9 -0
- package/cells/hierarchycell/useHierarchyCellClientTdProps.mjs +32 -0
- package/cells/hierarchycell/utils.js +8 -0
- package/cells/hierarchycell/utils.mjs +30 -0
- package/cells/hooks.js +9 -0
- package/cells/hooks.mjs +41 -0
- package/cells/rowreordercell/GridRowReorderCell.js +9 -0
- package/cells/rowreordercell/GridRowReorderCell.mjs +19 -0
- package/cells/rowreordercell/GridRowReorderCellServer.js +8 -0
- package/cells/rowreordercell/GridRowReorderCellServer.mjs +18 -0
- package/cells/rowreordercell/GridRowReorderCellServerContainer.js +9 -0
- package/cells/rowreordercell/GridRowReorderCellServerContainer.mjs +19 -0
- package/cells/rowreordercell/useRowReorderCellClientTdProps.js +9 -0
- package/cells/rowreordercell/useRowReorderCellClientTdProps.mjs +26 -0
- package/cells/rowreordercell/utils.js +8 -0
- package/cells/rowreordercell/utils.mjs +30 -0
- package/cells/selectioncell/GridSelectionCell.js +9 -0
- package/cells/selectioncell/GridSelectionCell.mjs +20 -0
- package/cells/{client → selectioncell}/GridSelectionCellInput.js +1 -1
- package/cells/{client → selectioncell}/GridSelectionCellInput.mjs +1 -1
- package/cells/selectioncell/GridSelectionCellServer.js +8 -0
- package/cells/selectioncell/GridSelectionCellServer.mjs +33 -0
- package/cells/selectioncell/GridSelectionCellServerContainer.js +9 -0
- package/cells/selectioncell/GridSelectionCellServerContainer.mjs +26 -0
- package/cells/selectioncell/useSelectionCellClientTdProps.js +9 -0
- package/cells/selectioncell/useSelectionCellClientTdProps.mjs +21 -0
- package/cells/selectioncell/utils.js +8 -0
- package/cells/selectioncell/utils.mjs +25 -0
- package/codemods/v11/cell-render.js +9 -0
- package/codemods/v11/column-cell.js +9 -0
- package/codemods/v11/column-filter-cell.js +9 -0
- package/codemods/v11/column-footer-cell.js +9 -0
- package/codemods/v11/column-header-cell.js +9 -0
- package/codemods/v11/detail-expand-state.js +9 -0
- package/codemods/v11/edit-state.js +9 -0
- package/codemods/v11/filter-cell-render.js +9 -0
- package/codemods/v11/group-expand-state.js +9 -0
- package/codemods/v11/header-cell-render.js +9 -0
- package/codemods/v11/index.js +9 -0
- package/codemods/v11/row-render.js +9 -0
- package/codemods/v11/selection-state.js +9 -0
- package/codemods/v11/utils.js +9 -0
- package/columnMenu/GridColumnMenuCheckboxFilter.js +1 -1
- package/columnMenu/GridColumnMenuCheckboxFilter.mjs +84 -84
- package/columnMenu/GridColumnMenuColumnsChooser.js +1 -1
- package/columnMenu/GridColumnMenuColumnsChooser.mjs +71 -72
- package/columnMenu/GridColumnMenuFilter.js +1 -1
- package/columnMenu/GridColumnMenuFilter.mjs +83 -84
- package/columnMenu/GridColumnMenuFilterCell.js +1 -1
- package/columnMenu/GridColumnMenuFilterCell.mjs +35 -28
- package/columnMenu/GridColumnMenuFilterUI.js +1 -1
- package/columnMenu/GridColumnMenuFilterUI.mjs +1 -1
- package/columnMenu/GridColumnMenuItem.js +1 -1
- package/columnMenu/GridColumnMenuItem.mjs +9 -9
- package/columnMenu/GridColumnMenuWrapper.js +1 -1
- package/columnMenu/GridColumnMenuWrapper.mjs +62 -49
- package/columnMenu/adaptiveContent/GridAdaptiveCheckboxFilter.js +1 -1
- package/columnMenu/adaptiveContent/GridAdaptiveCheckboxFilter.mjs +40 -34
- package/columnMenu/adaptiveContent/GridAdaptiveColumnChooser.js +1 -1
- package/columnMenu/adaptiveContent/GridAdaptiveColumnChooser.mjs +51 -45
- package/columnMenu/adaptiveContent/GridAdaptiveColumnMenu.js +1 -1
- package/columnMenu/adaptiveContent/GridAdaptiveColumnMenu.mjs +2 -2
- package/columnMenu/adaptiveContent/GridAdaptiveFilterMenu.js +1 -1
- package/columnMenu/adaptiveContent/GridAdaptiveFilterMenu.mjs +40 -33
- package/components/GridContainerElementContainer.js +1 -1
- package/components/GridContainerElementContainer.mjs +1 -1
- package/components/GridDragClue.js +1 -1
- package/components/GridDragClue.mjs +1 -1
- package/components/GridDraggableRowsContainer.js +1 -1
- package/components/GridDraggableRowsContainer.mjs +71 -67
- package/components/GridDropClue.js +1 -1
- package/components/GridDropClue.mjs +1 -1
- package/components/GridEditDialog.js +1 -1
- package/components/GridEditDialog.mjs +1 -1
- package/components/GridElementContainer.js +1 -1
- package/components/GridElementContainer.mjs +1 -1
- package/components/PagerContainer.js +1 -1
- package/components/PagerContainer.mjs +1 -1
- package/components/VirtualScrollHeightContainer.js +1 -1
- package/components/VirtualScrollHeightContainer.mjs +4 -4
- package/components/colGroup/GridColGroup.js +1 -1
- package/components/colGroup/GridColGroup.mjs +1 -1
- package/components/noRecords/GridNoRecordsContainer.js +1 -1
- package/components/noRecords/GridNoRecordsContainer.mjs +1 -1
- package/components/table/GridTable.js +1 -1
- package/components/table/GridTable.mjs +1 -1
- package/components/table/GridTableBody.js +1 -1
- package/components/table/GridTableBody.mjs +1 -1
- package/components/table/GridTableScrollable.js +1 -1
- package/components/table/GridTableScrollable.mjs +16 -15
- package/components/utils.js +1 -1
- package/components/utils.mjs +9 -10
- package/dist/cdn/js/kendo-react-grid.js +1 -1
- package/footer/Footer.js +1 -1
- package/footer/Footer.mjs +1 -1
- package/footer/FooterCell.js +1 -1
- package/footer/FooterCell.mjs +14 -14
- package/footer/client/FooterCellContainer.js +1 -1
- package/footer/client/FooterCellContainer.mjs +1 -1
- package/header/FilterRow.js +1 -1
- package/header/FilterRow.mjs +42 -46
- package/header/GridHeaderCell.js +1 -1
- package/header/GridHeaderCell.mjs +11 -11
- package/header/GridHeaderSelectionCell.js +1 -1
- package/header/GridHeaderSelectionCell.mjs +14 -14
- package/header/GroupPanel.js +1 -1
- package/header/GroupPanel.mjs +1 -1
- package/header/Header.js +1 -1
- package/header/Header.mjs +1 -1
- package/header/HeaderRow.js +1 -1
- package/header/HeaderRow.mjs +19 -20
- package/header/client/GridFilterCellContainer.js +1 -1
- package/header/client/GridFilterCellContainer.mjs +11 -12
- package/header/client/GridFilterCellElementContainer.js +1 -1
- package/header/client/GridFilterCellElementContainer.mjs +1 -1
- package/header/client/GridHeaderCellContainer.js +1 -1
- package/header/client/GridHeaderCellContainer.mjs +7 -8
- package/header/client/GridHeaderCellElementContainer.js +1 -1
- package/header/client/GridHeaderCellElementContainer.mjs +1 -1
- package/header/client/GridHeaderRowContainer.js +1 -1
- package/header/client/GridHeaderRowContainer.mjs +1 -1
- package/header/client/HeaderCellResizer.js +1 -1
- package/header/client/HeaderCellResizer.mjs +1 -1
- package/header/client/HeaderRowDraggable.js +1 -1
- package/header/client/HeaderRowDraggable.mjs +1 -1
- package/index.d.mts +334 -193
- package/index.d.ts +334 -193
- package/index.js +1 -1
- package/index.mjs +82 -72
- package/messages/index.js +1 -1
- package/messages/index.mjs +94 -76
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +77 -21
- package/paging/GridPagerSettings.js +1 -1
- package/paging/GridPagerSettings.mjs +17 -13
- package/rows/GridRow.js +1 -1
- package/rows/GridRow.mjs +32 -33
- package/toolbar-tools/GridToolbarCheckboxFilter.js +8 -0
- package/toolbar-tools/GridToolbarCheckboxFilter.mjs +312 -0
- package/toolbar-tools/GridToolbarColumnsChooser.js +8 -0
- package/toolbar-tools/GridToolbarColumnsChooser.mjs +178 -0
- package/toolbar-tools/GridToolbarFilter.js +8 -0
- package/toolbar-tools/GridToolbarFilter.mjs +281 -0
- package/toolbar-tools/GridToolbarSort.js +8 -0
- package/toolbar-tools/GridToolbarSort.mjs +146 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarCheckboxFilter.js +9 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarCheckboxFilter.mjs +114 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarColumnChooser.js +9 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarColumnChooser.mjs +89 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarFilter.js +9 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarFilter.mjs +98 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarSort.js +9 -0
- package/toolbar-tools/adaptiveContent/GridAdaptiveToolbarSort.mjs +68 -0
- package/toolbar-tools/adaptiveContext/GridToolbarAdaptiveContext.js +9 -0
- package/toolbar-tools/adaptiveContext/GridToolbarAdaptiveContext.mjs +17 -0
- package/utils/GridContext.js +9 -0
- package/utils/GridContext.mjs +13 -0
- package/utils/index.js +1 -1
- package/utils/index.mjs +162 -157
- package/utils/premium.js +1 -1
- package/utils/premium.mjs +18 -22
- package/utils/virtualColumns.js +1 -1
- package/utils/virtualColumns.mjs +13 -7
- package/VirtualScrollFixed.js +0 -8
- package/VirtualScrollFixed.mjs +0 -52
- package/cells/GridCell.js +0 -8
- package/cells/GridCell.mjs +0 -52
- package/cells/GridDetailCell.js +0 -8
- package/cells/GridDetailCell.mjs +0 -26
- package/cells/GridEditCell.js +0 -8
- package/cells/GridEditCell.mjs +0 -35
- package/cells/GridGroupCell.js +0 -8
- package/cells/GridGroupCell.mjs +0 -74
- package/cells/GridHierarchyCell.js +0 -8
- package/cells/GridHierarchyCell.mjs +0 -33
- package/cells/GridRowReorderCell.js +0 -8
- package/cells/GridRowReorderCell.mjs +0 -42
- package/cells/GridSelectionCell.js +0 -8
- package/cells/GridSelectionCell.mjs +0 -30
- package/cells/client/DetailCellContainer.js +0 -9
- package/cells/client/DetailCellContainer.mjs +0 -27
- package/cells/client/GridCellContainer.js +0 -9
- package/cells/client/GridCellContainer.mjs +0 -69
- package/cells/client/GridEditCellContainer.js +0 -9
- package/cells/client/GridEditCellContainer.mjs +0 -61
- package/cells/client/GridGroupCellContainer.js +0 -9
- package/cells/client/GridGroupCellContainer.mjs +0 -88
- package/cells/client/GridHierarchyCellContainer.js +0 -9
- package/cells/client/GridHierarchyCellContainer.mjs +0 -64
- package/cells/client/GridRowReorderContainer.js +0 -9
- package/cells/client/GridRowReorderContainer.mjs +0 -31
- package/cells/client/GridSelectionCellContainer.js +0 -9
- package/cells/client/GridSelectionCellContainer.mjs +0 -61
- package/components/GridCustomCellClientContainer.js +0 -9
- package/components/GridCustomCellClientContainer.mjs +0 -34
package/index.d.mts
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
import { BaseEvent } from '@progress/kendo-react-common';
|
|
9
|
+
import { ButtonProps } from '@progress/kendo-react-buttons';
|
|
9
10
|
import { CellProps } from '@progress/kendo-react-data-tools';
|
|
10
11
|
import { ClipboardSettings } from '@progress/kendo-react-data-tools';
|
|
11
12
|
import { ColumnBaseProps } from '@progress/kendo-react-data-tools';
|
|
@@ -60,6 +61,7 @@ import { TableSelectableSettings } from '@progress/kendo-react-data-tools';
|
|
|
60
61
|
import { TableSelectionChangeEvent } from '@progress/kendo-react-data-tools';
|
|
61
62
|
import { TextBoxChangeEvent } from '@progress/kendo-react-inputs';
|
|
62
63
|
import { TextBoxProps } from '@progress/kendo-react-inputs';
|
|
64
|
+
import { ToolbarProps } from '@progress/kendo-react-buttons';
|
|
63
65
|
|
|
64
66
|
/**
|
|
65
67
|
* The value of the filter operators displayed in the boolean filter menu.
|
|
@@ -251,6 +253,8 @@ declare interface ExtendedColumnProps extends GridColumnProps {
|
|
|
251
253
|
/** @hidden _internal usage only */
|
|
252
254
|
_type?: 'edit' | 'expand';
|
|
253
255
|
rowSpannable?: Required<GridRowSpannableSettings>;
|
|
256
|
+
defaultCell?: any;
|
|
257
|
+
defaultHeaderCell?: any;
|
|
254
258
|
}
|
|
255
259
|
|
|
256
260
|
/**
|
|
@@ -273,6 +277,9 @@ export declare const getStatusData: (args: StatusDataArgs) => StatusItem[];
|
|
|
273
277
|
/**
|
|
274
278
|
* Represents the [KendoReact Grid component]({% slug overview_grid %}).
|
|
275
279
|
*
|
|
280
|
+
* @remarks
|
|
281
|
+
* Supported children components are: {@link GridColumn}, {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
|
|
282
|
+
*
|
|
276
283
|
* @example
|
|
277
284
|
* ```jsx
|
|
278
285
|
* const App = () => {
|
|
@@ -304,7 +311,12 @@ export declare const GRID_PREVENT_SELECTION_ELEMENT = "data-prevent-selection";
|
|
|
304
311
|
/** The attribute required by the Grid selection on Grid `tr` elements. */
|
|
305
312
|
export declare const GRID_ROW_INDEX_ATTRIBUTE = "data-grid-row-index";
|
|
306
313
|
|
|
307
|
-
|
|
314
|
+
/**
|
|
315
|
+
* @hidden
|
|
316
|
+
*/
|
|
317
|
+
export declare const GridCell: (props: {
|
|
318
|
+
cellProps: GridCellProps;
|
|
319
|
+
}) => JSX.Element | null;
|
|
308
320
|
|
|
309
321
|
/**
|
|
310
322
|
* Represents the `GridCellBaseOptions` object that are passed to the handler.
|
|
@@ -368,11 +380,6 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
368
380
|
* Supported values are `text`, `numeric`, `boolean`, and `date`.
|
|
369
381
|
*/
|
|
370
382
|
editor?: 'text' | 'numeric' | 'boolean' | 'date';
|
|
371
|
-
/**
|
|
372
|
-
* A function to override the default rendering of the cell.
|
|
373
|
-
* Accepts the default rendering and props as arguments and returns a React element.
|
|
374
|
-
*/
|
|
375
|
-
render?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | null;
|
|
376
383
|
/**
|
|
377
384
|
* @hidden
|
|
378
385
|
*/
|
|
@@ -467,7 +474,9 @@ export declare type GridColSpanProps = {
|
|
|
467
474
|
};
|
|
468
475
|
|
|
469
476
|
/**
|
|
470
|
-
*
|
|
477
|
+
* Represents the GridColumn component.
|
|
478
|
+
*
|
|
479
|
+
* @returns null
|
|
471
480
|
*/
|
|
472
481
|
export declare const GridColumn: React_2.FunctionComponent<GridColumnProps>;
|
|
473
482
|
|
|
@@ -911,7 +920,7 @@ declare interface GridColumnMenuItemProps {
|
|
|
911
920
|
/**
|
|
912
921
|
* The class of the icon that is rendered next to the title.
|
|
913
922
|
*/
|
|
914
|
-
iconClass
|
|
923
|
+
iconClass?: string;
|
|
915
924
|
/**
|
|
916
925
|
* The SVG icon that is rendered next to the title.
|
|
917
926
|
*/
|
|
@@ -1199,16 +1208,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1199
1208
|
* ```
|
|
1200
1209
|
*/
|
|
1201
1210
|
media?: string;
|
|
1202
|
-
/**
|
|
1203
|
-
* Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
|
|
1204
|
-
*
|
|
1205
|
-
* @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.
|
|
1206
|
-
* @example
|
|
1207
|
-
* ```jsx
|
|
1208
|
-
* <GridColumn cell={CustomCell} />
|
|
1209
|
-
* ```
|
|
1210
|
-
*/
|
|
1211
|
-
cell?: ComponentType<GridCellProps>;
|
|
1212
1211
|
/**
|
|
1213
1212
|
* Specifies a set of cell components that the Grid will render instead of the built-in cell.
|
|
1214
1213
|
*
|
|
@@ -1218,42 +1217,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1218
1217
|
* ```
|
|
1219
1218
|
*/
|
|
1220
1219
|
cells?: GridCellsSettings;
|
|
1221
|
-
/**
|
|
1222
|
-
* Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
|
|
1223
|
-
*
|
|
1224
|
-
* @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.
|
|
1225
|
-
* @example
|
|
1226
|
-
* ```jsx
|
|
1227
|
-
* <GridColumn filterCell={CustomFilterCell} />
|
|
1228
|
-
* ```
|
|
1229
|
-
*/
|
|
1230
|
-
filterCell?: ComponentType<GridFilterCellProps>;
|
|
1231
|
-
/**
|
|
1232
|
-
* Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
|
|
1233
|
-
*
|
|
1234
|
-
* @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.
|
|
1235
|
-
* @example
|
|
1236
|
-
* ```jsx
|
|
1237
|
-
* <GridColumn headerCell={CustomHeaderCell} />
|
|
1238
|
-
* ```
|
|
1239
|
-
*/
|
|
1240
|
-
headerCell?: ComponentType<GridHeaderCellProps>;
|
|
1241
|
-
/**
|
|
1242
|
-
* Defines the component that will be rendered as a footer cell.
|
|
1243
|
-
* The footer has to render an HTML `<td>` element and applies the `style` and `colspan` values from its props.
|
|
1244
|
-
*
|
|
1245
|
-
* @example
|
|
1246
|
-
* ```jsx-no-run
|
|
1247
|
-
* <GridColumn
|
|
1248
|
-
* footerCell={props => (
|
|
1249
|
-
* <td className='k-table-td' colSpan={props.colSpan} style={props.style} role={'gridcell'}>Sum: 50</td>
|
|
1250
|
-
* )}
|
|
1251
|
-
* />
|
|
1252
|
-
* ```
|
|
1253
|
-
*
|
|
1254
|
-
* @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.
|
|
1255
|
-
*/
|
|
1256
|
-
footerCell?: ComponentType<GridFooterCellProps>;
|
|
1257
1220
|
/**
|
|
1258
1221
|
* Sets the type of the column and renders a dedicated column for interaction.
|
|
1259
1222
|
*
|
|
@@ -1663,7 +1626,7 @@ export declare interface GridDetailExpandChangeEvent extends GridEvent {
|
|
|
1663
1626
|
}
|
|
1664
1627
|
|
|
1665
1628
|
/**
|
|
1666
|
-
* Represents the detail row class of the KendoReact Grid. Used to define custom details for each row. Can be applied for building the hierarchy.
|
|
1629
|
+
* Represents the detail row class of the KendoReact Grid. Used to define custom details for each row. Can be applied for building the hierarchy. The details for each row will be visible or hidden depending on the current `detailExpand` prop.
|
|
1667
1630
|
*
|
|
1668
1631
|
* @example
|
|
1669
1632
|
* ```jsx
|
|
@@ -1726,7 +1689,9 @@ declare interface GridEditableSettings extends TableEditableSettings {
|
|
|
1726
1689
|
/**
|
|
1727
1690
|
* @hidden
|
|
1728
1691
|
*/
|
|
1729
|
-
export declare const GridEditCell: (props:
|
|
1692
|
+
export declare const GridEditCell: (props: {
|
|
1693
|
+
cellProps: GridCellProps;
|
|
1694
|
+
}) => JSX.Element | null;
|
|
1730
1695
|
|
|
1731
1696
|
/**
|
|
1732
1697
|
* Represents the object of the `onEditChange` Grid event.
|
|
@@ -1763,25 +1728,7 @@ export declare type GridEditDialogProps = DialogProps & {
|
|
|
1763
1728
|
export declare interface GridEvent extends BaseEvent<GridHandle> {
|
|
1764
1729
|
}
|
|
1765
1730
|
|
|
1766
|
-
|
|
1767
|
-
* Represents the object of the `onExpandChange` Grid event.
|
|
1768
|
-
*/
|
|
1769
|
-
export declare interface GridExpandChangeEvent extends GridEvent {
|
|
1770
|
-
/**
|
|
1771
|
-
* The data item that is expanded or collapsed.
|
|
1772
|
-
*/
|
|
1773
|
-
dataItem: any;
|
|
1774
|
-
/**
|
|
1775
|
-
* Indicates whether the data item is expanded or collapsed
|
|
1776
|
-
*/
|
|
1777
|
-
value: boolean;
|
|
1778
|
-
/**
|
|
1779
|
-
* Zero based index of the data item.
|
|
1780
|
-
*/
|
|
1781
|
-
dataIndex: number;
|
|
1782
|
-
}
|
|
1783
|
-
|
|
1784
|
-
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;
|
|
1731
|
+
export declare const GridFilterCell: (props: GridFilterCellProps) => JSX.Element;
|
|
1785
1732
|
|
|
1786
1733
|
/**
|
|
1787
1734
|
* The props of the GridFilterCell component
|
|
@@ -1825,10 +1772,6 @@ export declare interface GridFilterCellProps {
|
|
|
1825
1772
|
* The list of values for the Boolean filter.
|
|
1826
1773
|
*/
|
|
1827
1774
|
booleanValues: GridFilterOperator[];
|
|
1828
|
-
/**
|
|
1829
|
-
* A function for overriding the default rendering of the filter cell.
|
|
1830
|
-
*/
|
|
1831
|
-
render?: (row: React.ReactElement<any>, dataItem: GridFilterCellProps) => React.ReactNode;
|
|
1832
1775
|
/**
|
|
1833
1776
|
* Accessible label of the filter.
|
|
1834
1777
|
*/
|
|
@@ -1956,7 +1899,9 @@ export declare interface GridGroupableSettings {
|
|
|
1956
1899
|
/**
|
|
1957
1900
|
* @hidden
|
|
1958
1901
|
*/
|
|
1959
|
-
export declare const GridGroupCell: (props:
|
|
1902
|
+
export declare const GridGroupCell: (props: {
|
|
1903
|
+
cellProps: GridCellProps;
|
|
1904
|
+
}) => JSX.Element | null;
|
|
1960
1905
|
|
|
1961
1906
|
/**
|
|
1962
1907
|
* Represents the object of the `onGroupChange` Grid event.
|
|
@@ -2039,6 +1984,11 @@ export declare interface GridHandle {
|
|
|
2039
1984
|
* @param columnIds - Array of column ids to be fitted.
|
|
2040
1985
|
*/
|
|
2041
1986
|
fitColumns: (columnIds: string[]) => void;
|
|
1987
|
+
/**
|
|
1988
|
+
* Method to trigger a PDF export of the Grid.
|
|
1989
|
+
* The 'pdf' prop of the Grid should be set to true or object of setting that will be applied the exported Grid.
|
|
1990
|
+
*/
|
|
1991
|
+
exportAsPdf: () => void;
|
|
2042
1992
|
}
|
|
2043
1993
|
|
|
2044
1994
|
/**
|
|
@@ -2075,17 +2025,13 @@ export declare interface GridHandle {
|
|
|
2075
2025
|
* export default App;
|
|
2076
2026
|
* ```
|
|
2077
2027
|
*/
|
|
2078
|
-
export declare const GridHeaderCell: (props: GridHeaderCellProps) =>
|
|
2028
|
+
export declare const GridHeaderCell: (props: GridHeaderCellProps) => JSX.Element;
|
|
2079
2029
|
|
|
2080
2030
|
/**
|
|
2081
2031
|
* The props of the GridHeaderCell component
|
|
2082
2032
|
* ([more information]({% slug cells_grid %}#toc-header-cells)).
|
|
2083
2033
|
*/
|
|
2084
2034
|
export declare interface GridHeaderCellProps extends Omit<HeaderCellBaseProps, 'render'> {
|
|
2085
|
-
/**
|
|
2086
|
-
* A function for overriding the default rendering of the header cell.
|
|
2087
|
-
*/
|
|
2088
|
-
render?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
2089
2035
|
/**
|
|
2090
2036
|
* The props of the Grid column menu wrapper.
|
|
2091
2037
|
*/
|
|
@@ -2112,16 +2058,14 @@ export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
|
2112
2058
|
* The current Grid leaf data items.
|
|
2113
2059
|
*/
|
|
2114
2060
|
dataItems: any[];
|
|
2115
|
-
/**
|
|
2116
|
-
* The `selectedField` prop of the Grid.
|
|
2117
|
-
*/
|
|
2118
|
-
selectedField: string;
|
|
2119
2061
|
}
|
|
2120
2062
|
|
|
2121
2063
|
/**
|
|
2122
2064
|
* @hidden
|
|
2123
2065
|
*/
|
|
2124
|
-
export declare const GridHierarchyCell: (props:
|
|
2066
|
+
export declare const GridHierarchyCell: (props: {
|
|
2067
|
+
cellProps: GridCellProps;
|
|
2068
|
+
}) => JSX.Element | null;
|
|
2125
2069
|
|
|
2126
2070
|
/**
|
|
2127
2071
|
* Represents the object of the `onItemChange` Grid event.
|
|
@@ -2163,12 +2107,20 @@ export declare const gridMessages: {
|
|
|
2163
2107
|
"grid.groupPanelEmpty": string;
|
|
2164
2108
|
"grid.filterApplyButton": string;
|
|
2165
2109
|
"grid.filterClearButton": string;
|
|
2110
|
+
"grid.filterClearAllButton": string;
|
|
2166
2111
|
"grid.filterResetButton": string;
|
|
2167
2112
|
"grid.filterSubmitButton": string;
|
|
2168
2113
|
"grid.filterTitle": string;
|
|
2169
2114
|
"grid.sortAscending": string;
|
|
2170
2115
|
"grid.sortDescending": string;
|
|
2116
|
+
"grid.sortClearButton": string;
|
|
2117
|
+
"grid.sortApplyButton": string;
|
|
2171
2118
|
"grid.sortAriaLabel": string;
|
|
2119
|
+
"grid.adaptiveToolbarSortTitle": string;
|
|
2120
|
+
"grid.toolbarSort": string;
|
|
2121
|
+
"grid.toolbarFilter": string;
|
|
2122
|
+
"grid.toolbarColumnsChooser": string;
|
|
2123
|
+
"grid.toolbarCheckboxFilter": string;
|
|
2172
2124
|
"grid.groupColumn": string;
|
|
2173
2125
|
"grid.ungroupColumn": string;
|
|
2174
2126
|
"grid.columnMenu": string;
|
|
@@ -2184,6 +2136,7 @@ export declare const gridMessages: {
|
|
|
2184
2136
|
"grid.pagerTotalPages": string;
|
|
2185
2137
|
"grid.searchPlaceholder": string;
|
|
2186
2138
|
"grid.searchboxPlaceholder": string;
|
|
2139
|
+
"grid.exportPDF": string;
|
|
2187
2140
|
"grid.filterCheckAll": string;
|
|
2188
2141
|
"grid.editDialogTitle": string;
|
|
2189
2142
|
"grid.editDialogSaveButtonTitle": string;
|
|
@@ -2321,9 +2274,20 @@ export declare interface GridPagerSettings {
|
|
|
2321
2274
|
*/
|
|
2322
2275
|
previousNext?: boolean;
|
|
2323
2276
|
/**
|
|
2324
|
-
* Defines if the pager will be responsive.
|
|
2277
|
+
* Defines if the pager will be responsive.
|
|
2278
|
+
* If true, hides the tools that do not fit to the available space.
|
|
2279
|
+
*
|
|
2280
|
+
* @default `true`
|
|
2325
2281
|
*/
|
|
2326
2282
|
responsive?: boolean;
|
|
2283
|
+
/**
|
|
2284
|
+
* Providing different rendering of the page sizes select element based on the screen dimensions.
|
|
2285
|
+
*/
|
|
2286
|
+
adaptive?: boolean;
|
|
2287
|
+
/**
|
|
2288
|
+
* Specifies the text that is rendered as title in the adaptive page sizes select element.
|
|
2289
|
+
*/
|
|
2290
|
+
adaptiveTitle?: string;
|
|
2327
2291
|
/**
|
|
2328
2292
|
* Defines if the pager will be navigatable.
|
|
2329
2293
|
*/
|
|
@@ -2349,6 +2313,14 @@ export declare interface GridPagerSettings {
|
|
|
2349
2313
|
*/
|
|
2350
2314
|
declare type GridPagerType = 'numeric' | 'input';
|
|
2351
2315
|
|
|
2316
|
+
/**
|
|
2317
|
+
* Represents the properties of the KendoReact GridPdfExportButton component.
|
|
2318
|
+
*/
|
|
2319
|
+
export declare const GridPdfExportButton: (props: GridPdfExportButtonProps) => JSX.Element;
|
|
2320
|
+
|
|
2321
|
+
export declare interface GridPdfExportButtonProps extends ButtonProps {
|
|
2322
|
+
}
|
|
2323
|
+
|
|
2352
2324
|
/**
|
|
2353
2325
|
* Represents the props of the [KendoReact Grid component]({% slug overview_grid %}).
|
|
2354
2326
|
*/
|
|
@@ -2661,8 +2633,12 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2661
2633
|
* - `info: Boolean`—Toggles the information about the current page and the total number of records.
|
|
2662
2634
|
* - `type: PagerType`—Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values.
|
|
2663
2635
|
* - `pageSizes: Boolean` or `Array<number>`—Shows a menu for selecting the page size.
|
|
2636
|
+
* - `pageSizeValue: String or Number`—Sets the selected value of the page size Dropdownlist. It is useful when the selected value could also be a string not only a number.
|
|
2664
2637
|
* - `previousNext: Boolean`—Toggles the **Previous** and **Next** buttons.
|
|
2665
2638
|
* - `navigatable: Boolean`—Defines if the pager will be navigatable.
|
|
2639
|
+
* - `responsive: Boolean`—Defines if the pager will be responsive. If true, hides the tools that do not fit to the available space.
|
|
2640
|
+
* - `adaptive: Boolean`—Providing different rendering of the page sizes select element based on the screen dimensions.
|
|
2641
|
+
* - `adaptiveTitle: String`—Specifies the text that is rendered as title in the adaptive page sizes select element.
|
|
2666
2642
|
*
|
|
2667
2643
|
* @example
|
|
2668
2644
|
* ```jsx
|
|
@@ -2689,6 +2665,31 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2689
2665
|
* ```
|
|
2690
2666
|
*/
|
|
2691
2667
|
pager?: null | ComponentType<PagerProps>;
|
|
2668
|
+
/**
|
|
2669
|
+
* When set to true the Grid pdf export will be enabled.
|
|
2670
|
+
* If set to an object, the Grid will use the provided settings to export the PDF.
|
|
2671
|
+
*
|
|
2672
|
+
* @example
|
|
2673
|
+
* ```jsx
|
|
2674
|
+
* <Grid pdf={true} />
|
|
2675
|
+
* ```
|
|
2676
|
+
*/
|
|
2677
|
+
pdf?: boolean | GridProps;
|
|
2678
|
+
/**
|
|
2679
|
+
* Fires when the user clicks the PDF export button.
|
|
2680
|
+
*
|
|
2681
|
+
* @example
|
|
2682
|
+
* ```jsx
|
|
2683
|
+
*
|
|
2684
|
+
* <Grid onPdfExport={async (event) => {
|
|
2685
|
+
* const pdf = await import('@progress/kendo-react-pdf');
|
|
2686
|
+
* await pdf.saveGridPDF(event.target);
|
|
2687
|
+
* }} />
|
|
2688
|
+
* ```
|
|
2689
|
+
*/
|
|
2690
|
+
onPdfExport?: (event: {
|
|
2691
|
+
target: HTMLDivElement;
|
|
2692
|
+
}) => Promise<void>;
|
|
2692
2693
|
/**
|
|
2693
2694
|
* Alias for the `pageSize` property. If `take` is set, `pageSize` will be ignored.
|
|
2694
2695
|
*
|
|
@@ -2806,24 +2807,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2806
2807
|
* ```
|
|
2807
2808
|
*/
|
|
2808
2809
|
onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
|
|
2809
|
-
/**
|
|
2810
|
-
* Fires when the user tries to expand or collapse a row.
|
|
2811
|
-
*
|
|
2812
|
-
* @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.
|
|
2813
|
-
* We’re removing this prop in version 11.0.0.
|
|
2814
|
-
* ```
|
|
2815
|
-
*/
|
|
2816
|
-
onExpandChange?: (event: GridExpandChangeEvent) => void;
|
|
2817
|
-
/**
|
|
2818
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
|
|
2819
|
-
*
|
|
2820
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
|
|
2821
|
-
*
|
|
2822
|
-
* @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.
|
|
2823
|
-
* We’re removing this prop in version 11.0.0.
|
|
2824
|
-
* ```
|
|
2825
|
-
*/
|
|
2826
|
-
expandField?: string;
|
|
2827
2810
|
/**
|
|
2828
2811
|
* The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
|
|
2829
2812
|
* Passing a boolean value will select the whole row, while passing an array of strings will select individual.
|
|
@@ -2852,16 +2835,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2852
2835
|
* ```
|
|
2853
2836
|
*/
|
|
2854
2837
|
selectable?: boolean | GridSelectableSettings;
|
|
2855
|
-
/**
|
|
2856
|
-
* Specifies the name of the field which will provide a:
|
|
2857
|
-
* - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
|
|
2858
|
-
* - String array of the selected columns of the item for cell selection
|
|
2859
|
-
*
|
|
2860
|
-
* @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
|
|
2861
|
-
* We’re removing this prop in version 11.0.0.
|
|
2862
|
-
* ```
|
|
2863
|
-
*/
|
|
2864
|
-
selectedField?: string;
|
|
2865
2838
|
/**
|
|
2866
2839
|
* Fires when the user tries to select or deselect a row or cell.
|
|
2867
2840
|
*
|
|
@@ -2872,7 +2845,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2872
2845
|
*/
|
|
2873
2846
|
onSelectionChange?: (event: GridSelectionChangeEvent) => void;
|
|
2874
2847
|
/**
|
|
2875
|
-
* Fires when the user clicks the checkbox of a column header whose
|
|
2848
|
+
* Fires when the user clicks the checkbox of a column header whose type is set to `checkbox`.
|
|
2876
2849
|
*
|
|
2877
2850
|
* @example
|
|
2878
2851
|
* ```jsx
|
|
@@ -2943,16 +2916,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2943
2916
|
* ```
|
|
2944
2917
|
*/
|
|
2945
2918
|
onEditChange?: (event: GridEditChangeEvent) => void;
|
|
2946
|
-
/**
|
|
2947
|
-
* Specifies the name of the field which will provide a Boolean representation of the edit state
|
|
2948
|
-
* of the current item ([more information and examples]({% slug editing_inline_grid %})).
|
|
2949
|
-
*
|
|
2950
|
-
* @example
|
|
2951
|
-
* ```jsx
|
|
2952
|
-
* <Grid editField="inEdit" />
|
|
2953
|
-
* ```
|
|
2954
|
-
*/
|
|
2955
|
-
editField?: string;
|
|
2956
2919
|
/**
|
|
2957
2920
|
* Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmodes_grid %})).
|
|
2958
2921
|
*
|
|
@@ -3102,30 +3065,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
3102
3065
|
* ```
|
|
3103
3066
|
*/
|
|
3104
3067
|
onColumnReorder?: (event: GridColumnReorderEvent) => void;
|
|
3105
|
-
/**
|
|
3106
|
-
* Fires when a row is about to be rendered. Overrides the default appearance of the row.
|
|
3107
|
-
*
|
|
3108
|
-
* @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.
|
|
3109
|
-
*/
|
|
3110
|
-
rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
3111
|
-
/**
|
|
3112
|
-
* Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
|
|
3113
|
-
*
|
|
3114
|
-
* @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.
|
|
3115
|
-
*/
|
|
3116
|
-
cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
|
|
3117
|
-
/**
|
|
3118
|
-
* Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
|
|
3119
|
-
*
|
|
3120
|
-
* @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.
|
|
3121
|
-
*/
|
|
3122
|
-
filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
|
|
3123
|
-
/**
|
|
3124
|
-
* Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
|
|
3125
|
-
*
|
|
3126
|
-
* @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.
|
|
3127
|
-
*/
|
|
3128
|
-
headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
3129
3068
|
/**
|
|
3130
3069
|
* Fires when Grid is scrolled. Only fired when the Grid is run as a client component.
|
|
3131
3070
|
*
|
|
@@ -3172,15 +3111,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
3172
3111
|
* ```
|
|
3173
3112
|
*/
|
|
3174
3113
|
onKeyDown?: (event: GridKeyDownEvent) => void;
|
|
3175
|
-
/**
|
|
3176
|
-
* The accessible label of the Grid.
|
|
3177
|
-
*/
|
|
3178
|
-
/**
|
|
3179
|
-
* **Deprecated**. The accessible label of the Grid. Use ([messages]({% slug globalization_grid %})) instead.
|
|
3180
|
-
*
|
|
3181
|
-
* @deprecated
|
|
3182
|
-
*/
|
|
3183
|
-
ariaLabel?: string;
|
|
3184
3114
|
/**
|
|
3185
3115
|
* Defines if the group descriptor columns are locked (frozen or sticky).
|
|
3186
3116
|
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
@@ -3303,7 +3233,7 @@ export declare type GridReorderDropPosition = 'before' | 'after' | 'forbidden';
|
|
|
3303
3233
|
/**
|
|
3304
3234
|
* The component for each of the items in the `data` property which the Grid renders.
|
|
3305
3235
|
*/
|
|
3306
|
-
export declare const GridRow: (props: GridRowProps) =>
|
|
3236
|
+
export declare const GridRow: (props: GridRowProps) => JSX.Element;
|
|
3307
3237
|
|
|
3308
3238
|
/**
|
|
3309
3239
|
* Represents the object of the `onRowClick` Grid event.
|
|
@@ -3326,7 +3256,7 @@ export declare interface GridRowDoubleClickEvent extends GridEvent {
|
|
|
3326
3256
|
}
|
|
3327
3257
|
|
|
3328
3258
|
/**
|
|
3329
|
-
* The props that the Grid passes to the GridRow component when creating it. Accessible
|
|
3259
|
+
* The props that the Grid passes to the GridRow component when creating it. Accessible when passing a custom row to the `rows` prop of the Grid.
|
|
3330
3260
|
*/
|
|
3331
3261
|
export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
3332
3262
|
/**
|
|
@@ -3353,10 +3283,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
3353
3283
|
* The event that is fired when the row is double clicked.
|
|
3354
3284
|
*/
|
|
3355
3285
|
onDoubleClick: any;
|
|
3356
|
-
/**
|
|
3357
|
-
* The name of the field which will provide a Boolean representation of the selected state of the item.
|
|
3358
|
-
*/
|
|
3359
|
-
selectedField?: string;
|
|
3360
3286
|
/**
|
|
3361
3287
|
* Sets the height of the row.
|
|
3362
3288
|
*/
|
|
@@ -3365,10 +3291,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
3365
3291
|
* The type of the row.
|
|
3366
3292
|
*/
|
|
3367
3293
|
rowType: GridRowType;
|
|
3368
|
-
/**
|
|
3369
|
-
* A function for overriding the default rendering of the row.
|
|
3370
|
-
*/
|
|
3371
|
-
render?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
3372
3294
|
/**
|
|
3373
3295
|
* Sets a set of rows components that the Grid will render instead of the built-in row.
|
|
3374
3296
|
*/
|
|
@@ -3522,7 +3444,9 @@ export declare interface GridSelectableSettings extends TableSelectableSettings
|
|
|
3522
3444
|
/**
|
|
3523
3445
|
* @hidden
|
|
3524
3446
|
*/
|
|
3525
|
-
export declare const GridSelectionCell: (props:
|
|
3447
|
+
export declare const GridSelectionCell: (props: {
|
|
3448
|
+
cellProps: GridCellProps;
|
|
3449
|
+
}) => JSX.Element | null;
|
|
3526
3450
|
|
|
3527
3451
|
/**
|
|
3528
3452
|
* Represents the object of the `onSelectionChange` Grid event.
|
|
@@ -3613,37 +3537,254 @@ export declare const GridToolbar: {
|
|
|
3613
3537
|
};
|
|
3614
3538
|
|
|
3615
3539
|
/**
|
|
3616
|
-
*
|
|
3540
|
+
* Represents the GridToolbarCheckboxFilter component.
|
|
3617
3541
|
*/
|
|
3618
|
-
export declare
|
|
3542
|
+
export declare const GridToolbarCheckboxFilter: {
|
|
3543
|
+
(props: GridToolbarCheckboxFilterProps): JSX.Element;
|
|
3544
|
+
displayName: string;
|
|
3545
|
+
};
|
|
3546
|
+
|
|
3547
|
+
export declare interface GridToolbarCheckboxFilterProps {
|
|
3619
3548
|
/**
|
|
3620
|
-
*
|
|
3549
|
+
* Sets the items collection that will be rendered by the GridToolbarCheckboxFilter component.
|
|
3621
3550
|
*/
|
|
3622
|
-
|
|
3551
|
+
data: Array<string | object>;
|
|
3623
3552
|
/**
|
|
3624
|
-
*
|
|
3553
|
+
* Defines the icon rendered in the GridToolbarCheckboxFilter tool ([see example]({% slug overview_icon %})).
|
|
3554
|
+
*
|
|
3555
|
+
* @example
|
|
3556
|
+
* ```jsx
|
|
3557
|
+
* <GridToolbarCheckboxFilter icon="home" />
|
|
3558
|
+
* ```
|
|
3625
3559
|
*/
|
|
3626
|
-
|
|
3560
|
+
icon?: string;
|
|
3627
3561
|
/**
|
|
3628
|
-
*
|
|
3562
|
+
* Defines the SVG icon rendered in the GridToolbarCheckboxFilter tool ([see example]({% slug overview_svgicon %})).
|
|
3629
3563
|
*
|
|
3630
|
-
*
|
|
3631
|
-
*
|
|
3632
|
-
* -
|
|
3633
|
-
* - large
|
|
3634
|
-
* - null—Does not set a size `className`.
|
|
3564
|
+
* @example
|
|
3565
|
+
* ```jsx
|
|
3566
|
+
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
3635
3567
|
*
|
|
3636
|
-
*
|
|
3568
|
+
* <GridToolbarCheckboxFilter svgIcon={gearIcon} />
|
|
3569
|
+
* ```
|
|
3637
3570
|
*/
|
|
3638
|
-
|
|
3571
|
+
svgIcon?: SVGIcon;
|
|
3639
3572
|
/**
|
|
3640
|
-
*
|
|
3573
|
+
* Defines the component that will be rendered as a search box.
|
|
3574
|
+
*
|
|
3641
3575
|
*/
|
|
3642
|
-
|
|
3576
|
+
searchBox?: React_2.ComponentType<any>;
|
|
3577
|
+
/**
|
|
3578
|
+
* Defines the filter operator that will be used to filter the values via the search box.
|
|
3579
|
+
* "startswith"
|
|
3580
|
+
* "endswith"
|
|
3581
|
+
* "contains"
|
|
3582
|
+
* "doesnotcontain"
|
|
3583
|
+
* "isempty"
|
|
3584
|
+
* "isnotempty"
|
|
3585
|
+
* "eq" (equal to)
|
|
3586
|
+
* "eq" (equal to)
|
|
3587
|
+
* "neq" (not equal to)
|
|
3588
|
+
* "isnull" (is equal to null)
|
|
3589
|
+
* "isnotnull" (is not equal to null)
|
|
3590
|
+
*/
|
|
3591
|
+
searchBoxFilterOperator?: string | Function;
|
|
3592
|
+
/**
|
|
3593
|
+
* Determines if the data in the component will be unique. By default the property is set to true.
|
|
3594
|
+
*
|
|
3595
|
+
* @example
|
|
3596
|
+
* ```jsx
|
|
3597
|
+
* <GridToolbarCheckboxFilter uniqueData={true} />
|
|
3598
|
+
* ```
|
|
3599
|
+
*/
|
|
3600
|
+
uniqueData?: boolean;
|
|
3601
|
+
/**
|
|
3602
|
+
* Specifies if the popup will be displayed.
|
|
3603
|
+
*
|
|
3604
|
+
* @example
|
|
3605
|
+
* ```jsx
|
|
3606
|
+
* <GridToolbarCheckboxFilter show={true} />
|
|
3607
|
+
* ```
|
|
3608
|
+
*/
|
|
3609
|
+
show?: boolean;
|
|
3610
|
+
/**
|
|
3611
|
+
* The method that will be called to close the column menu.
|
|
3612
|
+
*
|
|
3613
|
+
* @example
|
|
3614
|
+
* ```jsx
|
|
3615
|
+
* <GridToolbarCheckboxFilter onCloseMenu={() => console.log('close menu');} />
|
|
3616
|
+
* ```
|
|
3617
|
+
*/
|
|
3618
|
+
onCloseMenu?: Function;
|
|
3619
|
+
}
|
|
3620
|
+
|
|
3621
|
+
/**
|
|
3622
|
+
* Represents the GridToolbarColumnsChooser component.
|
|
3623
|
+
*/
|
|
3624
|
+
export declare const GridToolbarColumnsChooser: {
|
|
3625
|
+
(props: GridToolbarColumnsChooserProps): JSX.Element;
|
|
3626
|
+
displayName: string;
|
|
3627
|
+
};
|
|
3628
|
+
|
|
3629
|
+
export declare interface GridToolbarColumnsChooserProps {
|
|
3630
|
+
/**
|
|
3631
|
+
* Defines the icon rendered in the GridToolbarSort tool ([see example]({% slug overview_icon %})).
|
|
3632
|
+
*
|
|
3633
|
+
* @example
|
|
3634
|
+
* ```jsx
|
|
3635
|
+
* <GridToolbarSort icon="home" />
|
|
3636
|
+
* ```
|
|
3637
|
+
*/
|
|
3638
|
+
icon?: string;
|
|
3639
|
+
/**
|
|
3640
|
+
* Defines the SVG icon rendered in the GridToolbarSort tool ([see example]({% slug overview_svgicon %})).
|
|
3641
|
+
*
|
|
3642
|
+
* @example
|
|
3643
|
+
* ```jsx
|
|
3644
|
+
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
3645
|
+
*
|
|
3646
|
+
* <GridToolbarSort svgIcon={gearIcon} />
|
|
3647
|
+
* ```
|
|
3648
|
+
*/
|
|
3649
|
+
svgIcon?: SVGIcon;
|
|
3650
|
+
/**
|
|
3651
|
+
* Specifies if the popup will be displayed.
|
|
3652
|
+
*
|
|
3653
|
+
* @example
|
|
3654
|
+
* ```jsx
|
|
3655
|
+
* <GridToolbarColumnsChooser show={true} />
|
|
3656
|
+
* ```
|
|
3657
|
+
*/
|
|
3658
|
+
show?: boolean;
|
|
3659
|
+
/**
|
|
3660
|
+
* The method that will be called to close the column menu.
|
|
3661
|
+
*
|
|
3662
|
+
* @example
|
|
3663
|
+
* ```jsx
|
|
3664
|
+
* <GridToolbarColumnsChooser onCloseMenu={() => console.log('close menu');} />
|
|
3665
|
+
*/
|
|
3666
|
+
onCloseMenu?: Function;
|
|
3667
|
+
}
|
|
3668
|
+
|
|
3669
|
+
/**
|
|
3670
|
+
* Represents the GridToolbarFilter component.
|
|
3671
|
+
*/
|
|
3672
|
+
export declare const GridToolbarFilter: {
|
|
3673
|
+
(props: GridToolbarFilterProps): JSX.Element;
|
|
3674
|
+
displayName: string;
|
|
3675
|
+
};
|
|
3676
|
+
|
|
3677
|
+
export declare interface GridToolbarFilterProps {
|
|
3678
|
+
/**
|
|
3679
|
+
* Defines the icon rendered in the GridToolbarFilter tool ([see example]({% slug overview_icon %})).
|
|
3680
|
+
*
|
|
3681
|
+
* @example
|
|
3682
|
+
* ```jsx
|
|
3683
|
+
* <GridToolbarFilter icon="home" />
|
|
3684
|
+
* ```
|
|
3685
|
+
*/
|
|
3686
|
+
icon?: string;
|
|
3687
|
+
/**
|
|
3688
|
+
* Defines the SVG icon rendered in the GridToolbarFilter tool ([see example]({% slug overview_svgicon %})).
|
|
3689
|
+
*
|
|
3690
|
+
* @example
|
|
3691
|
+
* ```jsx
|
|
3692
|
+
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
3693
|
+
*
|
|
3694
|
+
* <GridToolbarFilter svgIcon={gearIcon} />
|
|
3695
|
+
* ```
|
|
3696
|
+
*/
|
|
3697
|
+
svgIcon?: SVGIcon;
|
|
3698
|
+
/**
|
|
3699
|
+
* If set to `false`, the second filter operator and the input will be hidden.
|
|
3700
|
+
*/
|
|
3701
|
+
hideSecondFilter?: boolean;
|
|
3702
|
+
/**
|
|
3703
|
+
* Specifies a React element that will be cloned and rendered inside the UI of the column-menu filter component
|
|
3704
|
+
* ([see example]({% slug column_menu_grid %}#toc-customizing-the-filter-component)).
|
|
3705
|
+
*/
|
|
3706
|
+
filterUI?: ComponentType<GridColumnMenuFilterUIProps>;
|
|
3707
|
+
/**
|
|
3708
|
+
* Specifies if the popup will be displayed.
|
|
3709
|
+
*
|
|
3710
|
+
* @example
|
|
3711
|
+
* ```jsx
|
|
3712
|
+
* <GridToolbarFilter show={true} />
|
|
3713
|
+
* ```
|
|
3714
|
+
*/
|
|
3715
|
+
show?: boolean;
|
|
3716
|
+
/**
|
|
3717
|
+
* The method that will be called to close the column menu.
|
|
3718
|
+
*
|
|
3719
|
+
* @example
|
|
3720
|
+
* ```jsx
|
|
3721
|
+
* <GridToolbarFilter onCloseMenu={() => console.log('close menu');} />
|
|
3722
|
+
* ```
|
|
3723
|
+
*/
|
|
3724
|
+
onCloseMenu?: Function;
|
|
3725
|
+
/**
|
|
3726
|
+
* The method that will be called to notify the parent Grid about a filter change.
|
|
3727
|
+
*/
|
|
3728
|
+
onFilterChange?: (filter: CompositeFilterDescriptor | null, syntheticEvent: React_2.SyntheticEvent<any>) => any;
|
|
3729
|
+
}
|
|
3730
|
+
|
|
3731
|
+
/**
|
|
3732
|
+
* The properties of the GridToolbar component.
|
|
3733
|
+
*/
|
|
3734
|
+
export declare interface GridToolbarProps extends ToolbarProps {
|
|
3643
3735
|
/**
|
|
3644
3736
|
* @hidden
|
|
3645
3737
|
*/
|
|
3646
|
-
|
|
3738
|
+
_ariaControls?: string;
|
|
3739
|
+
}
|
|
3740
|
+
|
|
3741
|
+
/**
|
|
3742
|
+
* Represents the GridToolbarSort component.
|
|
3743
|
+
*/
|
|
3744
|
+
export declare const GridToolbarSort: {
|
|
3745
|
+
(props: GridToolbarSortProps): any;
|
|
3746
|
+
displayName: string;
|
|
3747
|
+
};
|
|
3748
|
+
|
|
3749
|
+
export declare interface GridToolbarSortProps {
|
|
3750
|
+
/**
|
|
3751
|
+
* Defines the icon rendered in the GridToolbarSort tool ([see example]({% slug overview_icon %})).
|
|
3752
|
+
*
|
|
3753
|
+
* @example
|
|
3754
|
+
* ```jsx
|
|
3755
|
+
* <GridToolbarSort icon="home" />
|
|
3756
|
+
* ```
|
|
3757
|
+
*/
|
|
3758
|
+
icon?: string;
|
|
3759
|
+
/**
|
|
3760
|
+
* Defines the SVG icon rendered in the GridToolbarSort tool ([see example]({% slug overview_svgicon %})).
|
|
3761
|
+
*
|
|
3762
|
+
* @example
|
|
3763
|
+
* ```jsx
|
|
3764
|
+
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
3765
|
+
*
|
|
3766
|
+
* <GridToolbarSort svgIcon={gearIcon} />
|
|
3767
|
+
* ```
|
|
3768
|
+
*/
|
|
3769
|
+
svgIcon?: SVGIcon_2;
|
|
3770
|
+
/**
|
|
3771
|
+
* Specifies if the popup will be displayed.
|
|
3772
|
+
*
|
|
3773
|
+
* @example
|
|
3774
|
+
* ```jsx
|
|
3775
|
+
* <GridToolbarSort show={true} />
|
|
3776
|
+
* ```
|
|
3777
|
+
*/
|
|
3778
|
+
show?: boolean;
|
|
3779
|
+
/**
|
|
3780
|
+
* The method that will be called to close the column menu.
|
|
3781
|
+
*
|
|
3782
|
+
* @example
|
|
3783
|
+
* ```jsx
|
|
3784
|
+
* <GridToolbarSort onCloseMenu={() => console.log('close menu');} />
|
|
3785
|
+
* ```
|
|
3786
|
+
*/
|
|
3787
|
+
onCloseMenu?: Function;
|
|
3647
3788
|
}
|
|
3648
3789
|
|
|
3649
3790
|
/**
|
|
@@ -3744,9 +3885,9 @@ export declare interface StatusBarProps {
|
|
|
3744
3885
|
/**
|
|
3745
3886
|
* Represents the arguments of the getStatusData function.
|
|
3746
3887
|
*/
|
|
3747
|
-
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | '
|
|
3888
|
+
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 'select'> & {
|
|
3748
3889
|
dataItemKey: Required<GridProps>['dataItemKey'];
|
|
3749
|
-
}
|
|
3890
|
+
};
|
|
3750
3891
|
|
|
3751
3892
|
/**
|
|
3752
3893
|
* Represents the KendoReact Grid's StatusItem object.
|