@progress/kendo-react-grid 11.0.0-develop.11 → 11.0.0-develop.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Grid.js +1 -1
- package/Grid.mjs +6 -9
- package/GridClientWrapper.js +1 -1
- package/GridClientWrapper.mjs +330 -351
- package/GridComponent.js +1 -1
- package/GridComponent.mjs +343 -369
- package/StatusBar.js +1 -1
- package/StatusBar.mjs +23 -23
- package/cells/GridFilterCell.js +1 -1
- package/cells/GridFilterCell.mjs +46 -46
- package/cells/datacell/GridCell.js +1 -1
- package/cells/datacell/GridCell.mjs +9 -15
- package/cells/editcell/GridEditCell.js +1 -1
- package/cells/editcell/GridEditCell.mjs +7 -13
- package/cells/groupcell/GridGroupCell.js +1 -1
- package/cells/groupcell/GridGroupCell.mjs +8 -10
- package/cells/hierarchycell/GridHierarchyCell.js +1 -1
- package/cells/hierarchycell/GridHierarchyCell.mjs +8 -14
- package/cells/hierarchycell/useHierarchyCellClientTdProps.js +1 -1
- package/cells/hierarchycell/useHierarchyCellClientTdProps.mjs +15 -18
- package/cells/selectioncell/GridSelectionCell.js +1 -1
- package/cells/selectioncell/GridSelectionCell.mjs +7 -13
- package/dist/cdn/js/kendo-react-grid.js +1 -1
- package/footer/FooterCell.js +1 -1
- package/footer/FooterCell.mjs +14 -14
- 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/HeaderRow.js +1 -1
- package/header/HeaderRow.mjs +19 -20
- package/header/client/GridFilterCellContainer.js +1 -1
- package/header/client/GridFilterCellContainer.mjs +10 -11
- package/header/client/GridHeaderCellContainer.js +1 -1
- package/header/client/GridHeaderCellContainer.mjs +6 -7
- package/index.d.mts +9 -168
- package/index.d.ts +9 -168
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +16 -16
- package/rows/GridRow.js +1 -1
- package/rows/GridRow.mjs +32 -33
- package/utils/index.js +1 -1
- package/utils/index.mjs +162 -165
- package/utils/premium.js +1 -1
- package/utils/premium.mjs +18 -22
- package/components/GridCustomCellClientContainer.js +0 -9
- package/components/GridCustomCellClientContainer.mjs +0 -34
package/index.d.mts
CHANGED
|
@@ -252,6 +252,7 @@ declare interface ExtendedColumnProps extends GridColumnProps {
|
|
|
252
252
|
_type?: 'edit' | 'expand';
|
|
253
253
|
rowSpannable?: Required<GridRowSpannableSettings>;
|
|
254
254
|
defaultCell?: any;
|
|
255
|
+
defaultHeaderCell?: any;
|
|
255
256
|
}
|
|
256
257
|
|
|
257
258
|
/**
|
|
@@ -377,11 +378,6 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
377
378
|
* Supported values are `text`, `numeric`, `boolean`, and `date`.
|
|
378
379
|
*/
|
|
379
380
|
editor?: 'text' | 'numeric' | 'boolean' | 'date';
|
|
380
|
-
/**
|
|
381
|
-
* A function to override the default rendering of the cell.
|
|
382
|
-
* Accepts the default rendering and props as arguments and returns a React element.
|
|
383
|
-
*/
|
|
384
|
-
render?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | null;
|
|
385
381
|
/**
|
|
386
382
|
* @hidden
|
|
387
383
|
*/
|
|
@@ -1210,16 +1206,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1210
1206
|
* ```
|
|
1211
1207
|
*/
|
|
1212
1208
|
media?: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
|
|
1215
|
-
*
|
|
1216
|
-
* @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.
|
|
1217
|
-
* @example
|
|
1218
|
-
* ```jsx
|
|
1219
|
-
* <GridColumn cell={CustomCell} />
|
|
1220
|
-
* ```
|
|
1221
|
-
*/
|
|
1222
|
-
cell?: ComponentType<GridCellProps>;
|
|
1223
1209
|
/**
|
|
1224
1210
|
* Specifies a set of cell components that the Grid will render instead of the built-in cell.
|
|
1225
1211
|
*
|
|
@@ -1229,42 +1215,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1229
1215
|
* ```
|
|
1230
1216
|
*/
|
|
1231
1217
|
cells?: GridCellsSettings;
|
|
1232
|
-
/**
|
|
1233
|
-
* Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
|
|
1234
|
-
*
|
|
1235
|
-
* @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.
|
|
1236
|
-
* @example
|
|
1237
|
-
* ```jsx
|
|
1238
|
-
* <GridColumn filterCell={CustomFilterCell} />
|
|
1239
|
-
* ```
|
|
1240
|
-
*/
|
|
1241
|
-
filterCell?: ComponentType<GridFilterCellProps>;
|
|
1242
|
-
/**
|
|
1243
|
-
* Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
|
|
1244
|
-
*
|
|
1245
|
-
* @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.
|
|
1246
|
-
* @example
|
|
1247
|
-
* ```jsx
|
|
1248
|
-
* <GridColumn headerCell={CustomHeaderCell} />
|
|
1249
|
-
* ```
|
|
1250
|
-
*/
|
|
1251
|
-
headerCell?: ComponentType<GridHeaderCellProps>;
|
|
1252
|
-
/**
|
|
1253
|
-
* Defines the component that will be rendered as a footer cell.
|
|
1254
|
-
* The footer has to render an HTML `<td>` element and applies the `style` and `colspan` values from its props.
|
|
1255
|
-
*
|
|
1256
|
-
* @example
|
|
1257
|
-
* ```jsx-no-run
|
|
1258
|
-
* <GridColumn
|
|
1259
|
-
* footerCell={props => (
|
|
1260
|
-
* <td className='k-table-td' colSpan={props.colSpan} style={props.style} role={'gridcell'}>Sum: 50</td>
|
|
1261
|
-
* )}
|
|
1262
|
-
* />
|
|
1263
|
-
* ```
|
|
1264
|
-
*
|
|
1265
|
-
* @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.
|
|
1266
|
-
*/
|
|
1267
|
-
footerCell?: ComponentType<GridFooterCellProps>;
|
|
1268
1218
|
/**
|
|
1269
1219
|
* Sets the type of the column and renders a dedicated column for interaction.
|
|
1270
1220
|
*
|
|
@@ -1674,7 +1624,7 @@ export declare interface GridDetailExpandChangeEvent extends GridEvent {
|
|
|
1674
1624
|
}
|
|
1675
1625
|
|
|
1676
1626
|
/**
|
|
1677
|
-
* Represents the detail row class of the KendoReact Grid. Used to define custom details for each row. Can be applied for building the hierarchy.
|
|
1627
|
+
* 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.
|
|
1678
1628
|
*
|
|
1679
1629
|
* @example
|
|
1680
1630
|
* ```jsx
|
|
@@ -1776,25 +1726,7 @@ export declare type GridEditDialogProps = DialogProps & {
|
|
|
1776
1726
|
export declare interface GridEvent extends BaseEvent<GridHandle> {
|
|
1777
1727
|
}
|
|
1778
1728
|
|
|
1779
|
-
|
|
1780
|
-
* Represents the object of the `onExpandChange` Grid event.
|
|
1781
|
-
*/
|
|
1782
|
-
export declare interface GridExpandChangeEvent extends GridEvent {
|
|
1783
|
-
/**
|
|
1784
|
-
* The data item that is expanded or collapsed.
|
|
1785
|
-
*/
|
|
1786
|
-
dataItem: any;
|
|
1787
|
-
/**
|
|
1788
|
-
* Indicates whether the data item is expanded or collapsed
|
|
1789
|
-
*/
|
|
1790
|
-
value: boolean;
|
|
1791
|
-
/**
|
|
1792
|
-
* Zero based index of the data item.
|
|
1793
|
-
*/
|
|
1794
|
-
dataIndex: number;
|
|
1795
|
-
}
|
|
1796
|
-
|
|
1797
|
-
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;
|
|
1729
|
+
export declare const GridFilterCell: (props: GridFilterCellProps) => JSX.Element;
|
|
1798
1730
|
|
|
1799
1731
|
/**
|
|
1800
1732
|
* The props of the GridFilterCell component
|
|
@@ -1838,10 +1770,6 @@ export declare interface GridFilterCellProps {
|
|
|
1838
1770
|
* The list of values for the Boolean filter.
|
|
1839
1771
|
*/
|
|
1840
1772
|
booleanValues: GridFilterOperator[];
|
|
1841
|
-
/**
|
|
1842
|
-
* A function for overriding the default rendering of the filter cell.
|
|
1843
|
-
*/
|
|
1844
|
-
render?: (row: React.ReactElement<any>, dataItem: GridFilterCellProps) => React.ReactNode;
|
|
1845
1773
|
/**
|
|
1846
1774
|
* Accessible label of the filter.
|
|
1847
1775
|
*/
|
|
@@ -2090,17 +2018,13 @@ export declare interface GridHandle {
|
|
|
2090
2018
|
* export default App;
|
|
2091
2019
|
* ```
|
|
2092
2020
|
*/
|
|
2093
|
-
export declare const GridHeaderCell: (props: GridHeaderCellProps) =>
|
|
2021
|
+
export declare const GridHeaderCell: (props: GridHeaderCellProps) => JSX.Element;
|
|
2094
2022
|
|
|
2095
2023
|
/**
|
|
2096
2024
|
* The props of the GridHeaderCell component
|
|
2097
2025
|
* ([more information]({% slug cells_grid %}#toc-header-cells)).
|
|
2098
2026
|
*/
|
|
2099
2027
|
export declare interface GridHeaderCellProps extends Omit<HeaderCellBaseProps, 'render'> {
|
|
2100
|
-
/**
|
|
2101
|
-
* A function for overriding the default rendering of the header cell.
|
|
2102
|
-
*/
|
|
2103
|
-
render?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
2104
2028
|
/**
|
|
2105
2029
|
* The props of the Grid column menu wrapper.
|
|
2106
2030
|
*/
|
|
@@ -2127,10 +2051,6 @@ export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
|
2127
2051
|
* The current Grid leaf data items.
|
|
2128
2052
|
*/
|
|
2129
2053
|
dataItems: any[];
|
|
2130
|
-
/**
|
|
2131
|
-
* The `selectedField` prop of the Grid.
|
|
2132
|
-
*/
|
|
2133
|
-
selectedField: string;
|
|
2134
2054
|
}
|
|
2135
2055
|
|
|
2136
2056
|
/**
|
|
@@ -2838,24 +2758,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2838
2758
|
* ```
|
|
2839
2759
|
*/
|
|
2840
2760
|
onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
|
|
2841
|
-
/**
|
|
2842
|
-
* Fires when the user tries to expand or collapse a row.
|
|
2843
|
-
*
|
|
2844
|
-
* @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.
|
|
2845
|
-
* We’re removing this prop in version 11.0.0.
|
|
2846
|
-
* ```
|
|
2847
|
-
*/
|
|
2848
|
-
onExpandChange?: (event: GridExpandChangeEvent) => void;
|
|
2849
|
-
/**
|
|
2850
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
|
|
2851
|
-
*
|
|
2852
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
|
|
2853
|
-
*
|
|
2854
|
-
* @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.
|
|
2855
|
-
* We’re removing this prop in version 11.0.0.
|
|
2856
|
-
* ```
|
|
2857
|
-
*/
|
|
2858
|
-
expandField?: string;
|
|
2859
2761
|
/**
|
|
2860
2762
|
* The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
|
|
2861
2763
|
* Passing a boolean value will select the whole row, while passing an array of strings will select individual.
|
|
@@ -2884,16 +2786,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2884
2786
|
* ```
|
|
2885
2787
|
*/
|
|
2886
2788
|
selectable?: boolean | GridSelectableSettings;
|
|
2887
|
-
/**
|
|
2888
|
-
* Specifies the name of the field which will provide a:
|
|
2889
|
-
* - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
|
|
2890
|
-
* - String array of the selected columns of the item for cell selection
|
|
2891
|
-
*
|
|
2892
|
-
* @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
|
|
2893
|
-
* We’re removing this prop in version 11.0.0.
|
|
2894
|
-
* ```
|
|
2895
|
-
*/
|
|
2896
|
-
selectedField?: string;
|
|
2897
2789
|
/**
|
|
2898
2790
|
* Fires when the user tries to select or deselect a row or cell.
|
|
2899
2791
|
*
|
|
@@ -2904,7 +2796,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2904
2796
|
*/
|
|
2905
2797
|
onSelectionChange?: (event: GridSelectionChangeEvent) => void;
|
|
2906
2798
|
/**
|
|
2907
|
-
* Fires when the user clicks the checkbox of a column header whose
|
|
2799
|
+
* Fires when the user clicks the checkbox of a column header whose type is set to `checkbox`.
|
|
2908
2800
|
*
|
|
2909
2801
|
* @example
|
|
2910
2802
|
* ```jsx
|
|
@@ -2975,16 +2867,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2975
2867
|
* ```
|
|
2976
2868
|
*/
|
|
2977
2869
|
onEditChange?: (event: GridEditChangeEvent) => void;
|
|
2978
|
-
/**
|
|
2979
|
-
* Specifies the name of the field which will provide a Boolean representation of the edit state
|
|
2980
|
-
* of the current item ([more information and examples]({% slug editing_inline_grid %})).
|
|
2981
|
-
*
|
|
2982
|
-
* @example
|
|
2983
|
-
* ```jsx
|
|
2984
|
-
* <Grid editField="inEdit" />
|
|
2985
|
-
* ```
|
|
2986
|
-
*/
|
|
2987
|
-
editField?: string;
|
|
2988
2870
|
/**
|
|
2989
2871
|
* Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmodes_grid %})).
|
|
2990
2872
|
*
|
|
@@ -3134,30 +3016,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
3134
3016
|
* ```
|
|
3135
3017
|
*/
|
|
3136
3018
|
onColumnReorder?: (event: GridColumnReorderEvent) => void;
|
|
3137
|
-
/**
|
|
3138
|
-
* Fires when a row is about to be rendered. Overrides the default appearance of the row.
|
|
3139
|
-
*
|
|
3140
|
-
* @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.
|
|
3141
|
-
*/
|
|
3142
|
-
rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
3143
|
-
/**
|
|
3144
|
-
* Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
|
|
3145
|
-
*
|
|
3146
|
-
* @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.
|
|
3147
|
-
*/
|
|
3148
|
-
cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
|
|
3149
|
-
/**
|
|
3150
|
-
* Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
|
|
3151
|
-
*
|
|
3152
|
-
* @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.
|
|
3153
|
-
*/
|
|
3154
|
-
filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
|
|
3155
|
-
/**
|
|
3156
|
-
* Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
|
|
3157
|
-
*
|
|
3158
|
-
* @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.
|
|
3159
|
-
*/
|
|
3160
|
-
headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
3161
3019
|
/**
|
|
3162
3020
|
* Fires when Grid is scrolled. Only fired when the Grid is run as a client component.
|
|
3163
3021
|
*
|
|
@@ -3204,15 +3062,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
3204
3062
|
* ```
|
|
3205
3063
|
*/
|
|
3206
3064
|
onKeyDown?: (event: GridKeyDownEvent) => void;
|
|
3207
|
-
/**
|
|
3208
|
-
* The accessible label of the Grid.
|
|
3209
|
-
*/
|
|
3210
|
-
/**
|
|
3211
|
-
* **Deprecated**. The accessible label of the Grid. Use ([messages]({% slug globalization_grid %})) instead.
|
|
3212
|
-
*
|
|
3213
|
-
* @deprecated
|
|
3214
|
-
*/
|
|
3215
|
-
ariaLabel?: string;
|
|
3216
3065
|
/**
|
|
3217
3066
|
* Defines if the group descriptor columns are locked (frozen or sticky).
|
|
3218
3067
|
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
@@ -3335,7 +3184,7 @@ export declare type GridReorderDropPosition = 'before' | 'after' | 'forbidden';
|
|
|
3335
3184
|
/**
|
|
3336
3185
|
* The component for each of the items in the `data` property which the Grid renders.
|
|
3337
3186
|
*/
|
|
3338
|
-
export declare const GridRow: (props: GridRowProps) =>
|
|
3187
|
+
export declare const GridRow: (props: GridRowProps) => JSX.Element;
|
|
3339
3188
|
|
|
3340
3189
|
/**
|
|
3341
3190
|
* Represents the object of the `onRowClick` Grid event.
|
|
@@ -3358,7 +3207,7 @@ export declare interface GridRowDoubleClickEvent extends GridEvent {
|
|
|
3358
3207
|
}
|
|
3359
3208
|
|
|
3360
3209
|
/**
|
|
3361
|
-
* The props that the Grid passes to the GridRow component when creating it. Accessible
|
|
3210
|
+
* 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.
|
|
3362
3211
|
*/
|
|
3363
3212
|
export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
3364
3213
|
/**
|
|
@@ -3385,10 +3234,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
3385
3234
|
* The event that is fired when the row is double clicked.
|
|
3386
3235
|
*/
|
|
3387
3236
|
onDoubleClick: any;
|
|
3388
|
-
/**
|
|
3389
|
-
* The name of the field which will provide a Boolean representation of the selected state of the item.
|
|
3390
|
-
*/
|
|
3391
|
-
selectedField?: string;
|
|
3392
3237
|
/**
|
|
3393
3238
|
* Sets the height of the row.
|
|
3394
3239
|
*/
|
|
@@ -3397,10 +3242,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
3397
3242
|
* The type of the row.
|
|
3398
3243
|
*/
|
|
3399
3244
|
rowType: GridRowType;
|
|
3400
|
-
/**
|
|
3401
|
-
* A function for overriding the default rendering of the row.
|
|
3402
|
-
*/
|
|
3403
|
-
render?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
3404
3245
|
/**
|
|
3405
3246
|
* Sets a set of rows components that the Grid will render instead of the built-in row.
|
|
3406
3247
|
*/
|
|
@@ -3778,9 +3619,9 @@ export declare interface StatusBarProps {
|
|
|
3778
3619
|
/**
|
|
3779
3620
|
* Represents the arguments of the getStatusData function.
|
|
3780
3621
|
*/
|
|
3781
|
-
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | '
|
|
3622
|
+
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 'select'> & {
|
|
3782
3623
|
dataItemKey: Required<GridProps>['dataItemKey'];
|
|
3783
|
-
}
|
|
3624
|
+
};
|
|
3784
3625
|
|
|
3785
3626
|
/**
|
|
3786
3627
|
* Represents the KendoReact Grid's StatusItem object.
|
package/index.d.ts
CHANGED
|
@@ -252,6 +252,7 @@ declare interface ExtendedColumnProps extends GridColumnProps {
|
|
|
252
252
|
_type?: 'edit' | 'expand';
|
|
253
253
|
rowSpannable?: Required<GridRowSpannableSettings>;
|
|
254
254
|
defaultCell?: any;
|
|
255
|
+
defaultHeaderCell?: any;
|
|
255
256
|
}
|
|
256
257
|
|
|
257
258
|
/**
|
|
@@ -377,11 +378,6 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
|
|
|
377
378
|
* Supported values are `text`, `numeric`, `boolean`, and `date`.
|
|
378
379
|
*/
|
|
379
380
|
editor?: 'text' | 'numeric' | 'boolean' | 'date';
|
|
380
|
-
/**
|
|
381
|
-
* A function to override the default rendering of the cell.
|
|
382
|
-
* Accepts the default rendering and props as arguments and returns a React element.
|
|
383
|
-
*/
|
|
384
|
-
render?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | null;
|
|
385
381
|
/**
|
|
386
382
|
* @hidden
|
|
387
383
|
*/
|
|
@@ -1210,16 +1206,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1210
1206
|
* ```
|
|
1211
1207
|
*/
|
|
1212
1208
|
media?: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
|
|
1215
|
-
*
|
|
1216
|
-
* @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.
|
|
1217
|
-
* @example
|
|
1218
|
-
* ```jsx
|
|
1219
|
-
* <GridColumn cell={CustomCell} />
|
|
1220
|
-
* ```
|
|
1221
|
-
*/
|
|
1222
|
-
cell?: ComponentType<GridCellProps>;
|
|
1223
1209
|
/**
|
|
1224
1210
|
* Specifies a set of cell components that the Grid will render instead of the built-in cell.
|
|
1225
1211
|
*
|
|
@@ -1229,42 +1215,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
1229
1215
|
* ```
|
|
1230
1216
|
*/
|
|
1231
1217
|
cells?: GridCellsSettings;
|
|
1232
|
-
/**
|
|
1233
|
-
* Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
|
|
1234
|
-
*
|
|
1235
|
-
* @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.
|
|
1236
|
-
* @example
|
|
1237
|
-
* ```jsx
|
|
1238
|
-
* <GridColumn filterCell={CustomFilterCell} />
|
|
1239
|
-
* ```
|
|
1240
|
-
*/
|
|
1241
|
-
filterCell?: ComponentType<GridFilterCellProps>;
|
|
1242
|
-
/**
|
|
1243
|
-
* Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
|
|
1244
|
-
*
|
|
1245
|
-
* @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.
|
|
1246
|
-
* @example
|
|
1247
|
-
* ```jsx
|
|
1248
|
-
* <GridColumn headerCell={CustomHeaderCell} />
|
|
1249
|
-
* ```
|
|
1250
|
-
*/
|
|
1251
|
-
headerCell?: ComponentType<GridHeaderCellProps>;
|
|
1252
|
-
/**
|
|
1253
|
-
* Defines the component that will be rendered as a footer cell.
|
|
1254
|
-
* The footer has to render an HTML `<td>` element and applies the `style` and `colspan` values from its props.
|
|
1255
|
-
*
|
|
1256
|
-
* @example
|
|
1257
|
-
* ```jsx-no-run
|
|
1258
|
-
* <GridColumn
|
|
1259
|
-
* footerCell={props => (
|
|
1260
|
-
* <td className='k-table-td' colSpan={props.colSpan} style={props.style} role={'gridcell'}>Sum: 50</td>
|
|
1261
|
-
* )}
|
|
1262
|
-
* />
|
|
1263
|
-
* ```
|
|
1264
|
-
*
|
|
1265
|
-
* @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.
|
|
1266
|
-
*/
|
|
1267
|
-
footerCell?: ComponentType<GridFooterCellProps>;
|
|
1268
1218
|
/**
|
|
1269
1219
|
* Sets the type of the column and renders a dedicated column for interaction.
|
|
1270
1220
|
*
|
|
@@ -1674,7 +1624,7 @@ export declare interface GridDetailExpandChangeEvent extends GridEvent {
|
|
|
1674
1624
|
}
|
|
1675
1625
|
|
|
1676
1626
|
/**
|
|
1677
|
-
* Represents the detail row class of the KendoReact Grid. Used to define custom details for each row. Can be applied for building the hierarchy.
|
|
1627
|
+
* 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.
|
|
1678
1628
|
*
|
|
1679
1629
|
* @example
|
|
1680
1630
|
* ```jsx
|
|
@@ -1776,25 +1726,7 @@ export declare type GridEditDialogProps = DialogProps & {
|
|
|
1776
1726
|
export declare interface GridEvent extends BaseEvent<GridHandle> {
|
|
1777
1727
|
}
|
|
1778
1728
|
|
|
1779
|
-
|
|
1780
|
-
* Represents the object of the `onExpandChange` Grid event.
|
|
1781
|
-
*/
|
|
1782
|
-
export declare interface GridExpandChangeEvent extends GridEvent {
|
|
1783
|
-
/**
|
|
1784
|
-
* The data item that is expanded or collapsed.
|
|
1785
|
-
*/
|
|
1786
|
-
dataItem: any;
|
|
1787
|
-
/**
|
|
1788
|
-
* Indicates whether the data item is expanded or collapsed
|
|
1789
|
-
*/
|
|
1790
|
-
value: boolean;
|
|
1791
|
-
/**
|
|
1792
|
-
* Zero based index of the data item.
|
|
1793
|
-
*/
|
|
1794
|
-
dataIndex: number;
|
|
1795
|
-
}
|
|
1796
|
-
|
|
1797
|
-
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;
|
|
1729
|
+
export declare const GridFilterCell: (props: GridFilterCellProps) => JSX.Element;
|
|
1798
1730
|
|
|
1799
1731
|
/**
|
|
1800
1732
|
* The props of the GridFilterCell component
|
|
@@ -1838,10 +1770,6 @@ export declare interface GridFilterCellProps {
|
|
|
1838
1770
|
* The list of values for the Boolean filter.
|
|
1839
1771
|
*/
|
|
1840
1772
|
booleanValues: GridFilterOperator[];
|
|
1841
|
-
/**
|
|
1842
|
-
* A function for overriding the default rendering of the filter cell.
|
|
1843
|
-
*/
|
|
1844
|
-
render?: (row: React.ReactElement<any>, dataItem: GridFilterCellProps) => React.ReactNode;
|
|
1845
1773
|
/**
|
|
1846
1774
|
* Accessible label of the filter.
|
|
1847
1775
|
*/
|
|
@@ -2090,17 +2018,13 @@ export declare interface GridHandle {
|
|
|
2090
2018
|
* export default App;
|
|
2091
2019
|
* ```
|
|
2092
2020
|
*/
|
|
2093
|
-
export declare const GridHeaderCell: (props: GridHeaderCellProps) =>
|
|
2021
|
+
export declare const GridHeaderCell: (props: GridHeaderCellProps) => JSX.Element;
|
|
2094
2022
|
|
|
2095
2023
|
/**
|
|
2096
2024
|
* The props of the GridHeaderCell component
|
|
2097
2025
|
* ([more information]({% slug cells_grid %}#toc-header-cells)).
|
|
2098
2026
|
*/
|
|
2099
2027
|
export declare interface GridHeaderCellProps extends Omit<HeaderCellBaseProps, 'render'> {
|
|
2100
|
-
/**
|
|
2101
|
-
* A function for overriding the default rendering of the header cell.
|
|
2102
|
-
*/
|
|
2103
|
-
render?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
2104
2028
|
/**
|
|
2105
2029
|
* The props of the Grid column menu wrapper.
|
|
2106
2030
|
*/
|
|
@@ -2127,10 +2051,6 @@ export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
|
|
|
2127
2051
|
* The current Grid leaf data items.
|
|
2128
2052
|
*/
|
|
2129
2053
|
dataItems: any[];
|
|
2130
|
-
/**
|
|
2131
|
-
* The `selectedField` prop of the Grid.
|
|
2132
|
-
*/
|
|
2133
|
-
selectedField: string;
|
|
2134
2054
|
}
|
|
2135
2055
|
|
|
2136
2056
|
/**
|
|
@@ -2838,24 +2758,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2838
2758
|
* ```
|
|
2839
2759
|
*/
|
|
2840
2760
|
onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
|
|
2841
|
-
/**
|
|
2842
|
-
* Fires when the user tries to expand or collapse a row.
|
|
2843
|
-
*
|
|
2844
|
-
* @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.
|
|
2845
|
-
* We’re removing this prop in version 11.0.0.
|
|
2846
|
-
* ```
|
|
2847
|
-
*/
|
|
2848
|
-
onExpandChange?: (event: GridExpandChangeEvent) => void;
|
|
2849
|
-
/**
|
|
2850
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
|
|
2851
|
-
*
|
|
2852
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
|
|
2853
|
-
*
|
|
2854
|
-
* @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.
|
|
2855
|
-
* We’re removing this prop in version 11.0.0.
|
|
2856
|
-
* ```
|
|
2857
|
-
*/
|
|
2858
|
-
expandField?: string;
|
|
2859
2761
|
/**
|
|
2860
2762
|
* The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
|
|
2861
2763
|
* Passing a boolean value will select the whole row, while passing an array of strings will select individual.
|
|
@@ -2884,16 +2786,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2884
2786
|
* ```
|
|
2885
2787
|
*/
|
|
2886
2788
|
selectable?: boolean | GridSelectableSettings;
|
|
2887
|
-
/**
|
|
2888
|
-
* Specifies the name of the field which will provide a:
|
|
2889
|
-
* - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
|
|
2890
|
-
* - String array of the selected columns of the item for cell selection
|
|
2891
|
-
*
|
|
2892
|
-
* @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
|
|
2893
|
-
* We’re removing this prop in version 11.0.0.
|
|
2894
|
-
* ```
|
|
2895
|
-
*/
|
|
2896
|
-
selectedField?: string;
|
|
2897
2789
|
/**
|
|
2898
2790
|
* Fires when the user tries to select or deselect a row or cell.
|
|
2899
2791
|
*
|
|
@@ -2904,7 +2796,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2904
2796
|
*/
|
|
2905
2797
|
onSelectionChange?: (event: GridSelectionChangeEvent) => void;
|
|
2906
2798
|
/**
|
|
2907
|
-
* Fires when the user clicks the checkbox of a column header whose
|
|
2799
|
+
* Fires when the user clicks the checkbox of a column header whose type is set to `checkbox`.
|
|
2908
2800
|
*
|
|
2909
2801
|
* @example
|
|
2910
2802
|
* ```jsx
|
|
@@ -2975,16 +2867,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
2975
2867
|
* ```
|
|
2976
2868
|
*/
|
|
2977
2869
|
onEditChange?: (event: GridEditChangeEvent) => void;
|
|
2978
|
-
/**
|
|
2979
|
-
* Specifies the name of the field which will provide a Boolean representation of the edit state
|
|
2980
|
-
* of the current item ([more information and examples]({% slug editing_inline_grid %})).
|
|
2981
|
-
*
|
|
2982
|
-
* @example
|
|
2983
|
-
* ```jsx
|
|
2984
|
-
* <Grid editField="inEdit" />
|
|
2985
|
-
* ```
|
|
2986
|
-
*/
|
|
2987
|
-
editField?: string;
|
|
2988
2870
|
/**
|
|
2989
2871
|
* Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmodes_grid %})).
|
|
2990
2872
|
*
|
|
@@ -3134,30 +3016,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
3134
3016
|
* ```
|
|
3135
3017
|
*/
|
|
3136
3018
|
onColumnReorder?: (event: GridColumnReorderEvent) => void;
|
|
3137
|
-
/**
|
|
3138
|
-
* Fires when a row is about to be rendered. Overrides the default appearance of the row.
|
|
3139
|
-
*
|
|
3140
|
-
* @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.
|
|
3141
|
-
*/
|
|
3142
|
-
rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
3143
|
-
/**
|
|
3144
|
-
* Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
|
|
3145
|
-
*
|
|
3146
|
-
* @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.
|
|
3147
|
-
*/
|
|
3148
|
-
cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
|
|
3149
|
-
/**
|
|
3150
|
-
* Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
|
|
3151
|
-
*
|
|
3152
|
-
* @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.
|
|
3153
|
-
*/
|
|
3154
|
-
filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
|
|
3155
|
-
/**
|
|
3156
|
-
* Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
|
|
3157
|
-
*
|
|
3158
|
-
* @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.
|
|
3159
|
-
*/
|
|
3160
|
-
headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
|
|
3161
3019
|
/**
|
|
3162
3020
|
* Fires when Grid is scrolled. Only fired when the Grid is run as a client component.
|
|
3163
3021
|
*
|
|
@@ -3204,15 +3062,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
|
|
|
3204
3062
|
* ```
|
|
3205
3063
|
*/
|
|
3206
3064
|
onKeyDown?: (event: GridKeyDownEvent) => void;
|
|
3207
|
-
/**
|
|
3208
|
-
* The accessible label of the Grid.
|
|
3209
|
-
*/
|
|
3210
|
-
/**
|
|
3211
|
-
* **Deprecated**. The accessible label of the Grid. Use ([messages]({% slug globalization_grid %})) instead.
|
|
3212
|
-
*
|
|
3213
|
-
* @deprecated
|
|
3214
|
-
*/
|
|
3215
|
-
ariaLabel?: string;
|
|
3216
3065
|
/**
|
|
3217
3066
|
* Defines if the group descriptor columns are locked (frozen or sticky).
|
|
3218
3067
|
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
@@ -3335,7 +3184,7 @@ export declare type GridReorderDropPosition = 'before' | 'after' | 'forbidden';
|
|
|
3335
3184
|
/**
|
|
3336
3185
|
* The component for each of the items in the `data` property which the Grid renders.
|
|
3337
3186
|
*/
|
|
3338
|
-
export declare const GridRow: (props: GridRowProps) =>
|
|
3187
|
+
export declare const GridRow: (props: GridRowProps) => JSX.Element;
|
|
3339
3188
|
|
|
3340
3189
|
/**
|
|
3341
3190
|
* Represents the object of the `onRowClick` Grid event.
|
|
@@ -3358,7 +3207,7 @@ export declare interface GridRowDoubleClickEvent extends GridEvent {
|
|
|
3358
3207
|
}
|
|
3359
3208
|
|
|
3360
3209
|
/**
|
|
3361
|
-
* The props that the Grid passes to the GridRow component when creating it. Accessible
|
|
3210
|
+
* 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.
|
|
3362
3211
|
*/
|
|
3363
3212
|
export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
3364
3213
|
/**
|
|
@@ -3385,10 +3234,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
3385
3234
|
* The event that is fired when the row is double clicked.
|
|
3386
3235
|
*/
|
|
3387
3236
|
onDoubleClick: any;
|
|
3388
|
-
/**
|
|
3389
|
-
* The name of the field which will provide a Boolean representation of the selected state of the item.
|
|
3390
|
-
*/
|
|
3391
|
-
selectedField?: string;
|
|
3392
3237
|
/**
|
|
3393
3238
|
* Sets the height of the row.
|
|
3394
3239
|
*/
|
|
@@ -3397,10 +3242,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
|
|
|
3397
3242
|
* The type of the row.
|
|
3398
3243
|
*/
|
|
3399
3244
|
rowType: GridRowType;
|
|
3400
|
-
/**
|
|
3401
|
-
* A function for overriding the default rendering of the row.
|
|
3402
|
-
*/
|
|
3403
|
-
render?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
|
|
3404
3245
|
/**
|
|
3405
3246
|
* Sets a set of rows components that the Grid will render instead of the built-in row.
|
|
3406
3247
|
*/
|
|
@@ -3778,9 +3619,9 @@ export declare interface StatusBarProps {
|
|
|
3778
3619
|
/**
|
|
3779
3620
|
* Represents the arguments of the getStatusData function.
|
|
3780
3621
|
*/
|
|
3781
|
-
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | '
|
|
3622
|
+
export declare type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 'select'> & {
|
|
3782
3623
|
dataItemKey: Required<GridProps>['dataItemKey'];
|
|
3783
|
-
}
|
|
3624
|
+
};
|
|
3784
3625
|
|
|
3785
3626
|
/**
|
|
3786
3627
|
* Represents the KendoReact Grid's StatusItem object.
|
package/package-metadata.js
CHANGED
|
@@ -5,4 +5,4 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-react-grid",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate:
|
|
8
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-react-grid",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1747226723,version:"11.0.0-develop.12",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"};exports.packageMetadata=e;
|
package/package-metadata.mjs
CHANGED
|
@@ -10,8 +10,8 @@ const e = {
|
|
|
10
10
|
productName: "KendoReact",
|
|
11
11
|
productCode: "KENDOUIREACT",
|
|
12
12
|
productCodes: ["KENDOUIREACT"],
|
|
13
|
-
publishDate:
|
|
14
|
-
version: "11.0.0-develop.
|
|
13
|
+
publishDate: 1747226723,
|
|
14
|
+
version: "11.0.0-develop.12",
|
|
15
15
|
licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
|
|
16
16
|
};
|
|
17
17
|
export {
|