@vaadin/grid-pro 25.1.2 → 25.2.0-alpha10
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/custom-elements.json +28 -7
- package/package.json +14 -14
- package/src/vaadin-grid-pro-edit-column-mixin.js +0 -1
- package/src/vaadin-grid-pro-edit-column.d.ts +3 -1
- package/src/vaadin-grid-pro-edit-select-mixin.js +2 -2
- package/src/vaadin-grid-pro-inline-editing-mixin.js +4 -28
- package/src/vaadin-grid-pro.d.ts +1 -1
- package/src/vaadin-grid-pro.js +1 -1
- package/web-types.json +93 -216
- package/web-types.lit.json +95 -109
package/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid-pro",
|
|
4
|
-
"version": "25.
|
|
4
|
+
"version": "25.2.0-alpha10",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -15,9 +15,7 @@
|
|
|
15
15
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
16
16
|
"value": {
|
|
17
17
|
"type": [
|
|
18
|
-
"boolean"
|
|
19
|
-
"null",
|
|
20
|
-
"undefined"
|
|
18
|
+
"boolean"
|
|
21
19
|
]
|
|
22
20
|
}
|
|
23
21
|
},
|
|
@@ -26,9 +24,7 @@
|
|
|
26
24
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
27
25
|
"value": {
|
|
28
26
|
"type": [
|
|
29
|
-
"string"
|
|
30
|
-
"null",
|
|
31
|
-
"undefined"
|
|
27
|
+
"string"
|
|
32
28
|
]
|
|
33
29
|
}
|
|
34
30
|
},
|
|
@@ -37,9 +33,7 @@
|
|
|
37
33
|
"description": "Path of the property used for the value of the editor component.",
|
|
38
34
|
"value": {
|
|
39
35
|
"type": [
|
|
40
|
-
"string"
|
|
41
|
-
"null",
|
|
42
|
-
"undefined"
|
|
36
|
+
"string"
|
|
43
37
|
]
|
|
44
38
|
}
|
|
45
39
|
},
|
|
@@ -48,9 +42,7 @@
|
|
|
48
42
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
49
43
|
"value": {
|
|
50
44
|
"type": [
|
|
51
|
-
"number"
|
|
52
|
-
"null",
|
|
53
|
-
"undefined"
|
|
45
|
+
"number"
|
|
54
46
|
]
|
|
55
47
|
}
|
|
56
48
|
},
|
|
@@ -59,9 +51,7 @@
|
|
|
59
51
|
"description": "Custom part name for the footer cell.",
|
|
60
52
|
"value": {
|
|
61
53
|
"type": [
|
|
62
|
-
"string"
|
|
63
|
-
"null",
|
|
64
|
-
"undefined"
|
|
54
|
+
"string"
|
|
65
55
|
]
|
|
66
56
|
}
|
|
67
57
|
},
|
|
@@ -70,9 +60,7 @@
|
|
|
70
60
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
71
61
|
"value": {
|
|
72
62
|
"type": [
|
|
73
|
-
"boolean"
|
|
74
|
-
"null",
|
|
75
|
-
"undefined"
|
|
63
|
+
"boolean"
|
|
76
64
|
]
|
|
77
65
|
}
|
|
78
66
|
},
|
|
@@ -81,9 +69,7 @@
|
|
|
81
69
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
82
70
|
"value": {
|
|
83
71
|
"type": [
|
|
84
|
-
"boolean"
|
|
85
|
-
"null",
|
|
86
|
-
"undefined"
|
|
72
|
+
"boolean"
|
|
87
73
|
]
|
|
88
74
|
}
|
|
89
75
|
},
|
|
@@ -92,9 +78,7 @@
|
|
|
92
78
|
"description": "Text content to display in the header cell of the column.",
|
|
93
79
|
"value": {
|
|
94
80
|
"type": [
|
|
95
|
-
"string"
|
|
96
|
-
"null",
|
|
97
|
-
"undefined"
|
|
81
|
+
"string"
|
|
98
82
|
]
|
|
99
83
|
}
|
|
100
84
|
},
|
|
@@ -103,9 +87,7 @@
|
|
|
103
87
|
"description": "Custom part name for the header cell.",
|
|
104
88
|
"value": {
|
|
105
89
|
"type": [
|
|
106
|
-
"string"
|
|
107
|
-
"null",
|
|
108
|
-
"undefined"
|
|
90
|
+
"string"
|
|
109
91
|
]
|
|
110
92
|
}
|
|
111
93
|
},
|
|
@@ -114,9 +96,7 @@
|
|
|
114
96
|
"description": "When set to true, the cells for this column are hidden.",
|
|
115
97
|
"value": {
|
|
116
98
|
"type": [
|
|
117
|
-
"boolean"
|
|
118
|
-
"null",
|
|
119
|
-
"undefined"
|
|
99
|
+
"boolean"
|
|
120
100
|
]
|
|
121
101
|
}
|
|
122
102
|
},
|
|
@@ -125,9 +105,7 @@
|
|
|
125
105
|
"description": "JS Path of the property in the item used for the editable content.",
|
|
126
106
|
"value": {
|
|
127
107
|
"type": [
|
|
128
|
-
"string"
|
|
129
|
-
"null",
|
|
130
|
-
"undefined"
|
|
108
|
+
"string"
|
|
131
109
|
]
|
|
132
110
|
}
|
|
133
111
|
},
|
|
@@ -136,9 +114,7 @@
|
|
|
136
114
|
"description": "When set to true, the column is user-resizable.",
|
|
137
115
|
"value": {
|
|
138
116
|
"type": [
|
|
139
|
-
"boolean"
|
|
140
|
-
"null",
|
|
141
|
-
"undefined"
|
|
117
|
+
"boolean"
|
|
142
118
|
]
|
|
143
119
|
}
|
|
144
120
|
},
|
|
@@ -147,9 +123,7 @@
|
|
|
147
123
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
148
124
|
"value": {
|
|
149
125
|
"type": [
|
|
150
|
-
"boolean"
|
|
151
|
-
"null",
|
|
152
|
-
"undefined"
|
|
126
|
+
"boolean"
|
|
153
127
|
]
|
|
154
128
|
}
|
|
155
129
|
},
|
|
@@ -158,9 +132,7 @@
|
|
|
158
132
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
159
133
|
"value": {
|
|
160
134
|
"type": [
|
|
161
|
-
"string"
|
|
162
|
-
"null",
|
|
163
|
-
"undefined"
|
|
135
|
+
"string"
|
|
164
136
|
]
|
|
165
137
|
}
|
|
166
138
|
},
|
|
@@ -180,9 +152,7 @@
|
|
|
180
152
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
181
153
|
"value": {
|
|
182
154
|
"type": [
|
|
183
|
-
"string"
|
|
184
|
-
"null",
|
|
185
|
-
"undefined"
|
|
155
|
+
"string"
|
|
186
156
|
]
|
|
187
157
|
}
|
|
188
158
|
}
|
|
@@ -194,9 +164,7 @@
|
|
|
194
164
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
195
165
|
"value": {
|
|
196
166
|
"type": [
|
|
197
|
-
"boolean"
|
|
198
|
-
"null",
|
|
199
|
-
"undefined"
|
|
167
|
+
"boolean"
|
|
200
168
|
]
|
|
201
169
|
}
|
|
202
170
|
},
|
|
@@ -216,7 +184,7 @@
|
|
|
216
184
|
"description": "The list of options which should be passed to cell editor component.\nUsed with the `select` editor type, to provide a list of items.",
|
|
217
185
|
"value": {
|
|
218
186
|
"type": [
|
|
219
|
-
"Array
|
|
187
|
+
"Array<string>"
|
|
220
188
|
]
|
|
221
189
|
}
|
|
222
190
|
},
|
|
@@ -225,9 +193,7 @@
|
|
|
225
193
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
226
194
|
"value": {
|
|
227
195
|
"type": [
|
|
228
|
-
"string"
|
|
229
|
-
"null",
|
|
230
|
-
"undefined"
|
|
196
|
+
"string"
|
|
231
197
|
]
|
|
232
198
|
}
|
|
233
199
|
},
|
|
@@ -236,9 +202,7 @@
|
|
|
236
202
|
"description": "Path of the property used for the value of the editor component.",
|
|
237
203
|
"value": {
|
|
238
204
|
"type": [
|
|
239
|
-
"string"
|
|
240
|
-
"null",
|
|
241
|
-
"undefined"
|
|
205
|
+
"string"
|
|
242
206
|
]
|
|
243
207
|
}
|
|
244
208
|
},
|
|
@@ -247,9 +211,7 @@
|
|
|
247
211
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
248
212
|
"value": {
|
|
249
213
|
"type": [
|
|
250
|
-
"number"
|
|
251
|
-
"null",
|
|
252
|
-
"undefined"
|
|
214
|
+
"number"
|
|
253
215
|
]
|
|
254
216
|
}
|
|
255
217
|
},
|
|
@@ -258,9 +220,7 @@
|
|
|
258
220
|
"description": "Custom part name for the footer cell.",
|
|
259
221
|
"value": {
|
|
260
222
|
"type": [
|
|
261
|
-
"string"
|
|
262
|
-
"null",
|
|
263
|
-
"undefined"
|
|
223
|
+
"string"
|
|
264
224
|
]
|
|
265
225
|
}
|
|
266
226
|
},
|
|
@@ -280,9 +240,7 @@
|
|
|
280
240
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
281
241
|
"value": {
|
|
282
242
|
"type": [
|
|
283
|
-
"boolean"
|
|
284
|
-
"null",
|
|
285
|
-
"undefined"
|
|
243
|
+
"boolean"
|
|
286
244
|
]
|
|
287
245
|
}
|
|
288
246
|
},
|
|
@@ -291,9 +249,7 @@
|
|
|
291
249
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
292
250
|
"value": {
|
|
293
251
|
"type": [
|
|
294
|
-
"boolean"
|
|
295
|
-
"null",
|
|
296
|
-
"undefined"
|
|
252
|
+
"boolean"
|
|
297
253
|
]
|
|
298
254
|
}
|
|
299
255
|
},
|
|
@@ -302,9 +258,7 @@
|
|
|
302
258
|
"description": "Text content to display in the header cell of the column.",
|
|
303
259
|
"value": {
|
|
304
260
|
"type": [
|
|
305
|
-
"string"
|
|
306
|
-
"null",
|
|
307
|
-
"undefined"
|
|
261
|
+
"string"
|
|
308
262
|
]
|
|
309
263
|
}
|
|
310
264
|
},
|
|
@@ -313,9 +267,7 @@
|
|
|
313
267
|
"description": "Custom part name for the header cell.",
|
|
314
268
|
"value": {
|
|
315
269
|
"type": [
|
|
316
|
-
"string"
|
|
317
|
-
"null",
|
|
318
|
-
"undefined"
|
|
270
|
+
"string"
|
|
319
271
|
]
|
|
320
272
|
}
|
|
321
273
|
},
|
|
@@ -335,9 +287,7 @@
|
|
|
335
287
|
"description": "When set to true, the cells for this column are hidden.",
|
|
336
288
|
"value": {
|
|
337
289
|
"type": [
|
|
338
|
-
"boolean"
|
|
339
|
-
"null",
|
|
340
|
-
"undefined"
|
|
290
|
+
"boolean"
|
|
341
291
|
]
|
|
342
292
|
}
|
|
343
293
|
},
|
|
@@ -346,9 +296,7 @@
|
|
|
346
296
|
"description": "A function to check whether a specific cell of this column can be\nedited. This allows to disable editing of individual rows or cells,\nbased on the item.\n\nReceives a `model` object containing the item for an individual row,\nand should return a boolean indicating whether the column's cell in\nthat row is editable.\n\nThe `model` object contains:\n- `model.index` The index of the item.\n- `model.item` The item.\n- `model.expanded` Sublevel toggle state.\n- `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n- `model.selected` Selected state.",
|
|
347
297
|
"value": {
|
|
348
298
|
"type": [
|
|
349
|
-
"
|
|
350
|
-
"null",
|
|
351
|
-
"undefined"
|
|
299
|
+
"model: GridItemModel => boolean"
|
|
352
300
|
]
|
|
353
301
|
}
|
|
354
302
|
},
|
|
@@ -357,9 +305,7 @@
|
|
|
357
305
|
"description": "JS Path of the property in the item used for the editable content.",
|
|
358
306
|
"value": {
|
|
359
307
|
"type": [
|
|
360
|
-
"string"
|
|
361
|
-
"null",
|
|
362
|
-
"undefined"
|
|
308
|
+
"string"
|
|
363
309
|
]
|
|
364
310
|
}
|
|
365
311
|
},
|
|
@@ -379,9 +325,7 @@
|
|
|
379
325
|
"description": "When set to true, the column is user-resizable.",
|
|
380
326
|
"value": {
|
|
381
327
|
"type": [
|
|
382
|
-
"boolean"
|
|
383
|
-
"null",
|
|
384
|
-
"undefined"
|
|
328
|
+
"boolean"
|
|
385
329
|
]
|
|
386
330
|
}
|
|
387
331
|
},
|
|
@@ -390,9 +334,7 @@
|
|
|
390
334
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
391
335
|
"value": {
|
|
392
336
|
"type": [
|
|
393
|
-
"boolean"
|
|
394
|
-
"null",
|
|
395
|
-
"undefined"
|
|
337
|
+
"boolean"
|
|
396
338
|
]
|
|
397
339
|
}
|
|
398
340
|
},
|
|
@@ -401,9 +343,7 @@
|
|
|
401
343
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
402
344
|
"value": {
|
|
403
345
|
"type": [
|
|
404
|
-
"string"
|
|
405
|
-
"null",
|
|
406
|
-
"undefined"
|
|
346
|
+
"string"
|
|
407
347
|
]
|
|
408
348
|
}
|
|
409
349
|
},
|
|
@@ -412,33 +352,24 @@
|
|
|
412
352
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
413
353
|
"value": {
|
|
414
354
|
"type": [
|
|
415
|
-
"string"
|
|
416
|
-
"null",
|
|
417
|
-
"undefined"
|
|
355
|
+
"string"
|
|
418
356
|
]
|
|
419
357
|
}
|
|
420
358
|
}
|
|
421
359
|
],
|
|
422
|
-
"events": [
|
|
423
|
-
{
|
|
424
|
-
"name": "editor-type-changed",
|
|
425
|
-
"description": "Fired when the `editorType` property changes."
|
|
426
|
-
}
|
|
427
|
-
]
|
|
360
|
+
"events": []
|
|
428
361
|
}
|
|
429
362
|
},
|
|
430
363
|
{
|
|
431
364
|
"name": "vaadin-grid-pro",
|
|
432
|
-
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/25.
|
|
365
|
+
"description": "\n`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-grid) documentation for details.\n\n```html\n<vaadin-grid-pro></vaadin-grid-pro>\n```\n\n### Internal components\n\nIn addition to `<vaadin-grid-pro>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-grid-pro-edit-checkbox>` - has the same API as [`<vaadin-checkbox>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-checkbox).\n- `<vaadin-grid-pro-edit-text-field>` - has the same API as [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-select).",
|
|
433
366
|
"attributes": [
|
|
434
367
|
{
|
|
435
368
|
"name": "accessible-name",
|
|
436
369
|
"description": "String used to label the grid to screen reader users.",
|
|
437
370
|
"value": {
|
|
438
371
|
"type": [
|
|
439
|
-
"string"
|
|
440
|
-
"null",
|
|
441
|
-
"undefined"
|
|
372
|
+
"string"
|
|
442
373
|
]
|
|
443
374
|
}
|
|
444
375
|
},
|
|
@@ -447,9 +378,7 @@
|
|
|
447
378
|
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
448
379
|
"value": {
|
|
449
380
|
"type": [
|
|
450
|
-
"boolean"
|
|
451
|
-
"null",
|
|
452
|
-
"undefined"
|
|
381
|
+
"boolean"
|
|
453
382
|
]
|
|
454
383
|
}
|
|
455
384
|
},
|
|
@@ -458,9 +387,7 @@
|
|
|
458
387
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
459
388
|
"value": {
|
|
460
389
|
"type": [
|
|
461
|
-
"string"
|
|
462
|
-
"null",
|
|
463
|
-
"undefined"
|
|
390
|
+
"string"
|
|
464
391
|
]
|
|
465
392
|
}
|
|
466
393
|
},
|
|
@@ -469,9 +396,16 @@
|
|
|
469
396
|
"description": "Set to true to allow column reordering.",
|
|
470
397
|
"value": {
|
|
471
398
|
"type": [
|
|
472
|
-
"boolean"
|
|
473
|
-
|
|
474
|
-
|
|
399
|
+
"boolean"
|
|
400
|
+
]
|
|
401
|
+
}
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "disabled",
|
|
405
|
+
"description": "If true, the user cannot interact with this element.",
|
|
406
|
+
"value": {
|
|
407
|
+
"type": [
|
|
408
|
+
"boolean"
|
|
475
409
|
]
|
|
476
410
|
}
|
|
477
411
|
},
|
|
@@ -480,9 +414,7 @@
|
|
|
480
414
|
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
481
415
|
"value": {
|
|
482
416
|
"type": [
|
|
483
|
-
"string"
|
|
484
|
-
"null",
|
|
485
|
-
"undefined"
|
|
417
|
+
"string"
|
|
486
418
|
]
|
|
487
419
|
}
|
|
488
420
|
},
|
|
@@ -491,9 +423,7 @@
|
|
|
491
423
|
"description": "When true, the grid enters cell edit mode on a single click\ninstead of the default double click.",
|
|
492
424
|
"value": {
|
|
493
425
|
"type": [
|
|
494
|
-
"boolean"
|
|
495
|
-
"null",
|
|
496
|
-
"undefined"
|
|
426
|
+
"boolean"
|
|
497
427
|
]
|
|
498
428
|
}
|
|
499
429
|
},
|
|
@@ -502,9 +432,7 @@
|
|
|
502
432
|
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
503
433
|
"value": {
|
|
504
434
|
"type": [
|
|
505
|
-
"boolean"
|
|
506
|
-
"null",
|
|
507
|
-
"undefined"
|
|
435
|
+
"boolean"
|
|
508
436
|
]
|
|
509
437
|
}
|
|
510
438
|
},
|
|
@@ -513,9 +441,7 @@
|
|
|
513
441
|
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
514
442
|
"value": {
|
|
515
443
|
"type": [
|
|
516
|
-
"string"
|
|
517
|
-
"null",
|
|
518
|
-
"undefined"
|
|
444
|
+
"string"
|
|
519
445
|
]
|
|
520
446
|
}
|
|
521
447
|
},
|
|
@@ -524,9 +450,7 @@
|
|
|
524
450
|
"description": "Path to an item sub-property that identifies the item.",
|
|
525
451
|
"value": {
|
|
526
452
|
"type": [
|
|
527
|
-
"string"
|
|
528
|
-
"null",
|
|
529
|
-
"undefined"
|
|
453
|
+
"string"
|
|
530
454
|
]
|
|
531
455
|
}
|
|
532
456
|
},
|
|
@@ -535,9 +459,7 @@
|
|
|
535
459
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
536
460
|
"value": {
|
|
537
461
|
"type": [
|
|
538
|
-
"boolean"
|
|
539
|
-
"null",
|
|
540
|
-
"undefined"
|
|
462
|
+
"boolean"
|
|
541
463
|
]
|
|
542
464
|
}
|
|
543
465
|
},
|
|
@@ -546,9 +468,7 @@
|
|
|
546
468
|
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
547
469
|
"value": {
|
|
548
470
|
"type": [
|
|
549
|
-
"boolean"
|
|
550
|
-
"null",
|
|
551
|
-
"undefined"
|
|
471
|
+
"boolean"
|
|
552
472
|
]
|
|
553
473
|
}
|
|
554
474
|
},
|
|
@@ -557,9 +477,7 @@
|
|
|
557
477
|
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
558
478
|
"value": {
|
|
559
479
|
"type": [
|
|
560
|
-
"string"
|
|
561
|
-
"null",
|
|
562
|
-
"undefined"
|
|
480
|
+
"string"
|
|
563
481
|
]
|
|
564
482
|
}
|
|
565
483
|
},
|
|
@@ -568,9 +486,7 @@
|
|
|
568
486
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
569
487
|
"value": {
|
|
570
488
|
"type": [
|
|
571
|
-
"number"
|
|
572
|
-
"null",
|
|
573
|
-
"undefined"
|
|
489
|
+
"number"
|
|
574
490
|
]
|
|
575
491
|
}
|
|
576
492
|
},
|
|
@@ -579,9 +495,7 @@
|
|
|
579
495
|
"description": "Marks the grid's rows to be available for dragging.",
|
|
580
496
|
"value": {
|
|
581
497
|
"type": [
|
|
582
|
-
"boolean"
|
|
583
|
-
"null",
|
|
584
|
-
"undefined"
|
|
498
|
+
"boolean"
|
|
585
499
|
]
|
|
586
500
|
}
|
|
587
501
|
},
|
|
@@ -590,9 +504,7 @@
|
|
|
590
504
|
"description": "When true, after moving to next or previous editable cell using\nTab / Shift+Tab, it will be focused without edit mode.\n\nWhen `enterNextRow` is true, pressing Enter will also\npreserve edit mode, otherwise, it will have no effect.",
|
|
591
505
|
"value": {
|
|
592
506
|
"type": [
|
|
593
|
-
"boolean"
|
|
594
|
-
"null",
|
|
595
|
-
"undefined"
|
|
507
|
+
"boolean"
|
|
596
508
|
]
|
|
597
509
|
}
|
|
598
510
|
},
|
|
@@ -601,9 +513,7 @@
|
|
|
601
513
|
"description": "The number of root-level items in the grid.",
|
|
602
514
|
"value": {
|
|
603
515
|
"type": [
|
|
604
|
-
"number"
|
|
605
|
-
"null",
|
|
606
|
-
"undefined"
|
|
516
|
+
"number"
|
|
607
517
|
]
|
|
608
518
|
}
|
|
609
519
|
},
|
|
@@ -626,9 +536,7 @@
|
|
|
626
536
|
"description": "String used to label the grid to screen reader users.",
|
|
627
537
|
"value": {
|
|
628
538
|
"type": [
|
|
629
|
-
"string"
|
|
630
|
-
"null",
|
|
631
|
-
"undefined"
|
|
539
|
+
"string"
|
|
632
540
|
]
|
|
633
541
|
}
|
|
634
542
|
},
|
|
@@ -646,9 +554,7 @@
|
|
|
646
554
|
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
647
555
|
"value": {
|
|
648
556
|
"type": [
|
|
649
|
-
"boolean"
|
|
650
|
-
"null",
|
|
651
|
-
"undefined"
|
|
557
|
+
"boolean"
|
|
652
558
|
]
|
|
653
559
|
}
|
|
654
560
|
},
|
|
@@ -668,9 +574,7 @@
|
|
|
668
574
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
669
575
|
"value": {
|
|
670
576
|
"type": [
|
|
671
|
-
"string"
|
|
672
|
-
"null",
|
|
673
|
-
"undefined"
|
|
577
|
+
"string"
|
|
674
578
|
]
|
|
675
579
|
}
|
|
676
580
|
},
|
|
@@ -679,9 +583,7 @@
|
|
|
679
583
|
"description": "Set to true to allow column reordering.",
|
|
680
584
|
"value": {
|
|
681
585
|
"type": [
|
|
682
|
-
"boolean"
|
|
683
|
-
"null",
|
|
684
|
-
"undefined"
|
|
586
|
+
"boolean"
|
|
685
587
|
]
|
|
686
588
|
}
|
|
687
589
|
},
|
|
@@ -701,7 +603,16 @@
|
|
|
701
603
|
"description": "An array containing references to items with open row details.",
|
|
702
604
|
"value": {
|
|
703
605
|
"type": [
|
|
704
|
-
"Array
|
|
606
|
+
"Array<GridItem>"
|
|
607
|
+
]
|
|
608
|
+
}
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
"name": "disabled",
|
|
612
|
+
"description": "If true, the user cannot interact with this element.",
|
|
613
|
+
"value": {
|
|
614
|
+
"type": [
|
|
615
|
+
"boolean"
|
|
705
616
|
]
|
|
706
617
|
}
|
|
707
618
|
},
|
|
@@ -732,9 +643,7 @@
|
|
|
732
643
|
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
733
644
|
"value": {
|
|
734
645
|
"type": [
|
|
735
|
-
"string"
|
|
736
|
-
"null",
|
|
737
|
-
"undefined"
|
|
646
|
+
"string"
|
|
738
647
|
]
|
|
739
648
|
}
|
|
740
649
|
},
|
|
@@ -743,9 +652,7 @@
|
|
|
743
652
|
"description": "When true, the grid enters cell edit mode on a single click\ninstead of the default double click.",
|
|
744
653
|
"value": {
|
|
745
654
|
"type": [
|
|
746
|
-
"boolean"
|
|
747
|
-
"null",
|
|
748
|
-
"undefined"
|
|
655
|
+
"boolean"
|
|
749
656
|
]
|
|
750
657
|
}
|
|
751
658
|
},
|
|
@@ -754,9 +661,7 @@
|
|
|
754
661
|
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
755
662
|
"value": {
|
|
756
663
|
"type": [
|
|
757
|
-
"boolean"
|
|
758
|
-
"null",
|
|
759
|
-
"undefined"
|
|
664
|
+
"boolean"
|
|
760
665
|
]
|
|
761
666
|
}
|
|
762
667
|
},
|
|
@@ -765,7 +670,7 @@
|
|
|
765
670
|
"description": "An array that contains the expanded items.",
|
|
766
671
|
"value": {
|
|
767
672
|
"type": [
|
|
768
|
-
"Array
|
|
673
|
+
"Array<GridItem>"
|
|
769
674
|
]
|
|
770
675
|
}
|
|
771
676
|
},
|
|
@@ -774,9 +679,7 @@
|
|
|
774
679
|
"description": "A function to check whether a specific item in the grid may be\nselected or deselected by the user. Used by the selection column to\nconditionally enable to disable checkboxes for individual items. This\nfunction does not prevent programmatic selection/deselection of\nitems. Changing the function does not modify the currently selected\nitems.\n\nConfiguring this function hides the select all checkbox of the grid\nselection column, which means users can not select or deselect all\nitems anymore, nor do they get feedback on whether all items are\nselected or not.\n\nReceives an item instance and should return a boolean indicating\nwhether users may change the selection state of that item.",
|
|
775
680
|
"value": {
|
|
776
681
|
"type": [
|
|
777
|
-
"
|
|
778
|
-
"null",
|
|
779
|
-
"undefined"
|
|
682
|
+
"item: GridItem => boolean"
|
|
780
683
|
]
|
|
781
684
|
}
|
|
782
685
|
},
|
|
@@ -785,9 +688,7 @@
|
|
|
785
688
|
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
786
689
|
"value": {
|
|
787
690
|
"type": [
|
|
788
|
-
"string"
|
|
789
|
-
"null",
|
|
790
|
-
"undefined"
|
|
691
|
+
"string"
|
|
791
692
|
]
|
|
792
693
|
}
|
|
793
694
|
},
|
|
@@ -796,9 +697,7 @@
|
|
|
796
697
|
"description": "Path to an item sub-property that identifies the item.",
|
|
797
698
|
"value": {
|
|
798
699
|
"type": [
|
|
799
|
-
"string"
|
|
800
|
-
"null",
|
|
801
|
-
"undefined"
|
|
700
|
+
"string"
|
|
802
701
|
]
|
|
803
702
|
}
|
|
804
703
|
},
|
|
@@ -807,7 +706,7 @@
|
|
|
807
706
|
"description": "An array containing the items which will be passed to renderer functions.",
|
|
808
707
|
"value": {
|
|
809
708
|
"type": [
|
|
810
|
-
"Array
|
|
709
|
+
"Array<GridItem>",
|
|
811
710
|
"undefined"
|
|
812
711
|
]
|
|
813
712
|
}
|
|
@@ -817,9 +716,7 @@
|
|
|
817
716
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
818
717
|
"value": {
|
|
819
718
|
"type": [
|
|
820
|
-
"boolean"
|
|
821
|
-
"null",
|
|
822
|
-
"undefined"
|
|
719
|
+
"boolean"
|
|
823
720
|
]
|
|
824
721
|
}
|
|
825
722
|
},
|
|
@@ -828,9 +725,7 @@
|
|
|
828
725
|
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
829
726
|
"value": {
|
|
830
727
|
"type": [
|
|
831
|
-
"boolean"
|
|
832
|
-
"null",
|
|
833
|
-
"undefined"
|
|
728
|
+
"boolean"
|
|
834
729
|
]
|
|
835
730
|
}
|
|
836
731
|
},
|
|
@@ -839,9 +734,7 @@
|
|
|
839
734
|
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
840
735
|
"value": {
|
|
841
736
|
"type": [
|
|
842
|
-
"string"
|
|
843
|
-
"null",
|
|
844
|
-
"undefined"
|
|
737
|
+
"string"
|
|
845
738
|
]
|
|
846
739
|
}
|
|
847
740
|
},
|
|
@@ -850,9 +743,7 @@
|
|
|
850
743
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
851
744
|
"value": {
|
|
852
745
|
"type": [
|
|
853
|
-
"number"
|
|
854
|
-
"null",
|
|
855
|
-
"undefined"
|
|
746
|
+
"number"
|
|
856
747
|
]
|
|
857
748
|
}
|
|
858
749
|
},
|
|
@@ -872,9 +763,7 @@
|
|
|
872
763
|
"description": "Marks the grid's rows to be available for dragging.",
|
|
873
764
|
"value": {
|
|
874
765
|
"type": [
|
|
875
|
-
"boolean"
|
|
876
|
-
"null",
|
|
877
|
-
"undefined"
|
|
766
|
+
"boolean"
|
|
878
767
|
]
|
|
879
768
|
}
|
|
880
769
|
},
|
|
@@ -883,7 +772,7 @@
|
|
|
883
772
|
"description": "An array that contains the selected items.",
|
|
884
773
|
"value": {
|
|
885
774
|
"type": [
|
|
886
|
-
"Array
|
|
775
|
+
"Array<GridItem>"
|
|
887
776
|
]
|
|
888
777
|
}
|
|
889
778
|
},
|
|
@@ -892,9 +781,7 @@
|
|
|
892
781
|
"description": "When true, after moving to next or previous editable cell using\nTab / Shift+Tab, it will be focused without edit mode.\n\nWhen `enterNextRow` is true, pressing Enter will also\npreserve edit mode, otherwise, it will have no effect.",
|
|
893
782
|
"value": {
|
|
894
783
|
"type": [
|
|
895
|
-
"boolean"
|
|
896
|
-
"null",
|
|
897
|
-
"undefined"
|
|
784
|
+
"boolean"
|
|
898
785
|
]
|
|
899
786
|
}
|
|
900
787
|
},
|
|
@@ -903,9 +790,7 @@
|
|
|
903
790
|
"description": "The number of root-level items in the grid.",
|
|
904
791
|
"value": {
|
|
905
792
|
"type": [
|
|
906
|
-
"number"
|
|
907
|
-
"null",
|
|
908
|
-
"undefined"
|
|
793
|
+
"number"
|
|
909
794
|
]
|
|
910
795
|
}
|
|
911
796
|
}
|
|
@@ -925,7 +810,7 @@
|
|
|
925
810
|
},
|
|
926
811
|
{
|
|
927
812
|
"name": "cell-focus",
|
|
928
|
-
"description": "Fired when a cell is focused with click or keyboard navigation
|
|
813
|
+
"description": "Fired when a cell is focused with click or keyboard navigation. Use the `context` property to read event details."
|
|
929
814
|
},
|
|
930
815
|
{
|
|
931
816
|
"name": "column-reorder",
|
|
@@ -933,16 +818,12 @@
|
|
|
933
818
|
},
|
|
934
819
|
{
|
|
935
820
|
"name": "column-resize",
|
|
936
|
-
"description": "Fired when
|
|
821
|
+
"description": "Fired when the grid column resize is finished."
|
|
937
822
|
},
|
|
938
823
|
{
|
|
939
824
|
"name": "data-provider-changed",
|
|
940
825
|
"description": "Fired when the `dataProvider` property changes."
|
|
941
826
|
},
|
|
942
|
-
{
|
|
943
|
-
"name": "enter-next-row-changed",
|
|
944
|
-
"description": "Fired when the `enterNextRow` property changes."
|
|
945
|
-
},
|
|
946
827
|
{
|
|
947
828
|
"name": "expanded-items-changed",
|
|
948
829
|
"description": "Fired when the `expandedItems` property changes."
|
|
@@ -961,7 +842,7 @@
|
|
|
961
842
|
},
|
|
962
843
|
{
|
|
963
844
|
"name": "item-property-changed",
|
|
964
|
-
"description": "Fired before exiting
|
|
845
|
+
"description": "Fired before exiting cell edit mode if the value has been changed. If the default is prevented, the value change is not applied."
|
|
965
846
|
},
|
|
966
847
|
{
|
|
967
848
|
"name": "item-toggle",
|
|
@@ -975,10 +856,6 @@
|
|
|
975
856
|
"name": "selected-items-changed",
|
|
976
857
|
"description": "Fired when the `selectedItems` property changes."
|
|
977
858
|
},
|
|
978
|
-
{
|
|
979
|
-
"name": "single-cell-edit-changed",
|
|
980
|
-
"description": "Fired when the `singleCellEdit` property changes."
|
|
981
|
-
},
|
|
982
859
|
{
|
|
983
860
|
"name": "size-changed",
|
|
984
861
|
"description": "Fired when the `size` property changes."
|