@progress/kendo-vue-grid 11.0.0 → 11.1.0-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BasePDFExport.d.ts +3 -0
- package/Grid.d.ts +11 -2
- package/Grid.mjs +1 -1
- package/GridCsvExportButton.d.ts +9 -4
- package/GridSearchBox.d.ts +9 -3
- package/GridToolbar.d.ts +10 -1
- package/RootGrid.d.ts +46 -23
- package/StatusBar.d.ts +7 -3
- package/codemods/v8/grid-ref-api.js +1 -1
- package/columnMenu/GridColumnMenuFilter.d.ts +5 -1
- package/components/noRecords/GridNoRecords.d.ts +7 -2
- package/dist/cdn/js/kendo-vue-grid.js +1 -1
- package/interfaces/GridCellProps.d.ts +3 -3
- package/interfaces/GridColumnMenuGroupBaseProps.d.ts +1 -1
- package/interfaces/GridColumnProps.d.ts +58 -45
- package/interfaces/GridFilterCellProps.d.ts +1 -1
- package/interfaces/GridFooterCellProps.d.ts +6 -0
- package/interfaces/GridGroupableSettings.d.ts +1 -1
- package/interfaces/GridNoRecordsProps.d.ts +1 -1
- package/interfaces/GridProps.d.ts +189 -166
- package/interfaces/GridToolbarProps.d.ts +1 -1
- package/interfaces/events.d.ts +3 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +14 -14
- package/utils/dataProcessing.d.ts +3 -3
|
@@ -17,11 +17,11 @@ export interface GridCellProps {
|
|
|
17
17
|
*/
|
|
18
18
|
id: string;
|
|
19
19
|
/**
|
|
20
|
-
* The field to which the cell is bound ([see example](
|
|
20
|
+
* The field to which the cell is bound ([see example](slug:sorting_grid)).
|
|
21
21
|
*/
|
|
22
22
|
key?: number;
|
|
23
23
|
/**
|
|
24
|
-
* The field to which the cell is bound ([see example](
|
|
24
|
+
* The field to which the cell is bound ([see example](slug:sorting_grid)).
|
|
25
25
|
*/
|
|
26
26
|
field: string;
|
|
27
27
|
/**
|
|
@@ -29,7 +29,7 @@ export interface GridCellProps {
|
|
|
29
29
|
*/
|
|
30
30
|
dataItem: any;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* The zero-based index of the data item in the data collection.
|
|
33
33
|
*/
|
|
34
34
|
dataIndex?: number;
|
|
35
35
|
/**
|
|
@@ -16,7 +16,7 @@ export interface GridColumnMenuGroupBaseProps extends GridColumnMenuBaseProps {
|
|
|
16
16
|
*/
|
|
17
17
|
groupable?: boolean;
|
|
18
18
|
/**
|
|
19
|
-
* The current group state of the Grid. It takes value of type [GroupDescriptor](
|
|
19
|
+
* The current group state of the Grid. It takes value of type [GroupDescriptor](slug:api_kendo-data-query_groupdescriptor)[]
|
|
20
20
|
*/
|
|
21
21
|
group?: GroupDescriptor[];
|
|
22
22
|
/**
|
|
@@ -18,7 +18,7 @@ import { GridFilterCellProps } from './GridFilterCellProps';
|
|
|
18
18
|
import { GridFooterCellProps } from './GridFooterCellProps';
|
|
19
19
|
import { GridCellsSettings } from './GridCellsSettings';
|
|
20
20
|
/**
|
|
21
|
-
* The props that can
|
|
21
|
+
* The props that you can set on a Grid column.
|
|
22
22
|
*/
|
|
23
23
|
export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
24
24
|
/**
|
|
@@ -31,18 +31,22 @@ export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
31
31
|
title?: string;
|
|
32
32
|
/**
|
|
33
33
|
* Defines whether the column is editable
|
|
34
|
-
* ([more information and examples](
|
|
34
|
+
* ([more information and examples](slug:editing_inline_grid)).
|
|
35
|
+
*
|
|
36
|
+
* @default true
|
|
35
37
|
*/
|
|
36
38
|
editable?: boolean;
|
|
37
39
|
/**
|
|
38
|
-
* Allows the
|
|
39
|
-
* You have to handle the `sortChange` event
|
|
40
|
+
* Allows the user to click the column header and emit the `sortChange` event.
|
|
41
|
+
* You have to handle the `sortChange` event and sort the data yourself.
|
|
40
42
|
*
|
|
41
43
|
* @default true
|
|
42
44
|
*/
|
|
43
45
|
sortable?: GridColumnSortSettings;
|
|
44
46
|
/**
|
|
45
|
-
* `obsolete` Will be removed in the next major release. Use
|
|
47
|
+
* `obsolete` Will be removed in the next major release. Use the `cells` prop instead.
|
|
48
|
+
*
|
|
49
|
+
* Defines a custom rendering for the cells of the column.
|
|
46
50
|
*/
|
|
47
51
|
cell?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
|
|
48
52
|
/**
|
|
@@ -54,34 +58,35 @@ export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
54
58
|
*/
|
|
55
59
|
defaultHeaderCell?: any;
|
|
56
60
|
/**
|
|
57
|
-
* `obsolete` Will be removed in the next major release. Use
|
|
61
|
+
* `obsolete` Will be removed in the next major release. Use the `cells.filterCell` prop instead.
|
|
62
|
+
*
|
|
63
|
+
* Defines a custom rendering for the filter cell of the column.
|
|
58
64
|
*/
|
|
59
65
|
filterCell?: ((h: any, defaultRendering: any | null, props: GridFilterCellProps, listeners: any) => any) | string | any;
|
|
60
66
|
/**
|
|
61
|
-
* Defines
|
|
67
|
+
* Defines whether the column renders a filter UI.
|
|
62
68
|
*
|
|
63
69
|
* @default true
|
|
64
70
|
*/
|
|
65
71
|
filterable?: boolean;
|
|
66
72
|
/**
|
|
67
|
-
* Defines the title
|
|
68
|
-
*
|
|
73
|
+
* Defines the title that the Grid sets to the input element in the filter cell.
|
|
69
74
|
*/
|
|
70
75
|
filterTitle?: string;
|
|
71
76
|
/**
|
|
72
|
-
* Defines the filter type that
|
|
77
|
+
* Defines the filter type that the filter row renders.
|
|
73
78
|
*
|
|
74
79
|
* @default 'text'
|
|
75
80
|
*/
|
|
76
81
|
filter?: GridDataType;
|
|
77
82
|
/**
|
|
78
|
-
* Defines the editor type
|
|
83
|
+
* Defines the editor type that the column uses in edit mode ([more information and examples](slug:editing_inline_grid)).
|
|
79
84
|
*
|
|
80
85
|
* @default 'text'
|
|
81
86
|
*/
|
|
82
87
|
editor?: GridDataType;
|
|
83
88
|
/**
|
|
84
|
-
* Overrides the default(three vertical dots)
|
|
89
|
+
* Overrides the default column menu icon (three vertical dots) or the icon that you set through the ([`columnMenuIcon`](slug:api_grid_gridprops#toc-columnmenuicon)) property.
|
|
85
90
|
*/
|
|
86
91
|
menuIcon?: SVGIcon;
|
|
87
92
|
/**
|
|
@@ -89,29 +94,33 @@ export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
89
94
|
*/
|
|
90
95
|
width?: string | number;
|
|
91
96
|
/**
|
|
92
|
-
* The width of the column (in pixels) below which the user
|
|
93
|
-
* Defaults to `10`. It
|
|
94
|
-
* not
|
|
97
|
+
* The width of the column (in pixels) below which the user cannot resize the column through the UI.
|
|
98
|
+
* Defaults to `10`. It applies only to the minimum width when the user drags the column edge. It does
|
|
99
|
+
* not affect the width of the columns when the browser window is resized.
|
|
95
100
|
*/
|
|
96
101
|
minResizableWidth?: number;
|
|
97
102
|
/**
|
|
98
|
-
* `obsolete` Will be removed in the next major release. Use
|
|
103
|
+
* `obsolete` Will be removed in the next major release. Use the `cells.headerCell` prop instead.
|
|
104
|
+
*
|
|
105
|
+
* Defines a custom rendering for the header cell of the column.
|
|
99
106
|
*/
|
|
100
107
|
headerCell?: ((h: any, defaultRendering: any | null, props: GridHeaderCellProps, listeners: any) => any) | string | any;
|
|
101
108
|
/**
|
|
102
|
-
* `obsolete` Will be removed in the next major release. Use
|
|
109
|
+
* `obsolete` Will be removed in the next major release. Use the `cells.footerCell` prop instead.
|
|
110
|
+
*
|
|
111
|
+
* Defines a custom rendering for the footer cell of the column.
|
|
103
112
|
*/
|
|
104
113
|
footerCell?: ((h: any, defaultRendering: any | null, props: GridFooterCellProps, listeners: any) => any) | string | any;
|
|
105
114
|
/**
|
|
106
|
-
* Sets
|
|
115
|
+
* Sets custom CSS classes to the footer cell of the column, if the column has a footer.
|
|
107
116
|
*/
|
|
108
117
|
footerClassName?: string;
|
|
109
118
|
/**
|
|
110
|
-
* Defines
|
|
119
|
+
* Defines whether the header selection checkbox is checked.
|
|
111
120
|
*/
|
|
112
121
|
headerSelectionValue?: boolean;
|
|
113
122
|
/**
|
|
114
|
-
* The format that
|
|
123
|
+
* The format that the Grid applies to the value before it shows it. Takes the `{0:format}`
|
|
115
124
|
* form where `format` is any of the following:
|
|
116
125
|
* * A standard number format
|
|
117
126
|
* * A custom number format
|
|
@@ -123,55 +132,60 @@ export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
123
132
|
*/
|
|
124
133
|
format?: string;
|
|
125
134
|
/**
|
|
126
|
-
* Sets the colSpan of the column
|
|
127
|
-
*
|
|
135
|
+
* Sets the `colSpan` of the column, so the row content spans over multiple cells.
|
|
136
|
+
* Accepts a number or a function that returns a number.
|
|
128
137
|
*
|
|
129
138
|
* @default 1
|
|
130
139
|
*/
|
|
131
140
|
colSpan?: number | ((colSpanProps: GridColSpanProps) => number);
|
|
132
141
|
/**
|
|
133
|
-
* Controls the visibility of the Grid
|
|
142
|
+
* Controls the visibility of the Grid column.
|
|
134
143
|
*
|
|
135
144
|
* @default false
|
|
136
145
|
*/
|
|
137
146
|
hidden?: boolean;
|
|
138
147
|
/**
|
|
139
|
-
* Sets the screen size condition that
|
|
140
|
-
*
|
|
148
|
+
* Sets the screen size condition that must match for the column to stay visible. If you set the `hidden` property, it overrides the `media` behavior.
|
|
141
149
|
*/
|
|
142
150
|
media?: string;
|
|
143
151
|
/**
|
|
144
|
-
* Specifies a set of cell components that the Grid
|
|
152
|
+
* Specifies a set of cell components that the Grid renders instead of the built-in cells.
|
|
145
153
|
*
|
|
146
154
|
* @example
|
|
147
|
-
* ```
|
|
148
|
-
* <
|
|
155
|
+
* ```vue
|
|
156
|
+
* <Grid :columns="[{ field: 'ProductName', cells: { data: CustomDataCell } }]" />
|
|
149
157
|
* ```
|
|
150
158
|
*/
|
|
151
159
|
cells?: GridCellsSettings;
|
|
152
160
|
/**
|
|
153
|
-
* Sets
|
|
161
|
+
* Sets custom CSS classes to the header cell of the column.
|
|
154
162
|
*/
|
|
155
163
|
headerClassName?: string;
|
|
156
164
|
/**
|
|
157
|
-
* Sets
|
|
165
|
+
* Sets custom CSS classes to the cells of the column.
|
|
158
166
|
*/
|
|
159
167
|
className?: string;
|
|
160
168
|
/**
|
|
161
|
-
* Indicates whether the
|
|
169
|
+
* Indicates whether the user can reorder the column.
|
|
170
|
+
*
|
|
171
|
+
* @default true
|
|
162
172
|
*/
|
|
163
173
|
reorderable?: boolean;
|
|
164
174
|
/**
|
|
165
|
-
* Indicates whether the
|
|
175
|
+
* Indicates whether the user can resize the column.
|
|
176
|
+
*
|
|
177
|
+
* @default true
|
|
166
178
|
*/
|
|
167
179
|
resizable?: boolean;
|
|
168
180
|
/**
|
|
169
|
-
*
|
|
170
|
-
* before columns with bigger `orderIndex`. Defaults to `0`.
|
|
181
|
+
* Determines the position of the column. Columns with a smaller `orderIndex` appear
|
|
182
|
+
* before columns with a bigger `orderIndex`. Defaults to `0`.
|
|
171
183
|
*/
|
|
172
184
|
orderIndex?: number;
|
|
173
185
|
/**
|
|
174
|
-
* Determines
|
|
186
|
+
* Determines whether the user can drag the column to the group panel.
|
|
187
|
+
*
|
|
188
|
+
* @default true
|
|
175
189
|
*/
|
|
176
190
|
groupable?: boolean;
|
|
177
191
|
/**
|
|
@@ -179,37 +193,36 @@ export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
|
|
|
179
193
|
*/
|
|
180
194
|
children?: (GridColumnProps)[] | (any)[];
|
|
181
195
|
/**
|
|
182
|
-
* Defines
|
|
183
|
-
* Accepts
|
|
196
|
+
* Defines whether the Grid shows the column menu for the column.
|
|
197
|
+
* Accepts a `boolean`, a Vue component, a `render` function, or a slot name.
|
|
184
198
|
*/
|
|
185
199
|
columnMenu?: boolean | any;
|
|
186
200
|
/**
|
|
187
|
-
* Defines
|
|
201
|
+
* Defines whether the column menu is open.
|
|
188
202
|
*/
|
|
189
203
|
columnMenuOpened?: boolean;
|
|
190
204
|
/**
|
|
191
|
-
* Defines
|
|
205
|
+
* Defines whether the column is locked. Locked columns stay in place and do not scroll horizontally.
|
|
192
206
|
*/
|
|
193
207
|
locked?: boolean;
|
|
194
208
|
/**
|
|
195
209
|
* Sets the type of the column and renders a dedicated column for interaction.
|
|
196
210
|
*
|
|
197
211
|
* @example
|
|
198
|
-
* ```
|
|
199
|
-
* { columnType:
|
|
212
|
+
* ```vue
|
|
213
|
+
* <Grid :columns="[{ columnType: 'checkbox' }]" />
|
|
200
214
|
* ```
|
|
201
215
|
* @default "data"
|
|
202
216
|
*/
|
|
203
217
|
columnType?: GridColumnType;
|
|
204
218
|
/**
|
|
205
|
-
* The type of the data
|
|
206
|
-
*
|
|
219
|
+
* The type of the data that the Grid uses when it formats the cell data.
|
|
220
|
+
* The possible values are `'string'`, `'number'`, `'boolean'`, and `'date'`.
|
|
207
221
|
* Defaults to `string`.
|
|
208
222
|
*/
|
|
209
223
|
type?: 'string' | 'number' | 'boolean' | 'date';
|
|
210
224
|
/**
|
|
211
|
-
* Defines
|
|
212
|
-
*
|
|
225
|
+
* Defines whether the Grid spans the cells of the column when their values are the same.
|
|
213
226
|
*/
|
|
214
227
|
rowSpannable?: boolean | GridRowSpannableSettings;
|
|
215
228
|
}
|
|
@@ -9,7 +9,7 @@ import { GridFilterOperator } from './GridFilterOperator';
|
|
|
9
9
|
import { GridFilterOperators } from './GridFilterOperators';
|
|
10
10
|
/**
|
|
11
11
|
* The props of the GridFilterCell component
|
|
12
|
-
* ([more information and examples](
|
|
12
|
+
* ([more information and examples](slug:filtering_grid)).
|
|
13
13
|
*/
|
|
14
14
|
/**
|
|
15
15
|
* @hidden
|
|
@@ -5,10 +5,16 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
+
/**
|
|
9
|
+
* Represents the props of the Kendo UI for Vue Grid footer cell.
|
|
10
|
+
*/
|
|
8
11
|
export interface GridFooterCellProps {
|
|
9
12
|
/**
|
|
10
13
|
* The field to which the footer cell is bound.
|
|
11
14
|
*/
|
|
12
15
|
field?: string;
|
|
16
|
+
/**
|
|
17
|
+
* The `colSpan` of the footer cell.
|
|
18
|
+
*/
|
|
13
19
|
colSpan?: number;
|
|
14
20
|
}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { GridGroupExpandableSettings } from './GridGroupExpandableSettings';
|
|
9
9
|
/**
|
|
10
10
|
* The settings for grouping the data of the Grid
|
|
11
|
-
* ([see example](
|
|
11
|
+
* ([see example](slug:groupingaggregates_grid)).
|
|
12
12
|
*/
|
|
13
13
|
export interface GridGroupableSettings {
|
|
14
14
|
/**
|