@progress/kendo-react-grid 7.5.0-develop.5 → 7.5.0-develop.7

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/index.d.mts CHANGED
@@ -773,7 +773,7 @@ export declare class GridColumnMenuFilter extends React_2.Component<GridColumnMe
773
773
  */
774
774
  declare interface GridColumnMenuFilterBaseProps extends GridColumnMenuBaseProps {
775
775
  /**
776
- * The current filter state of the Grid.
776
+ * The current filter state of the Grid.It takes value of type [CompositeFilterDescriptor]({% api_kendo-data-query_compositefilterdescriptor %})
777
777
  */
778
778
  filter?: CompositeFilterDescriptor;
779
779
  /**
@@ -983,7 +983,7 @@ declare interface GridColumnMenuGroupBaseProps extends GridColumnMenuBaseProps {
983
983
  */
984
984
  groupable?: boolean;
985
985
  /**
986
- * The current group state of the Grid.
986
+ * The current group state of the Grid. It takes value of type [GroupDescriptor]({% slug api_kendo-data-query_groupdescriptor %})[]
987
987
  */
988
988
  group?: GroupDescriptor[];
989
989
  /**
@@ -1160,7 +1160,7 @@ declare interface GridColumnMenuSortBaseProps extends GridColumnMenuBaseProps {
1160
1160
  */
1161
1161
  sortable?: GridSortSettings;
1162
1162
  /**
1163
- * The current sort state of the Grid.
1163
+ * The current sort state of the Grid. It takes a value of type [SortDescriptor]({% slug api_kendo-data-query_sortdescriptor %})[]
1164
1164
  */
1165
1165
  sort?: SortDescriptor[];
1166
1166
  /**
@@ -1468,7 +1468,7 @@ export declare interface GridCustomHeaderCellProps extends GridHeaderCellProps {
1468
1468
  */
1469
1469
  export declare interface GridDataStateChangeEvent extends GridEvent {
1470
1470
  /**
1471
- * The state of the Grid based on the user action.
1471
+ * The [State]({% api_kendo-data-query_state %}) of the Grid based on the user action.
1472
1472
  */
1473
1473
  dataState: State;
1474
1474
  targetEvent?: PagerTargetEvent;
@@ -1562,9 +1562,7 @@ export declare interface GridExpandChangeEvent extends GridEvent {
1562
1562
  */
1563
1563
  dataItem: any;
1564
1564
  /**
1565
- * The available values are:
1566
- * - `true`&mdash;If the data item is expanded.
1567
- * - `false`&mdash;If the data item is collapsed.
1565
+ * Indicates whether the data item is expanded or collapsed
1568
1566
  */
1569
1567
  value: boolean;
1570
1568
  /**
@@ -1657,7 +1655,7 @@ export declare interface GridFilterCellProps {
1657
1655
  */
1658
1656
  export declare interface GridFilterChangeEvent extends GridEvent {
1659
1657
  /**
1660
- * The new `CompositeFilterDescriptor` based on the user action.
1658
+ * The new [CompositeFilterDescriptor]({% api_kendo-data-query_compositefilterdescriptor %}) based on the user action.
1661
1659
  */
1662
1660
  filter: CompositeFilterDescriptor;
1663
1661
  }
@@ -1764,7 +1762,7 @@ export declare const GridGroupCell: (props: GridCellProps) => JSX_2.Element | nu
1764
1762
  */
1765
1763
  export declare interface GridGroupChangeEvent extends GridEvent {
1766
1764
  /**
1767
- * An array of `GroupDescriptor` that corresponds to the user action.
1765
+ * An array of [GroupDescriptor]({% slug api_kendo-data-query_groupdescriptor %})[] that corresponds to the user action.
1768
1766
  */
1769
1767
  group: GroupDescriptor[];
1770
1768
  }
@@ -2100,7 +2098,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2100
2098
  */
2101
2099
  cells?: GridCellsSettings;
2102
2100
  /**
2103
- * 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.
2101
+ * 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%})
2104
2102
  */
2105
2103
  data?: any[] | DataResult | null;
2106
2104
  /**
@@ -2120,7 +2118,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2120
2118
  */
2121
2119
  onSortChange?: (event: GridSortChangeEvent) => void;
2122
2120
  /**
2123
- * The descriptors by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
2121
+ * The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
2124
2122
  */
2125
2123
  sort?: SortDescriptor[];
2126
2124
  /**
@@ -2128,55 +2126,11 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2128
2126
  */
2129
2127
  filterable?: boolean;
2130
2128
  /**
2131
- * The descriptor by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
2129
+ * The [descriptor]({% api_kendo-data-query_compositefilterdescriptor %}) by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
2132
2130
  */
2133
2131
  filter?: CompositeFilterDescriptor;
2134
2132
  /**
2135
2133
  * The filter operators for the Grid filters.
2136
- *
2137
- * @example
2138
- * ```jsx
2139
- * const customFilterOperators = {
2140
- * 'text': [
2141
- * { text: 'grid.filterContainsOperator', operator: 'contains' }
2142
- * ],
2143
- * 'numeric': [
2144
- * { text: 'grid.filterGtOperator', operator: 'gt' }
2145
- * ],
2146
- * 'date': [
2147
- * { text: 'grid.filterAfterOperator', operator: 'gt' }
2148
- * ]
2149
- * }
2150
- *
2151
- * class App extends React.Component {
2152
- * constructor(props) {
2153
- * super(props);
2154
- * this.state = {
2155
- * data: [
2156
- * { 'foo': 'A1', 'bar': 'B1' },
2157
- * { 'foo': 'A2', 'bar': 'B2' },
2158
- * { 'foo': 'A3', 'bar': 'B2' }
2159
- * ]
2160
- * };
2161
- * }
2162
- * render() {
2163
- * return (
2164
- * <div>
2165
- * <Grid
2166
- * data={this.state.data}
2167
- * reorderable={true}
2168
- * filterable
2169
- * filterOperators={customFilterOperators}
2170
- * >
2171
- * <GridColumn field="foo" />
2172
- * <GridColumn field="bar" />
2173
- * </Grid>
2174
- * </div>
2175
- * );
2176
- * }
2177
- * }
2178
- * ReactDOM.render(<App />, document.querySelector('my-app'));
2179
- * ```
2180
2134
  */
2181
2135
  filterOperators?: GridFilterOperators;
2182
2136
  /**
@@ -2188,7 +2142,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2188
2142
  */
2189
2143
  columnMenu?: null | ComponentType<GridColumnMenuProps>;
2190
2144
  /**
2191
- * The descriptors by which the data will be grouped
2145
+ * The [descriptors]({% slug api_kendo-data-query_groupdescriptor %})[] by which the data will be grouped
2192
2146
  * ([more information and examples]({% slug groupingbasics_grid %})).
2193
2147
  */
2194
2148
  group?: GroupDescriptor[];
@@ -2213,7 +2167,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2213
2167
  */
2214
2168
  pageSize?: number;
2215
2169
  /**
2216
- * The pager component that the Grid will render instead of the built-in pager.
2170
+ * The pager component that the Grid will render instead of the built-in pager. It takes values of type null and ComponentType&lt;[PagerProps]({% slug api_data-tools_pagerprops %})&gt
2217
2171
  */
2218
2172
  pager?: null | ComponentType<PagerProps>;
2219
2173
  /**
@@ -2536,7 +2490,7 @@ export declare interface GridSelectionChangeEvent extends GridEvent, TableSelect
2536
2490
  */
2537
2491
  export declare interface GridSortChangeEvent extends GridEvent {
2538
2492
  /**
2539
- * The new `SortDescriptor` according to the user action.
2493
+ * The new ([SortDescriptor]({% slug api_kendo-data-query_sortdescriptor %})) according to the user action.
2540
2494
  */
2541
2495
  sort: SortDescriptor[];
2542
2496
  }
package/index.d.ts CHANGED
@@ -773,7 +773,7 @@ export declare class GridColumnMenuFilter extends React_2.Component<GridColumnMe
773
773
  */
774
774
  declare interface GridColumnMenuFilterBaseProps extends GridColumnMenuBaseProps {
775
775
  /**
776
- * The current filter state of the Grid.
776
+ * The current filter state of the Grid.It takes value of type [CompositeFilterDescriptor]({% api_kendo-data-query_compositefilterdescriptor %})
777
777
  */
778
778
  filter?: CompositeFilterDescriptor;
779
779
  /**
@@ -983,7 +983,7 @@ declare interface GridColumnMenuGroupBaseProps extends GridColumnMenuBaseProps {
983
983
  */
984
984
  groupable?: boolean;
985
985
  /**
986
- * The current group state of the Grid.
986
+ * The current group state of the Grid. It takes value of type [GroupDescriptor]({% slug api_kendo-data-query_groupdescriptor %})[]
987
987
  */
988
988
  group?: GroupDescriptor[];
989
989
  /**
@@ -1160,7 +1160,7 @@ declare interface GridColumnMenuSortBaseProps extends GridColumnMenuBaseProps {
1160
1160
  */
1161
1161
  sortable?: GridSortSettings;
1162
1162
  /**
1163
- * The current sort state of the Grid.
1163
+ * The current sort state of the Grid. It takes a value of type [SortDescriptor]({% slug api_kendo-data-query_sortdescriptor %})[]
1164
1164
  */
1165
1165
  sort?: SortDescriptor[];
1166
1166
  /**
@@ -1468,7 +1468,7 @@ export declare interface GridCustomHeaderCellProps extends GridHeaderCellProps {
1468
1468
  */
1469
1469
  export declare interface GridDataStateChangeEvent extends GridEvent {
1470
1470
  /**
1471
- * The state of the Grid based on the user action.
1471
+ * The [State]({% api_kendo-data-query_state %}) of the Grid based on the user action.
1472
1472
  */
1473
1473
  dataState: State;
1474
1474
  targetEvent?: PagerTargetEvent;
@@ -1562,9 +1562,7 @@ export declare interface GridExpandChangeEvent extends GridEvent {
1562
1562
  */
1563
1563
  dataItem: any;
1564
1564
  /**
1565
- * The available values are:
1566
- * - `true`&mdash;If the data item is expanded.
1567
- * - `false`&mdash;If the data item is collapsed.
1565
+ * Indicates whether the data item is expanded or collapsed
1568
1566
  */
1569
1567
  value: boolean;
1570
1568
  /**
@@ -1657,7 +1655,7 @@ export declare interface GridFilterCellProps {
1657
1655
  */
1658
1656
  export declare interface GridFilterChangeEvent extends GridEvent {
1659
1657
  /**
1660
- * The new `CompositeFilterDescriptor` based on the user action.
1658
+ * The new [CompositeFilterDescriptor]({% api_kendo-data-query_compositefilterdescriptor %}) based on the user action.
1661
1659
  */
1662
1660
  filter: CompositeFilterDescriptor;
1663
1661
  }
@@ -1764,7 +1762,7 @@ export declare const GridGroupCell: (props: GridCellProps) => JSX_2.Element | nu
1764
1762
  */
1765
1763
  export declare interface GridGroupChangeEvent extends GridEvent {
1766
1764
  /**
1767
- * An array of `GroupDescriptor` that corresponds to the user action.
1765
+ * An array of [GroupDescriptor]({% slug api_kendo-data-query_groupdescriptor %})[] that corresponds to the user action.
1768
1766
  */
1769
1767
  group: GroupDescriptor[];
1770
1768
  }
@@ -2100,7 +2098,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2100
2098
  */
2101
2099
  cells?: GridCellsSettings;
2102
2100
  /**
2103
- * 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.
2101
+ * 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%})
2104
2102
  */
2105
2103
  data?: any[] | DataResult | null;
2106
2104
  /**
@@ -2120,7 +2118,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2120
2118
  */
2121
2119
  onSortChange?: (event: GridSortChangeEvent) => void;
2122
2120
  /**
2123
- * The descriptors by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
2121
+ * The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
2124
2122
  */
2125
2123
  sort?: SortDescriptor[];
2126
2124
  /**
@@ -2128,55 +2126,11 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2128
2126
  */
2129
2127
  filterable?: boolean;
2130
2128
  /**
2131
- * The descriptor by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
2129
+ * The [descriptor]({% api_kendo-data-query_compositefilterdescriptor %}) by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
2132
2130
  */
2133
2131
  filter?: CompositeFilterDescriptor;
2134
2132
  /**
2135
2133
  * The filter operators for the Grid filters.
2136
- *
2137
- * @example
2138
- * ```jsx
2139
- * const customFilterOperators = {
2140
- * 'text': [
2141
- * { text: 'grid.filterContainsOperator', operator: 'contains' }
2142
- * ],
2143
- * 'numeric': [
2144
- * { text: 'grid.filterGtOperator', operator: 'gt' }
2145
- * ],
2146
- * 'date': [
2147
- * { text: 'grid.filterAfterOperator', operator: 'gt' }
2148
- * ]
2149
- * }
2150
- *
2151
- * class App extends React.Component {
2152
- * constructor(props) {
2153
- * super(props);
2154
- * this.state = {
2155
- * data: [
2156
- * { 'foo': 'A1', 'bar': 'B1' },
2157
- * { 'foo': 'A2', 'bar': 'B2' },
2158
- * { 'foo': 'A3', 'bar': 'B2' }
2159
- * ]
2160
- * };
2161
- * }
2162
- * render() {
2163
- * return (
2164
- * <div>
2165
- * <Grid
2166
- * data={this.state.data}
2167
- * reorderable={true}
2168
- * filterable
2169
- * filterOperators={customFilterOperators}
2170
- * >
2171
- * <GridColumn field="foo" />
2172
- * <GridColumn field="bar" />
2173
- * </Grid>
2174
- * </div>
2175
- * );
2176
- * }
2177
- * }
2178
- * ReactDOM.render(<App />, document.querySelector('my-app'));
2179
- * ```
2180
2134
  */
2181
2135
  filterOperators?: GridFilterOperators;
2182
2136
  /**
@@ -2188,7 +2142,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2188
2142
  */
2189
2143
  columnMenu?: null | ComponentType<GridColumnMenuProps>;
2190
2144
  /**
2191
- * The descriptors by which the data will be grouped
2145
+ * The [descriptors]({% slug api_kendo-data-query_groupdescriptor %})[] by which the data will be grouped
2192
2146
  * ([more information and examples]({% slug groupingbasics_grid %})).
2193
2147
  */
2194
2148
  group?: GroupDescriptor[];
@@ -2213,7 +2167,7 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2213
2167
  */
2214
2168
  pageSize?: number;
2215
2169
  /**
2216
- * The pager component that the Grid will render instead of the built-in pager.
2170
+ * The pager component that the Grid will render instead of the built-in pager. It takes values of type null and ComponentType&lt;[PagerProps]({% slug api_data-tools_pagerprops %})&gt
2217
2171
  */
2218
2172
  pager?: null | ComponentType<PagerProps>;
2219
2173
  /**
@@ -2536,7 +2490,7 @@ export declare interface GridSelectionChangeEvent extends GridEvent, TableSelect
2536
2490
  */
2537
2491
  export declare interface GridSortChangeEvent extends GridEvent {
2538
2492
  /**
2539
- * The new `SortDescriptor` according to the user action.
2493
+ * The new ([SortDescriptor]({% slug api_kendo-data-query_sortdescriptor %})) according to the user action.
2540
2494
  */
2541
2495
  sort: SortDescriptor[];
2542
2496
  }
@@ -10,7 +10,7 @@ const e = {
10
10
  name: "@progress/kendo-react-grid",
11
11
  productName: "KendoReact",
12
12
  productCodes: ["KENDOUIREACT", "KENDOUICOMPLETE"],
13
- publishDate: 1713444224,
13
+ publishDate: 1714045941,
14
14
  version: "",
15
15
  licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
16
16
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-react-grid",
3
- "version": "7.5.0-develop.5",
3
+ "version": "7.5.0-develop.7",
4
4
  "description": "React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",
@@ -23,17 +23,17 @@
23
23
  "sideEffects": false,
24
24
  "peerDependencies": {
25
25
  "@progress/kendo-data-query": "^1.0.0",
26
- "@progress/kendo-drawing": "^1.19.0",
26
+ "@progress/kendo-drawing": "^1.20.1",
27
27
  "@progress/kendo-licensing": "^1.3.4",
28
- "@progress/kendo-react-animation": "7.5.0-develop.5",
29
- "@progress/kendo-react-buttons": "7.5.0-develop.5",
30
- "@progress/kendo-react-common": "7.5.0-develop.5",
31
- "@progress/kendo-react-data-tools": "7.5.0-develop.5",
32
- "@progress/kendo-react-dateinputs": "7.5.0-develop.5",
33
- "@progress/kendo-react-dropdowns": "7.5.0-develop.5",
34
- "@progress/kendo-react-inputs": "7.5.0-develop.5",
35
- "@progress/kendo-react-intl": "7.5.0-develop.5",
36
- "@progress/kendo-react-popup": "7.5.0-develop.5",
28
+ "@progress/kendo-react-animation": "7.5.0-develop.7",
29
+ "@progress/kendo-react-buttons": "7.5.0-develop.7",
30
+ "@progress/kendo-react-common": "7.5.0-develop.7",
31
+ "@progress/kendo-react-data-tools": "7.5.0-develop.7",
32
+ "@progress/kendo-react-dateinputs": "7.5.0-develop.7",
33
+ "@progress/kendo-react-dropdowns": "7.5.0-develop.7",
34
+ "@progress/kendo-react-inputs": "7.5.0-develop.7",
35
+ "@progress/kendo-react-intl": "7.5.0-develop.7",
36
+ "@progress/kendo-react-popup": "7.5.0-develop.7",
37
37
  "@progress/kendo-svg-icons": "^2.1.0",
38
38
  "react": "^16.8.2 || ^17.0.0 || ^18.0.0",
39
39
  "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0"