@vaadin/crud 25.1.0-alpha6 → 25.1.0-alpha7
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 +3169 -0
- package/package.json +18 -16
- package/src/vaadin-crud-dialog.js +1 -1
- package/src/vaadin-crud-edit-column.js +1 -1
- package/src/vaadin-crud-edit.js +1 -1
- package/src/vaadin-crud-form.js +1 -1
- package/src/vaadin-crud.js +1 -1
- package/web-types.json +6 -6
- package/web-types.lit.json +4 -4
|
@@ -0,0 +1,3169 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-crud.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-crud.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "vaadin-crud-edit.js",
|
|
23
|
+
"declarations": [],
|
|
24
|
+
"exports": [
|
|
25
|
+
{
|
|
26
|
+
"kind": "js",
|
|
27
|
+
"name": "*",
|
|
28
|
+
"declaration": {
|
|
29
|
+
"name": "*",
|
|
30
|
+
"module": "src/vaadin-crud-edit.js"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"kind": "javascript-module",
|
|
37
|
+
"path": "vaadin-crud-edit-column.js",
|
|
38
|
+
"declarations": [],
|
|
39
|
+
"exports": [
|
|
40
|
+
{
|
|
41
|
+
"kind": "js",
|
|
42
|
+
"name": "*",
|
|
43
|
+
"declaration": {
|
|
44
|
+
"name": "*",
|
|
45
|
+
"module": "src/vaadin-crud-edit-column.js"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"kind": "javascript-module",
|
|
52
|
+
"path": "src/vaadin-crud-controllers.js",
|
|
53
|
+
"declarations": [
|
|
54
|
+
{
|
|
55
|
+
"kind": "class",
|
|
56
|
+
"description": "A controller for initializing slotted button.",
|
|
57
|
+
"name": "ButtonSlotController",
|
|
58
|
+
"members": [
|
|
59
|
+
{
|
|
60
|
+
"kind": "field",
|
|
61
|
+
"name": "theme",
|
|
62
|
+
"default": "theme"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"kind": "field",
|
|
66
|
+
"name": "type",
|
|
67
|
+
"default": "type"
|
|
68
|
+
}
|
|
69
|
+
],
|
|
70
|
+
"superclass": {
|
|
71
|
+
"name": "SlotController",
|
|
72
|
+
"package": "@vaadin/component-base/src/slot-controller.js"
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"kind": "class",
|
|
77
|
+
"description": "A controller for initializing slotted form.",
|
|
78
|
+
"name": "FormSlotController",
|
|
79
|
+
"members": [],
|
|
80
|
+
"superclass": {
|
|
81
|
+
"name": "SlotController",
|
|
82
|
+
"package": "@vaadin/component-base/src/slot-controller.js"
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"kind": "class",
|
|
87
|
+
"description": "A controller for initializing slotted grid.",
|
|
88
|
+
"name": "GridSlotController",
|
|
89
|
+
"members": [],
|
|
90
|
+
"superclass": {
|
|
91
|
+
"name": "SlotController",
|
|
92
|
+
"package": "@vaadin/component-base/src/slot-controller.js"
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
],
|
|
96
|
+
"exports": [
|
|
97
|
+
{
|
|
98
|
+
"kind": "js",
|
|
99
|
+
"name": "ButtonSlotController",
|
|
100
|
+
"declaration": {
|
|
101
|
+
"name": "ButtonSlotController",
|
|
102
|
+
"module": "src/vaadin-crud-controllers.js"
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"kind": "js",
|
|
107
|
+
"name": "FormSlotController",
|
|
108
|
+
"declaration": {
|
|
109
|
+
"name": "FormSlotController",
|
|
110
|
+
"module": "src/vaadin-crud-controllers.js"
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"kind": "js",
|
|
115
|
+
"name": "GridSlotController",
|
|
116
|
+
"declaration": {
|
|
117
|
+
"name": "GridSlotController",
|
|
118
|
+
"module": "src/vaadin-crud-controllers.js"
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
]
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"kind": "javascript-module",
|
|
125
|
+
"path": "src/vaadin-crud-dialog.js",
|
|
126
|
+
"declarations": [],
|
|
127
|
+
"exports": []
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"kind": "javascript-module",
|
|
131
|
+
"path": "src/vaadin-crud-edit-column.js",
|
|
132
|
+
"declarations": [
|
|
133
|
+
{
|
|
134
|
+
"kind": "class",
|
|
135
|
+
"description": "`<vaadin-crud-edit-column>` is a helper element for the `<vaadin-grid>`\nthat provides a clickable and themable edit icon.\n\nTypical usage is in a custom `<vaadin-grid>` inside a `<vaadin-crud>`.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-crud-edit-column></vaadin-crud-edit-column>\n\n <vaadin-grid-column>\n ...\n```",
|
|
136
|
+
"name": "CrudEditColumn",
|
|
137
|
+
"members": [
|
|
138
|
+
{
|
|
139
|
+
"kind": "field",
|
|
140
|
+
"name": "ariaLabel",
|
|
141
|
+
"privacy": "public",
|
|
142
|
+
"description": "The arial-label for the edit button",
|
|
143
|
+
"attribute": "aria-label"
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"kind": "field",
|
|
147
|
+
"name": "autoWidth",
|
|
148
|
+
"privacy": "public",
|
|
149
|
+
"type": {
|
|
150
|
+
"text": "boolean"
|
|
151
|
+
},
|
|
152
|
+
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.",
|
|
153
|
+
"attribute": "auto-width",
|
|
154
|
+
"inheritedFrom": {
|
|
155
|
+
"name": "GridColumnMixin",
|
|
156
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
157
|
+
}
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"kind": "field",
|
|
161
|
+
"name": "flexGrow",
|
|
162
|
+
"privacy": "public",
|
|
163
|
+
"type": {
|
|
164
|
+
"text": "number"
|
|
165
|
+
},
|
|
166
|
+
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
167
|
+
"attribute": "flex-grow",
|
|
168
|
+
"inheritedFrom": {
|
|
169
|
+
"name": "GridColumnMixin",
|
|
170
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
171
|
+
}
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"kind": "field",
|
|
175
|
+
"name": "footerPartName",
|
|
176
|
+
"privacy": "public",
|
|
177
|
+
"type": {
|
|
178
|
+
"text": "string"
|
|
179
|
+
},
|
|
180
|
+
"description": "Custom part name for the footer cell.",
|
|
181
|
+
"attribute": "footer-part-name",
|
|
182
|
+
"inheritedFrom": {
|
|
183
|
+
"name": "ColumnBaseMixin",
|
|
184
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"kind": "field",
|
|
189
|
+
"name": "footerRenderer",
|
|
190
|
+
"privacy": "public",
|
|
191
|
+
"type": {
|
|
192
|
+
"text": "GridHeaderFooterRenderer | null | undefined"
|
|
193
|
+
},
|
|
194
|
+
"description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
|
|
195
|
+
"attribute": "footer-renderer",
|
|
196
|
+
"inheritedFrom": {
|
|
197
|
+
"name": "ColumnBaseMixin",
|
|
198
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"kind": "field",
|
|
203
|
+
"name": "frozen",
|
|
204
|
+
"privacy": "public",
|
|
205
|
+
"type": {
|
|
206
|
+
"text": "boolean"
|
|
207
|
+
},
|
|
208
|
+
"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.",
|
|
209
|
+
"attribute": "frozen",
|
|
210
|
+
"inheritedFrom": {
|
|
211
|
+
"name": "ColumnBaseMixin",
|
|
212
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"kind": "field",
|
|
217
|
+
"name": "frozenToEnd",
|
|
218
|
+
"privacy": "public",
|
|
219
|
+
"type": {
|
|
220
|
+
"text": "boolean"
|
|
221
|
+
},
|
|
222
|
+
"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.",
|
|
223
|
+
"attribute": "frozen-to-end",
|
|
224
|
+
"inheritedFrom": {
|
|
225
|
+
"name": "ColumnBaseMixin",
|
|
226
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"kind": "field",
|
|
231
|
+
"name": "header",
|
|
232
|
+
"privacy": "public",
|
|
233
|
+
"type": {
|
|
234
|
+
"text": "string"
|
|
235
|
+
},
|
|
236
|
+
"description": "Text content to display in the header cell of the column.",
|
|
237
|
+
"attribute": "header",
|
|
238
|
+
"inheritedFrom": {
|
|
239
|
+
"name": "ColumnBaseMixin",
|
|
240
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"kind": "field",
|
|
245
|
+
"name": "headerPartName",
|
|
246
|
+
"privacy": "public",
|
|
247
|
+
"type": {
|
|
248
|
+
"text": "string"
|
|
249
|
+
},
|
|
250
|
+
"description": "Custom part name for the header cell.",
|
|
251
|
+
"attribute": "header-part-name",
|
|
252
|
+
"inheritedFrom": {
|
|
253
|
+
"name": "ColumnBaseMixin",
|
|
254
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"kind": "field",
|
|
259
|
+
"name": "headerRenderer",
|
|
260
|
+
"privacy": "public",
|
|
261
|
+
"type": {
|
|
262
|
+
"text": "GridHeaderFooterRenderer | null | undefined"
|
|
263
|
+
},
|
|
264
|
+
"description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
|
|
265
|
+
"attribute": "header-renderer",
|
|
266
|
+
"inheritedFrom": {
|
|
267
|
+
"name": "ColumnBaseMixin",
|
|
268
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
269
|
+
}
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"kind": "field",
|
|
273
|
+
"name": "hidden",
|
|
274
|
+
"privacy": "public",
|
|
275
|
+
"type": {
|
|
276
|
+
"text": "boolean"
|
|
277
|
+
},
|
|
278
|
+
"description": "When set to true, the cells for this column are hidden.",
|
|
279
|
+
"attribute": "hidden",
|
|
280
|
+
"inheritedFrom": {
|
|
281
|
+
"name": "ColumnBaseMixin",
|
|
282
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
283
|
+
}
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
"kind": "field",
|
|
287
|
+
"name": "path",
|
|
288
|
+
"privacy": "public",
|
|
289
|
+
"type": {
|
|
290
|
+
"text": "string"
|
|
291
|
+
},
|
|
292
|
+
"description": "Path to an item sub-property whose value gets displayed in the column body cells.\nThe property name is also shown in the column header if an explicit header or renderer isn't defined.",
|
|
293
|
+
"attribute": "path",
|
|
294
|
+
"inheritedFrom": {
|
|
295
|
+
"name": "GridColumnMixin",
|
|
296
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"kind": "field",
|
|
301
|
+
"name": "renderer",
|
|
302
|
+
"privacy": "public",
|
|
303
|
+
"type": {
|
|
304
|
+
"text": "GridBodyRenderer | null | undefined"
|
|
305
|
+
},
|
|
306
|
+
"description": "Custom function for rendering the cell content.\nReceives three arguments:\n\n- `root` The cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.\n- `model` The object with the properties related with\n the rendered item, 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.\n - `model.detailsOpened` Details opened state.\n - `model.hasChildren` Whether the item has children.",
|
|
307
|
+
"attribute": "renderer",
|
|
308
|
+
"inheritedFrom": {
|
|
309
|
+
"name": "GridColumnMixin",
|
|
310
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"kind": "field",
|
|
315
|
+
"name": "resizable",
|
|
316
|
+
"privacy": "public",
|
|
317
|
+
"type": {
|
|
318
|
+
"text": "boolean"
|
|
319
|
+
},
|
|
320
|
+
"description": "When set to true, the column is user-resizable.",
|
|
321
|
+
"default": "false",
|
|
322
|
+
"attribute": "resizable",
|
|
323
|
+
"inheritedFrom": {
|
|
324
|
+
"name": "ColumnBaseMixin",
|
|
325
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
326
|
+
}
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"kind": "field",
|
|
330
|
+
"name": "rowHeader",
|
|
331
|
+
"privacy": "public",
|
|
332
|
+
"type": {
|
|
333
|
+
"text": "boolean"
|
|
334
|
+
},
|
|
335
|
+
"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.",
|
|
336
|
+
"attribute": "row-header",
|
|
337
|
+
"inheritedFrom": {
|
|
338
|
+
"name": "ColumnBaseMixin",
|
|
339
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"kind": "field",
|
|
344
|
+
"name": "textAlign",
|
|
345
|
+
"privacy": "public",
|
|
346
|
+
"type": {
|
|
347
|
+
"text": "GridColumnTextAlign | null | undefined"
|
|
348
|
+
},
|
|
349
|
+
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
350
|
+
"attribute": "text-align",
|
|
351
|
+
"inheritedFrom": {
|
|
352
|
+
"name": "ColumnBaseMixin",
|
|
353
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
354
|
+
}
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"kind": "field",
|
|
358
|
+
"name": "width",
|
|
359
|
+
"privacy": "public",
|
|
360
|
+
"type": {
|
|
361
|
+
"text": "string"
|
|
362
|
+
},
|
|
363
|
+
"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.",
|
|
364
|
+
"attribute": "width",
|
|
365
|
+
"inheritedFrom": {
|
|
366
|
+
"name": "GridColumnMixin",
|
|
367
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
],
|
|
371
|
+
"attributes": [
|
|
372
|
+
{
|
|
373
|
+
"name": "aria-label",
|
|
374
|
+
"description": "The arial-label for the edit button",
|
|
375
|
+
"fieldName": "ariaLabel"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "auto-width",
|
|
379
|
+
"type": {
|
|
380
|
+
"text": "boolean"
|
|
381
|
+
},
|
|
382
|
+
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.",
|
|
383
|
+
"fieldName": "autoWidth",
|
|
384
|
+
"inheritedFrom": {
|
|
385
|
+
"name": "GridColumnMixin",
|
|
386
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"name": "flex-grow",
|
|
391
|
+
"type": {
|
|
392
|
+
"text": "number"
|
|
393
|
+
},
|
|
394
|
+
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
395
|
+
"fieldName": "flexGrow",
|
|
396
|
+
"inheritedFrom": {
|
|
397
|
+
"name": "GridColumnMixin",
|
|
398
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
399
|
+
}
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"name": "footer-part-name",
|
|
403
|
+
"type": {
|
|
404
|
+
"text": "string"
|
|
405
|
+
},
|
|
406
|
+
"description": "Custom part name for the footer cell.",
|
|
407
|
+
"fieldName": "footerPartName",
|
|
408
|
+
"inheritedFrom": {
|
|
409
|
+
"name": "ColumnBaseMixin",
|
|
410
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
411
|
+
}
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "footer-renderer",
|
|
415
|
+
"type": {
|
|
416
|
+
"text": "GridHeaderFooterRenderer | null | undefined"
|
|
417
|
+
},
|
|
418
|
+
"description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
|
|
419
|
+
"fieldName": "footerRenderer",
|
|
420
|
+
"inheritedFrom": {
|
|
421
|
+
"name": "ColumnBaseMixin",
|
|
422
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
423
|
+
}
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"name": "frozen",
|
|
427
|
+
"type": {
|
|
428
|
+
"text": "boolean"
|
|
429
|
+
},
|
|
430
|
+
"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.",
|
|
431
|
+
"fieldName": "frozen",
|
|
432
|
+
"inheritedFrom": {
|
|
433
|
+
"name": "ColumnBaseMixin",
|
|
434
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
435
|
+
}
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "frozen-to-end",
|
|
439
|
+
"type": {
|
|
440
|
+
"text": "boolean"
|
|
441
|
+
},
|
|
442
|
+
"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.",
|
|
443
|
+
"fieldName": "frozenToEnd",
|
|
444
|
+
"inheritedFrom": {
|
|
445
|
+
"name": "ColumnBaseMixin",
|
|
446
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
447
|
+
}
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "header",
|
|
451
|
+
"type": {
|
|
452
|
+
"text": "string"
|
|
453
|
+
},
|
|
454
|
+
"description": "Text content to display in the header cell of the column.",
|
|
455
|
+
"fieldName": "header",
|
|
456
|
+
"inheritedFrom": {
|
|
457
|
+
"name": "ColumnBaseMixin",
|
|
458
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
459
|
+
}
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"name": "header-part-name",
|
|
463
|
+
"type": {
|
|
464
|
+
"text": "string"
|
|
465
|
+
},
|
|
466
|
+
"description": "Custom part name for the header cell.",
|
|
467
|
+
"fieldName": "headerPartName",
|
|
468
|
+
"inheritedFrom": {
|
|
469
|
+
"name": "ColumnBaseMixin",
|
|
470
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
471
|
+
}
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"name": "header-renderer",
|
|
475
|
+
"type": {
|
|
476
|
+
"text": "GridHeaderFooterRenderer | null | undefined"
|
|
477
|
+
},
|
|
478
|
+
"description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
|
|
479
|
+
"fieldName": "headerRenderer",
|
|
480
|
+
"inheritedFrom": {
|
|
481
|
+
"name": "ColumnBaseMixin",
|
|
482
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
483
|
+
}
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "hidden",
|
|
487
|
+
"type": {
|
|
488
|
+
"text": "boolean"
|
|
489
|
+
},
|
|
490
|
+
"description": "When set to true, the cells for this column are hidden.",
|
|
491
|
+
"fieldName": "hidden",
|
|
492
|
+
"inheritedFrom": {
|
|
493
|
+
"name": "ColumnBaseMixin",
|
|
494
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"name": "path",
|
|
499
|
+
"type": {
|
|
500
|
+
"text": "string"
|
|
501
|
+
},
|
|
502
|
+
"description": "Path to an item sub-property whose value gets displayed in the column body cells.\nThe property name is also shown in the column header if an explicit header or renderer isn't defined.",
|
|
503
|
+
"fieldName": "path",
|
|
504
|
+
"inheritedFrom": {
|
|
505
|
+
"name": "GridColumnMixin",
|
|
506
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "renderer",
|
|
511
|
+
"type": {
|
|
512
|
+
"text": "GridBodyRenderer | null | undefined"
|
|
513
|
+
},
|
|
514
|
+
"description": "Custom function for rendering the cell content.\nReceives three arguments:\n\n- `root` The cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.\n- `model` The object with the properties related with\n the rendered item, 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.\n - `model.detailsOpened` Details opened state.\n - `model.hasChildren` Whether the item has children.",
|
|
515
|
+
"fieldName": "renderer",
|
|
516
|
+
"inheritedFrom": {
|
|
517
|
+
"name": "GridColumnMixin",
|
|
518
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
519
|
+
}
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "resizable",
|
|
523
|
+
"type": {
|
|
524
|
+
"text": "boolean"
|
|
525
|
+
},
|
|
526
|
+
"description": "When set to true, the column is user-resizable.",
|
|
527
|
+
"default": "false",
|
|
528
|
+
"fieldName": "resizable",
|
|
529
|
+
"inheritedFrom": {
|
|
530
|
+
"name": "ColumnBaseMixin",
|
|
531
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
532
|
+
}
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "row-header",
|
|
536
|
+
"type": {
|
|
537
|
+
"text": "boolean"
|
|
538
|
+
},
|
|
539
|
+
"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.",
|
|
540
|
+
"fieldName": "rowHeader",
|
|
541
|
+
"inheritedFrom": {
|
|
542
|
+
"name": "ColumnBaseMixin",
|
|
543
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
544
|
+
}
|
|
545
|
+
},
|
|
546
|
+
{
|
|
547
|
+
"name": "text-align",
|
|
548
|
+
"type": {
|
|
549
|
+
"text": "GridColumnTextAlign | null | undefined"
|
|
550
|
+
},
|
|
551
|
+
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
552
|
+
"fieldName": "textAlign",
|
|
553
|
+
"inheritedFrom": {
|
|
554
|
+
"name": "ColumnBaseMixin",
|
|
555
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "width",
|
|
560
|
+
"type": {
|
|
561
|
+
"text": "string"
|
|
562
|
+
},
|
|
563
|
+
"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.",
|
|
564
|
+
"fieldName": "width",
|
|
565
|
+
"inheritedFrom": {
|
|
566
|
+
"name": "GridColumnMixin",
|
|
567
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
568
|
+
}
|
|
569
|
+
}
|
|
570
|
+
],
|
|
571
|
+
"superclass": {
|
|
572
|
+
"name": "GridColumn",
|
|
573
|
+
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
574
|
+
},
|
|
575
|
+
"tagName": "vaadin-crud-edit-column",
|
|
576
|
+
"customElement": true,
|
|
577
|
+
"events": []
|
|
578
|
+
}
|
|
579
|
+
],
|
|
580
|
+
"exports": [
|
|
581
|
+
{
|
|
582
|
+
"kind": "js",
|
|
583
|
+
"name": "CrudEditColumn",
|
|
584
|
+
"declaration": {
|
|
585
|
+
"name": "CrudEditColumn",
|
|
586
|
+
"module": "src/vaadin-crud-edit-column.js"
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
]
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
"kind": "javascript-module",
|
|
593
|
+
"path": "src/vaadin-crud-edit.js",
|
|
594
|
+
"declarations": [
|
|
595
|
+
{
|
|
596
|
+
"kind": "class",
|
|
597
|
+
"description": "`<vaadin-crud-edit>` is a helper element for `<vaadin-grid-column>` that provides\nan easily themable button that fires an `edit` event with the row item as detail\nwhen clicked.\n\nTypical usage is in a `<vaadin-grid-column>` of a custom `<vaadin-grid>` inside\na `<vaadin-crud>` to enable editing.",
|
|
598
|
+
"name": "CrudEdit",
|
|
599
|
+
"members": [
|
|
600
|
+
{
|
|
601
|
+
"kind": "field",
|
|
602
|
+
"name": "disabled",
|
|
603
|
+
"privacy": "public",
|
|
604
|
+
"type": {
|
|
605
|
+
"text": "boolean"
|
|
606
|
+
},
|
|
607
|
+
"description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
|
|
608
|
+
"attribute": "disabled",
|
|
609
|
+
"inheritedFrom": {
|
|
610
|
+
"name": "Button",
|
|
611
|
+
"package": "@vaadin/button/src/vaadin-button.js"
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"superclass": {
|
|
616
|
+
"name": "Button",
|
|
617
|
+
"package": "@vaadin/button/src/vaadin-button.js"
|
|
618
|
+
},
|
|
619
|
+
"tagName": "vaadin-crud-edit",
|
|
620
|
+
"customElement": true,
|
|
621
|
+
"attributes": [
|
|
622
|
+
{
|
|
623
|
+
"name": "disabled",
|
|
624
|
+
"type": {
|
|
625
|
+
"text": "boolean"
|
|
626
|
+
},
|
|
627
|
+
"description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
|
|
628
|
+
"fieldName": "disabled",
|
|
629
|
+
"inheritedFrom": {
|
|
630
|
+
"name": "Button",
|
|
631
|
+
"package": "@vaadin/button/src/vaadin-button.js"
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"name": "tabindex",
|
|
636
|
+
"type": {
|
|
637
|
+
"text": "number"
|
|
638
|
+
},
|
|
639
|
+
"description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
|
|
640
|
+
"fieldName": "tabindex",
|
|
641
|
+
"inheritedFrom": {
|
|
642
|
+
"name": "Button",
|
|
643
|
+
"package": "@vaadin/button/src/vaadin-button.js"
|
|
644
|
+
}
|
|
645
|
+
}
|
|
646
|
+
],
|
|
647
|
+
"events": []
|
|
648
|
+
}
|
|
649
|
+
],
|
|
650
|
+
"exports": [
|
|
651
|
+
{
|
|
652
|
+
"kind": "js",
|
|
653
|
+
"name": "CrudEdit",
|
|
654
|
+
"declaration": {
|
|
655
|
+
"name": "CrudEdit",
|
|
656
|
+
"module": "src/vaadin-crud-edit.js"
|
|
657
|
+
}
|
|
658
|
+
}
|
|
659
|
+
]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"kind": "javascript-module",
|
|
663
|
+
"path": "src/vaadin-crud-form.js",
|
|
664
|
+
"declarations": [
|
|
665
|
+
{
|
|
666
|
+
"kind": "class",
|
|
667
|
+
"description": "An element used internally by `<vaadin-crud>`. Not intended to be used separately.",
|
|
668
|
+
"name": "CrudForm",
|
|
669
|
+
"members": [
|
|
670
|
+
{
|
|
671
|
+
"kind": "field",
|
|
672
|
+
"name": "autoResponsive",
|
|
673
|
+
"privacy": "public",
|
|
674
|
+
"type": {
|
|
675
|
+
"text": "boolean"
|
|
676
|
+
},
|
|
677
|
+
"description": "When set to `true`, the component automatically creates and adjusts columns based on\nthe container's width. Columns have a fixed width defined by `columnWidth` and their\nnumber increases up to the limit set by `maxColumns`. The component dynamically adjusts\nthe number of columns as the container size changes. When this mode is enabled,\n`responsiveSteps` are ignored.\n\nBy default, each field is placed on a new row. To organize fields into rows, there are\ntwo options:\n\n1. Use `<vaadin-form-row>` to explicitly group fields into rows.\n\n2. Enable the `autoRows` property to automatically arrange fields in available columns,\n wrapping to a new row when necessary. `<br>` elements can be used to force a new row.\n\nThe auto-responsive mode is disabled by default. To enable it for an individual instance,\nuse this property. Alternatively, if you want it to be enabled for all instances by default,\nenable the `defaultAutoResponsiveFormLayout` feature flag before `<vaadin-form-layout>`\nelements are added to the DOM:\n\n```js\nwindow.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true;\n```",
|
|
678
|
+
"attribute": "auto-responsive",
|
|
679
|
+
"inheritedFrom": {
|
|
680
|
+
"name": "FormLayoutMixin",
|
|
681
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
"kind": "field",
|
|
686
|
+
"name": "autoRows",
|
|
687
|
+
"privacy": "public",
|
|
688
|
+
"type": {
|
|
689
|
+
"text": "boolean"
|
|
690
|
+
},
|
|
691
|
+
"description": "When enabled with `autoResponsive`, distributes fields across columns\nby placing each field in the next available column and wrapping to\nthe next row when the current row is full. `<br>` elements can be\nused to force a new row.\n\nThe default value is `false`.",
|
|
692
|
+
"attribute": "auto-rows",
|
|
693
|
+
"inheritedFrom": {
|
|
694
|
+
"name": "FormLayoutMixin",
|
|
695
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
696
|
+
}
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"kind": "field",
|
|
700
|
+
"name": "columnWidth",
|
|
701
|
+
"privacy": "public",
|
|
702
|
+
"type": {
|
|
703
|
+
"text": "string"
|
|
704
|
+
},
|
|
705
|
+
"description": "When `autoResponsive` is enabled, defines the width of each column.\nThe value must be defined in CSS length units, e.g. `100px`.\n\nIf the column width isn't explicitly set, it defaults to `12em`\nor `--vaadin-field-default-width` if that CSS property is defined.",
|
|
706
|
+
"attribute": "column-width",
|
|
707
|
+
"inheritedFrom": {
|
|
708
|
+
"name": "FormLayoutMixin",
|
|
709
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
710
|
+
}
|
|
711
|
+
},
|
|
712
|
+
{
|
|
713
|
+
"kind": "field",
|
|
714
|
+
"name": "exclude",
|
|
715
|
+
"privacy": "public",
|
|
716
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
717
|
+
"type": {
|
|
718
|
+
"text": "string | RegExp"
|
|
719
|
+
},
|
|
720
|
+
"attribute": "exclude",
|
|
721
|
+
"inheritedFrom": {
|
|
722
|
+
"name": "IncludedMixin",
|
|
723
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
724
|
+
}
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
"kind": "field",
|
|
728
|
+
"name": "expandColumns",
|
|
729
|
+
"privacy": "public",
|
|
730
|
+
"type": {
|
|
731
|
+
"text": "boolean"
|
|
732
|
+
},
|
|
733
|
+
"description": "When `autoResponsive` is enabled, specifies whether the columns should expand\nin width to evenly fill any remaining space after all columns have been created.\n\nThe default value is `false`.",
|
|
734
|
+
"attribute": "expand-columns",
|
|
735
|
+
"inheritedFrom": {
|
|
736
|
+
"name": "FormLayoutMixin",
|
|
737
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
738
|
+
}
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
"kind": "field",
|
|
742
|
+
"name": "expandFields",
|
|
743
|
+
"privacy": "public",
|
|
744
|
+
"type": {
|
|
745
|
+
"text": "boolean"
|
|
746
|
+
},
|
|
747
|
+
"description": "When `autoResponsive` is enabled, specifies whether fields should stretch\nto take up all available space within columns. This setting also applies\nto fields inside `<vaadin-form-item>` elements.\n\nThe default value is `false`.",
|
|
748
|
+
"attribute": "expand-fields",
|
|
749
|
+
"inheritedFrom": {
|
|
750
|
+
"name": "FormLayoutMixin",
|
|
751
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
752
|
+
}
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
"kind": "field",
|
|
756
|
+
"name": "include",
|
|
757
|
+
"privacy": "public",
|
|
758
|
+
"description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
|
|
759
|
+
"type": {
|
|
760
|
+
"text": "string | !Array<string> | undefined"
|
|
761
|
+
},
|
|
762
|
+
"attribute": "include",
|
|
763
|
+
"inheritedFrom": {
|
|
764
|
+
"name": "IncludedMixin",
|
|
765
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
766
|
+
}
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"kind": "field",
|
|
770
|
+
"name": "item",
|
|
771
|
+
"privacy": "public",
|
|
772
|
+
"type": {
|
|
773
|
+
"text": "unknown"
|
|
774
|
+
},
|
|
775
|
+
"description": "The item being edited.",
|
|
776
|
+
"attribute": "item"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"kind": "field",
|
|
780
|
+
"name": "labelsAside",
|
|
781
|
+
"privacy": "public",
|
|
782
|
+
"type": {
|
|
783
|
+
"text": "boolean"
|
|
784
|
+
},
|
|
785
|
+
"description": "When enabled with `autoResponsive`, `<vaadin-form-item>` prefers positioning\nlabels beside the fields. If the layout is too narrow to fit a single column\nwith a side label, the component will automatically switch labels to their\ndefault position above the fields.\n\nThe default value is `false`.\n\nTo customize the label width and the gap between the label and the field,\nuse the following CSS properties:\n\n- `--vaadin-form-layout-label-width`\n- `--vaadin-form-layout-label-spacing`",
|
|
786
|
+
"attribute": "labels-aside",
|
|
787
|
+
"inheritedFrom": {
|
|
788
|
+
"name": "FormLayoutMixin",
|
|
789
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
790
|
+
}
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
"kind": "field",
|
|
794
|
+
"name": "maxColumns",
|
|
795
|
+
"privacy": "public",
|
|
796
|
+
"type": {
|
|
797
|
+
"text": "number"
|
|
798
|
+
},
|
|
799
|
+
"description": "When `autoResponsive` is enabled, defines the maximum number of columns\nthat the layout can create. The layout will create columns up to this\nlimit based on the available container width.\n\nThe default value is `10`.",
|
|
800
|
+
"attribute": "max-columns",
|
|
801
|
+
"inheritedFrom": {
|
|
802
|
+
"name": "FormLayoutMixin",
|
|
803
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
804
|
+
}
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"kind": "field",
|
|
808
|
+
"name": "minColumns",
|
|
809
|
+
"privacy": "public",
|
|
810
|
+
"type": {
|
|
811
|
+
"text": "number"
|
|
812
|
+
},
|
|
813
|
+
"description": "When `autoResponsive` is enabled, defines the minimum number of columns\nthat the layout can create. The layout will create columns at least up\nto this limit.\n\nThe default value is `1`.",
|
|
814
|
+
"attribute": "min-columns",
|
|
815
|
+
"inheritedFrom": {
|
|
816
|
+
"name": "FormLayoutMixin",
|
|
817
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
818
|
+
}
|
|
819
|
+
},
|
|
820
|
+
{
|
|
821
|
+
"kind": "field",
|
|
822
|
+
"name": "responsiveSteps",
|
|
823
|
+
"privacy": "public",
|
|
824
|
+
"type": {
|
|
825
|
+
"text": "!Array<!FormLayoutResponsiveStep>"
|
|
826
|
+
},
|
|
827
|
+
"description": "Allows specifying a responsive behavior with the number of columns\nand the label position depending on the layout width.\n\nFormat: array of objects, each object defines one responsive step\nwith `minWidth` CSS length, `columns` number, and optional\n`labelsPosition` string of `\"aside\"` or `\"top\"`. At least one item is required.\n\nNOTE: Responsive steps are ignored in auto-responsive mode, which may be\nenabled explicitly via the `autoResponsive` property or implicitly\nif the following feature flag is set:\n\n```js\nwindow.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true\n```\n\n#### Examples\n\n```javascript\nformLayout.responsiveSteps = [{columns: 1}];\n// The layout is always a single column, labels aside.\n```\n\n```javascript\nformLayout.responsiveSteps = [\n {minWidth: 0, columns: 1},\n {minWidth: '40em', columns: 2}\n];\n// Sets two responsive steps:\n// 1. When the layout width is < 40em, one column, labels aside.\n// 2. Width >= 40em, two columns, labels aside.\n```\n\n```javascript\nformLayout.responsiveSteps = [\n {minWidth: 0, columns: 1, labelsPosition: 'top'},\n {minWidth: '20em', columns: 1},\n {minWidth: '40em', columns: 2}\n];\n// Default value. Three responsive steps:\n// 1. Width < 20em, one column, labels on top.\n// 2. 20em <= width < 40em, one column, labels aside.\n// 3. Width >= 40em, two columns, labels aside.\n```",
|
|
828
|
+
"attribute": "responsive-steps",
|
|
829
|
+
"inheritedFrom": {
|
|
830
|
+
"name": "FormLayoutMixin",
|
|
831
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
832
|
+
}
|
|
833
|
+
}
|
|
834
|
+
],
|
|
835
|
+
"attributes": [
|
|
836
|
+
{
|
|
837
|
+
"name": "auto-responsive",
|
|
838
|
+
"type": {
|
|
839
|
+
"text": "boolean"
|
|
840
|
+
},
|
|
841
|
+
"description": "When set to `true`, the component automatically creates and adjusts columns based on\nthe container's width. Columns have a fixed width defined by `columnWidth` and their\nnumber increases up to the limit set by `maxColumns`. The component dynamically adjusts\nthe number of columns as the container size changes. When this mode is enabled,\n`responsiveSteps` are ignored.\n\nBy default, each field is placed on a new row. To organize fields into rows, there are\ntwo options:\n\n1. Use `<vaadin-form-row>` to explicitly group fields into rows.\n\n2. Enable the `autoRows` property to automatically arrange fields in available columns,\n wrapping to a new row when necessary. `<br>` elements can be used to force a new row.\n\nThe auto-responsive mode is disabled by default. To enable it for an individual instance,\nuse this property. Alternatively, if you want it to be enabled for all instances by default,\nenable the `defaultAutoResponsiveFormLayout` feature flag before `<vaadin-form-layout>`\nelements are added to the DOM:\n\n```js\nwindow.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true;\n```",
|
|
842
|
+
"fieldName": "autoResponsive",
|
|
843
|
+
"inheritedFrom": {
|
|
844
|
+
"name": "FormLayoutMixin",
|
|
845
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
846
|
+
}
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "auto-rows",
|
|
850
|
+
"type": {
|
|
851
|
+
"text": "boolean"
|
|
852
|
+
},
|
|
853
|
+
"description": "When enabled with `autoResponsive`, distributes fields across columns\nby placing each field in the next available column and wrapping to\nthe next row when the current row is full. `<br>` elements can be\nused to force a new row.\n\nThe default value is `false`.",
|
|
854
|
+
"fieldName": "autoRows",
|
|
855
|
+
"inheritedFrom": {
|
|
856
|
+
"name": "FormLayoutMixin",
|
|
857
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
858
|
+
}
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "column-width",
|
|
862
|
+
"type": {
|
|
863
|
+
"text": "string"
|
|
864
|
+
},
|
|
865
|
+
"description": "When `autoResponsive` is enabled, defines the width of each column.\nThe value must be defined in CSS length units, e.g. `100px`.\n\nIf the column width isn't explicitly set, it defaults to `12em`\nor `--vaadin-field-default-width` if that CSS property is defined.",
|
|
866
|
+
"fieldName": "columnWidth",
|
|
867
|
+
"inheritedFrom": {
|
|
868
|
+
"name": "FormLayoutMixin",
|
|
869
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
870
|
+
}
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "exclude",
|
|
874
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
875
|
+
"type": {
|
|
876
|
+
"text": "string | RegExp"
|
|
877
|
+
},
|
|
878
|
+
"fieldName": "exclude",
|
|
879
|
+
"inheritedFrom": {
|
|
880
|
+
"name": "IncludedMixin",
|
|
881
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "expand-columns",
|
|
886
|
+
"type": {
|
|
887
|
+
"text": "boolean"
|
|
888
|
+
},
|
|
889
|
+
"description": "When `autoResponsive` is enabled, specifies whether the columns should expand\nin width to evenly fill any remaining space after all columns have been created.\n\nThe default value is `false`.",
|
|
890
|
+
"fieldName": "expandColumns",
|
|
891
|
+
"inheritedFrom": {
|
|
892
|
+
"name": "FormLayoutMixin",
|
|
893
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
894
|
+
}
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
"name": "expand-fields",
|
|
898
|
+
"type": {
|
|
899
|
+
"text": "boolean"
|
|
900
|
+
},
|
|
901
|
+
"description": "When `autoResponsive` is enabled, specifies whether fields should stretch\nto take up all available space within columns. This setting also applies\nto fields inside `<vaadin-form-item>` elements.\n\nThe default value is `false`.",
|
|
902
|
+
"fieldName": "expandFields",
|
|
903
|
+
"inheritedFrom": {
|
|
904
|
+
"name": "FormLayoutMixin",
|
|
905
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
906
|
+
}
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"name": "labels-aside",
|
|
910
|
+
"type": {
|
|
911
|
+
"text": "boolean"
|
|
912
|
+
},
|
|
913
|
+
"description": "When enabled with `autoResponsive`, `<vaadin-form-item>` prefers positioning\nlabels beside the fields. If the layout is too narrow to fit a single column\nwith a side label, the component will automatically switch labels to their\ndefault position above the fields.\n\nThe default value is `false`.\n\nTo customize the label width and the gap between the label and the field,\nuse the following CSS properties:\n\n- `--vaadin-form-layout-label-width`\n- `--vaadin-form-layout-label-spacing`",
|
|
914
|
+
"fieldName": "labelsAside",
|
|
915
|
+
"inheritedFrom": {
|
|
916
|
+
"name": "FormLayoutMixin",
|
|
917
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
918
|
+
}
|
|
919
|
+
},
|
|
920
|
+
{
|
|
921
|
+
"name": "max-columns",
|
|
922
|
+
"type": {
|
|
923
|
+
"text": "number"
|
|
924
|
+
},
|
|
925
|
+
"description": "When `autoResponsive` is enabled, defines the maximum number of columns\nthat the layout can create. The layout will create columns up to this\nlimit based on the available container width.\n\nThe default value is `10`.",
|
|
926
|
+
"fieldName": "maxColumns",
|
|
927
|
+
"inheritedFrom": {
|
|
928
|
+
"name": "FormLayoutMixin",
|
|
929
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
930
|
+
}
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"name": "min-columns",
|
|
934
|
+
"type": {
|
|
935
|
+
"text": "number"
|
|
936
|
+
},
|
|
937
|
+
"description": "When `autoResponsive` is enabled, defines the minimum number of columns\nthat the layout can create. The layout will create columns at least up\nto this limit.\n\nThe default value is `1`.",
|
|
938
|
+
"fieldName": "minColumns",
|
|
939
|
+
"inheritedFrom": {
|
|
940
|
+
"name": "FormLayoutMixin",
|
|
941
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
|
|
942
|
+
}
|
|
943
|
+
}
|
|
944
|
+
],
|
|
945
|
+
"mixins": [
|
|
946
|
+
{
|
|
947
|
+
"name": "IncludedMixin",
|
|
948
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
949
|
+
}
|
|
950
|
+
],
|
|
951
|
+
"superclass": {
|
|
952
|
+
"name": "FormLayout",
|
|
953
|
+
"package": "@vaadin/form-layout/src/vaadin-form-layout.js"
|
|
954
|
+
},
|
|
955
|
+
"tagName": "vaadin-crud-form",
|
|
956
|
+
"customElement": true,
|
|
957
|
+
"events": []
|
|
958
|
+
}
|
|
959
|
+
],
|
|
960
|
+
"exports": [
|
|
961
|
+
{
|
|
962
|
+
"kind": "js",
|
|
963
|
+
"name": "CrudForm",
|
|
964
|
+
"declaration": {
|
|
965
|
+
"name": "CrudForm",
|
|
966
|
+
"module": "src/vaadin-crud-form.js"
|
|
967
|
+
}
|
|
968
|
+
}
|
|
969
|
+
]
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"kind": "javascript-module",
|
|
973
|
+
"path": "src/vaadin-crud-grid-mixin.js",
|
|
974
|
+
"declarations": [
|
|
975
|
+
{
|
|
976
|
+
"kind": "mixin",
|
|
977
|
+
"description": "A mixin providing common crud-grid functionality.",
|
|
978
|
+
"name": "CrudGridMixin",
|
|
979
|
+
"members": [
|
|
980
|
+
{
|
|
981
|
+
"kind": "field",
|
|
982
|
+
"name": "exclude",
|
|
983
|
+
"privacy": "public",
|
|
984
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
985
|
+
"type": {
|
|
986
|
+
"text": "string | RegExp"
|
|
987
|
+
},
|
|
988
|
+
"attribute": "exclude",
|
|
989
|
+
"inheritedFrom": {
|
|
990
|
+
"name": "IncludedMixin",
|
|
991
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
992
|
+
}
|
|
993
|
+
},
|
|
994
|
+
{
|
|
995
|
+
"kind": "field",
|
|
996
|
+
"name": "hideEditColumn",
|
|
997
|
+
"privacy": "public",
|
|
998
|
+
"type": {
|
|
999
|
+
"text": "boolean"
|
|
1000
|
+
},
|
|
1001
|
+
"description": "Determines whether the edit column should be hidden.",
|
|
1002
|
+
"attribute": "hide-edit-column"
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"kind": "field",
|
|
1006
|
+
"name": "include",
|
|
1007
|
+
"privacy": "public",
|
|
1008
|
+
"description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
|
|
1009
|
+
"type": {
|
|
1010
|
+
"text": "string | !Array<string> | undefined"
|
|
1011
|
+
},
|
|
1012
|
+
"attribute": "include",
|
|
1013
|
+
"inheritedFrom": {
|
|
1014
|
+
"name": "IncludedMixin",
|
|
1015
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
1016
|
+
}
|
|
1017
|
+
},
|
|
1018
|
+
{
|
|
1019
|
+
"kind": "field",
|
|
1020
|
+
"name": "noFilter",
|
|
1021
|
+
"privacy": "public",
|
|
1022
|
+
"description": "Disable filtering in the generated columns.",
|
|
1023
|
+
"attribute": "no-filter"
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"kind": "field",
|
|
1027
|
+
"name": "noHead",
|
|
1028
|
+
"privacy": "public",
|
|
1029
|
+
"description": "Do not add headers to columns.",
|
|
1030
|
+
"attribute": "no-head"
|
|
1031
|
+
},
|
|
1032
|
+
{
|
|
1033
|
+
"kind": "field",
|
|
1034
|
+
"name": "noSort",
|
|
1035
|
+
"privacy": "public",
|
|
1036
|
+
"description": "Disable sorting in the generated columns.",
|
|
1037
|
+
"attribute": "no-sort"
|
|
1038
|
+
}
|
|
1039
|
+
],
|
|
1040
|
+
"attributes": [
|
|
1041
|
+
{
|
|
1042
|
+
"name": "exclude",
|
|
1043
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
1044
|
+
"type": {
|
|
1045
|
+
"text": "string | RegExp"
|
|
1046
|
+
},
|
|
1047
|
+
"fieldName": "exclude",
|
|
1048
|
+
"inheritedFrom": {
|
|
1049
|
+
"name": "IncludedMixin",
|
|
1050
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
1051
|
+
}
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "hide-edit-column",
|
|
1055
|
+
"type": {
|
|
1056
|
+
"text": "boolean"
|
|
1057
|
+
},
|
|
1058
|
+
"description": "Determines whether the edit column should be hidden.",
|
|
1059
|
+
"fieldName": "hideEditColumn"
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"name": "no-filter",
|
|
1063
|
+
"description": "Disable filtering in the generated columns.",
|
|
1064
|
+
"fieldName": "noFilter"
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
"name": "no-head",
|
|
1068
|
+
"description": "Do not add headers to columns.",
|
|
1069
|
+
"fieldName": "noHead"
|
|
1070
|
+
},
|
|
1071
|
+
{
|
|
1072
|
+
"name": "no-sort",
|
|
1073
|
+
"description": "Disable sorting in the generated columns.",
|
|
1074
|
+
"fieldName": "noSort"
|
|
1075
|
+
}
|
|
1076
|
+
],
|
|
1077
|
+
"mixins": [
|
|
1078
|
+
{
|
|
1079
|
+
"name": "IncludedMixin",
|
|
1080
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
1081
|
+
}
|
|
1082
|
+
],
|
|
1083
|
+
"parameters": [
|
|
1084
|
+
{
|
|
1085
|
+
"name": "superClass"
|
|
1086
|
+
}
|
|
1087
|
+
]
|
|
1088
|
+
}
|
|
1089
|
+
],
|
|
1090
|
+
"exports": [
|
|
1091
|
+
{
|
|
1092
|
+
"kind": "js",
|
|
1093
|
+
"name": "CrudGridMixin",
|
|
1094
|
+
"declaration": {
|
|
1095
|
+
"name": "CrudGridMixin",
|
|
1096
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1097
|
+
}
|
|
1098
|
+
}
|
|
1099
|
+
]
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"kind": "javascript-module",
|
|
1103
|
+
"path": "src/vaadin-crud-grid.js",
|
|
1104
|
+
"declarations": [
|
|
1105
|
+
{
|
|
1106
|
+
"kind": "class",
|
|
1107
|
+
"description": "An element used internally by `<vaadin-crud>`. Not intended to be used separately.",
|
|
1108
|
+
"name": "CrudGrid",
|
|
1109
|
+
"members": [
|
|
1110
|
+
{
|
|
1111
|
+
"kind": "field",
|
|
1112
|
+
"name": "accessibleName",
|
|
1113
|
+
"privacy": "public",
|
|
1114
|
+
"type": {
|
|
1115
|
+
"text": "string"
|
|
1116
|
+
},
|
|
1117
|
+
"description": "String used to label the grid to screen reader users.",
|
|
1118
|
+
"attribute": "accessible-name",
|
|
1119
|
+
"inheritedFrom": {
|
|
1120
|
+
"name": "A11yMixin",
|
|
1121
|
+
"package": "@vaadin/grid/src/vaadin-grid-a11y-mixin.js"
|
|
1122
|
+
}
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"kind": "field",
|
|
1126
|
+
"name": "activeItem",
|
|
1127
|
+
"privacy": "public",
|
|
1128
|
+
"type": {
|
|
1129
|
+
"text": "GridItem"
|
|
1130
|
+
},
|
|
1131
|
+
"description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
|
|
1132
|
+
"attribute": "active-item",
|
|
1133
|
+
"inheritedFrom": {
|
|
1134
|
+
"name": "ActiveItemMixin",
|
|
1135
|
+
"package": "@vaadin/grid/src/vaadin-grid-active-item-mixin.js"
|
|
1136
|
+
}
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"kind": "field",
|
|
1140
|
+
"name": "allRowsVisible",
|
|
1141
|
+
"privacy": "public",
|
|
1142
|
+
"type": {
|
|
1143
|
+
"text": "boolean"
|
|
1144
|
+
},
|
|
1145
|
+
"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.",
|
|
1146
|
+
"attribute": "all-rows-visible",
|
|
1147
|
+
"inheritedFrom": {
|
|
1148
|
+
"name": "GridMixin",
|
|
1149
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"kind": "field",
|
|
1154
|
+
"name": "cellPartNameGenerator",
|
|
1155
|
+
"privacy": "public",
|
|
1156
|
+
"type": {
|
|
1157
|
+
"text": "GridCellPartNameGenerator | null | undefined"
|
|
1158
|
+
},
|
|
1159
|
+
"description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, 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.",
|
|
1160
|
+
"attribute": "cell-part-name-generator",
|
|
1161
|
+
"inheritedFrom": {
|
|
1162
|
+
"name": "StylingMixin",
|
|
1163
|
+
"package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"kind": "method",
|
|
1168
|
+
"name": "clearCache",
|
|
1169
|
+
"description": "Clears the cached pages and reloads data from dataprovider when needed.",
|
|
1170
|
+
"inheritedFrom": {
|
|
1171
|
+
"name": "DataProviderMixin",
|
|
1172
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1173
|
+
}
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
"kind": "method",
|
|
1177
|
+
"name": "closeItemDetails",
|
|
1178
|
+
"parameters": [
|
|
1179
|
+
{
|
|
1180
|
+
"name": "item",
|
|
1181
|
+
"type": {
|
|
1182
|
+
"text": "!GridItem"
|
|
1183
|
+
}
|
|
1184
|
+
}
|
|
1185
|
+
],
|
|
1186
|
+
"description": "Close the details row of a given item.",
|
|
1187
|
+
"inheritedFrom": {
|
|
1188
|
+
"name": "RowDetailsMixin",
|
|
1189
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1190
|
+
}
|
|
1191
|
+
},
|
|
1192
|
+
{
|
|
1193
|
+
"kind": "method",
|
|
1194
|
+
"name": "collapseItem",
|
|
1195
|
+
"parameters": [
|
|
1196
|
+
{
|
|
1197
|
+
"name": "item",
|
|
1198
|
+
"type": {
|
|
1199
|
+
"text": "!GridItem"
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1202
|
+
],
|
|
1203
|
+
"description": "Collapses the given item tree.",
|
|
1204
|
+
"inheritedFrom": {
|
|
1205
|
+
"name": "DataProviderMixin",
|
|
1206
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1207
|
+
}
|
|
1208
|
+
},
|
|
1209
|
+
{
|
|
1210
|
+
"kind": "field",
|
|
1211
|
+
"name": "columnRendering",
|
|
1212
|
+
"privacy": "public",
|
|
1213
|
+
"type": {
|
|
1214
|
+
"text": "!ColumnRendering"
|
|
1215
|
+
},
|
|
1216
|
+
"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.",
|
|
1217
|
+
"attribute": "column-rendering",
|
|
1218
|
+
"inheritedFrom": {
|
|
1219
|
+
"name": "ScrollMixin",
|
|
1220
|
+
"package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
|
|
1221
|
+
}
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"kind": "field",
|
|
1225
|
+
"name": "columnReorderingAllowed",
|
|
1226
|
+
"privacy": "public",
|
|
1227
|
+
"type": {
|
|
1228
|
+
"text": "boolean"
|
|
1229
|
+
},
|
|
1230
|
+
"description": "Set to true to allow column reordering.",
|
|
1231
|
+
"attribute": "column-reordering-allowed",
|
|
1232
|
+
"inheritedFrom": {
|
|
1233
|
+
"name": "ColumnReorderingMixin",
|
|
1234
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-reordering-mixin.js"
|
|
1235
|
+
}
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
"kind": "field",
|
|
1239
|
+
"name": "dataProvider",
|
|
1240
|
+
"privacy": "public",
|
|
1241
|
+
"type": {
|
|
1242
|
+
"text": "GridDataProvider | null | undefined"
|
|
1243
|
+
},
|
|
1244
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
|
|
1245
|
+
"attribute": "data-provider",
|
|
1246
|
+
"inheritedFrom": {
|
|
1247
|
+
"name": "DataProviderMixin",
|
|
1248
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1249
|
+
}
|
|
1250
|
+
},
|
|
1251
|
+
{
|
|
1252
|
+
"kind": "method",
|
|
1253
|
+
"name": "deselectItem",
|
|
1254
|
+
"parameters": [
|
|
1255
|
+
{
|
|
1256
|
+
"name": "item",
|
|
1257
|
+
"description": "The item object",
|
|
1258
|
+
"type": {
|
|
1259
|
+
"text": "!GridItem"
|
|
1260
|
+
}
|
|
1261
|
+
}
|
|
1262
|
+
],
|
|
1263
|
+
"description": "Deselects the given item if it is already selected.",
|
|
1264
|
+
"inheritedFrom": {
|
|
1265
|
+
"name": "SelectionMixin",
|
|
1266
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1267
|
+
}
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"kind": "field",
|
|
1271
|
+
"name": "detailsOpenedItems",
|
|
1272
|
+
"privacy": "public",
|
|
1273
|
+
"type": {
|
|
1274
|
+
"text": "!Array<!GridItem>"
|
|
1275
|
+
},
|
|
1276
|
+
"description": "An array containing references to items with open row details.",
|
|
1277
|
+
"attribute": "details-opened-items",
|
|
1278
|
+
"inheritedFrom": {
|
|
1279
|
+
"name": "RowDetailsMixin",
|
|
1280
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1281
|
+
}
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"kind": "field",
|
|
1285
|
+
"name": "dragFilter",
|
|
1286
|
+
"privacy": "public",
|
|
1287
|
+
"type": {
|
|
1288
|
+
"text": "GridDragAndDropFilter | null | undefined"
|
|
1289
|
+
},
|
|
1290
|
+
"description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, 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.",
|
|
1291
|
+
"attribute": "drag-filter",
|
|
1292
|
+
"inheritedFrom": {
|
|
1293
|
+
"name": "DragAndDropMixin",
|
|
1294
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1295
|
+
}
|
|
1296
|
+
},
|
|
1297
|
+
{
|
|
1298
|
+
"kind": "field",
|
|
1299
|
+
"name": "dropFilter",
|
|
1300
|
+
"privacy": "public",
|
|
1301
|
+
"type": {
|
|
1302
|
+
"text": "GridDragAndDropFilter | null | undefined"
|
|
1303
|
+
},
|
|
1304
|
+
"description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, 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.",
|
|
1305
|
+
"attribute": "drop-filter",
|
|
1306
|
+
"inheritedFrom": {
|
|
1307
|
+
"name": "DragAndDropMixin",
|
|
1308
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1309
|
+
}
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"kind": "field",
|
|
1313
|
+
"name": "dropMode",
|
|
1314
|
+
"privacy": "public",
|
|
1315
|
+
"type": {
|
|
1316
|
+
"text": "GridDropMode | null | undefined"
|
|
1317
|
+
},
|
|
1318
|
+
"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.",
|
|
1319
|
+
"attribute": "drop-mode",
|
|
1320
|
+
"inheritedFrom": {
|
|
1321
|
+
"name": "DragAndDropMixin",
|
|
1322
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1323
|
+
}
|
|
1324
|
+
},
|
|
1325
|
+
{
|
|
1326
|
+
"kind": "field",
|
|
1327
|
+
"name": "exclude",
|
|
1328
|
+
"privacy": "public",
|
|
1329
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
1330
|
+
"type": {
|
|
1331
|
+
"text": "string | RegExp"
|
|
1332
|
+
},
|
|
1333
|
+
"attribute": "exclude",
|
|
1334
|
+
"inheritedFrom": {
|
|
1335
|
+
"name": "IncludedMixin",
|
|
1336
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
{
|
|
1340
|
+
"kind": "field",
|
|
1341
|
+
"name": "expandedItems",
|
|
1342
|
+
"privacy": "public",
|
|
1343
|
+
"type": {
|
|
1344
|
+
"text": "!Array<!GridItem>"
|
|
1345
|
+
},
|
|
1346
|
+
"description": "An array that contains the expanded items.",
|
|
1347
|
+
"attribute": "expanded-items",
|
|
1348
|
+
"inheritedFrom": {
|
|
1349
|
+
"name": "DataProviderMixin",
|
|
1350
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1351
|
+
}
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"kind": "method",
|
|
1355
|
+
"name": "expandItem",
|
|
1356
|
+
"parameters": [
|
|
1357
|
+
{
|
|
1358
|
+
"name": "item",
|
|
1359
|
+
"type": {
|
|
1360
|
+
"text": "!GridItem"
|
|
1361
|
+
}
|
|
1362
|
+
}
|
|
1363
|
+
],
|
|
1364
|
+
"description": "Expands the given item tree.",
|
|
1365
|
+
"inheritedFrom": {
|
|
1366
|
+
"name": "DataProviderMixin",
|
|
1367
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
"kind": "method",
|
|
1372
|
+
"name": "filterDragAndDrop",
|
|
1373
|
+
"description": "Runs the `dragFilter` and `dropFilter` hooks for the visible cells.\nIf the filter depends on varying conditions, you may need to\ncall this function manually in order to update the draggability when\nthe conditions change.",
|
|
1374
|
+
"inheritedFrom": {
|
|
1375
|
+
"name": "DragAndDropMixin",
|
|
1376
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1377
|
+
}
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"kind": "method",
|
|
1381
|
+
"name": "generateCellPartNames",
|
|
1382
|
+
"description": "Runs the `cellPartNameGenerator` for the visible cells.\nIf the generator depends on varying conditions, you need to\ncall this function manually in order to update the styles when\nthe conditions change.",
|
|
1383
|
+
"inheritedFrom": {
|
|
1384
|
+
"name": "StylingMixin",
|
|
1385
|
+
"package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
|
|
1386
|
+
}
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"kind": "method",
|
|
1390
|
+
"name": "getEventContext",
|
|
1391
|
+
"parameters": [
|
|
1392
|
+
{
|
|
1393
|
+
"name": "event",
|
|
1394
|
+
"type": {
|
|
1395
|
+
"text": "!Event"
|
|
1396
|
+
}
|
|
1397
|
+
}
|
|
1398
|
+
],
|
|
1399
|
+
"description": "Returns an object with context information about the event target:\n- `item`: the data object corresponding to the targeted row (not specified when targeting header or footer)\n- `column`: the column element corresponding to the targeted cell (not specified when targeting row details)\n- `section`: whether the event targeted the body, header, footer or details of the grid\n\nThese additional properties are included when `item` is specified:\n- `index`: the index of the item\n- `selected`: the selected state of the item\n- `detailsOpened`: whether the row details are open for the item\n- `expanded`: the expanded state of the tree toggle\n- `level`: the tree hierarchy level\n- `hasChildren`: whether the item has children\n\nThe returned object is populated only when a grid cell, header, footer or row details is found in `event.composedPath()`.\nThis means mostly mouse and keyboard events. If such a grid part is not found in the path, an empty object is returned.\nThis may be the case eg. if the event is fired on the `<vaadin-grid>` element and not any deeper in the DOM, or if\nthe event targets the empty part of the grid body.",
|
|
1400
|
+
"return": {
|
|
1401
|
+
"type": {
|
|
1402
|
+
"text": "GridEventContext"
|
|
1403
|
+
}
|
|
1404
|
+
},
|
|
1405
|
+
"inheritedFrom": {
|
|
1406
|
+
"name": "EventContextMixin",
|
|
1407
|
+
"package": "@vaadin/grid/src/vaadin-grid-event-context-mixin.js"
|
|
1408
|
+
}
|
|
1409
|
+
},
|
|
1410
|
+
{
|
|
1411
|
+
"kind": "method",
|
|
1412
|
+
"name": "getItemId",
|
|
1413
|
+
"parameters": [
|
|
1414
|
+
{
|
|
1415
|
+
"name": "item",
|
|
1416
|
+
"type": {
|
|
1417
|
+
"text": "!GridItem"
|
|
1418
|
+
}
|
|
1419
|
+
}
|
|
1420
|
+
],
|
|
1421
|
+
"description": "Returns a value that identifies the item. Uses `itemIdPath` if available.\nCan be customized by overriding.",
|
|
1422
|
+
"return": {
|
|
1423
|
+
"type": {
|
|
1424
|
+
"text": "!GridItem | !unknown"
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1427
|
+
"inheritedFrom": {
|
|
1428
|
+
"name": "DataProviderMixin",
|
|
1429
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1430
|
+
}
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"kind": "field",
|
|
1434
|
+
"name": "hideEditColumn",
|
|
1435
|
+
"privacy": "public",
|
|
1436
|
+
"type": {
|
|
1437
|
+
"text": "boolean"
|
|
1438
|
+
},
|
|
1439
|
+
"description": "Determines whether the edit column should be hidden.",
|
|
1440
|
+
"attribute": "hide-edit-column",
|
|
1441
|
+
"inheritedFrom": {
|
|
1442
|
+
"name": "CrudGridMixin",
|
|
1443
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1444
|
+
}
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"kind": "field",
|
|
1448
|
+
"name": "include",
|
|
1449
|
+
"privacy": "public",
|
|
1450
|
+
"description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
|
|
1451
|
+
"type": {
|
|
1452
|
+
"text": "string | !Array<string> | undefined"
|
|
1453
|
+
},
|
|
1454
|
+
"attribute": "include",
|
|
1455
|
+
"inheritedFrom": {
|
|
1456
|
+
"name": "IncludedMixin",
|
|
1457
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
1458
|
+
}
|
|
1459
|
+
},
|
|
1460
|
+
{
|
|
1461
|
+
"kind": "field",
|
|
1462
|
+
"name": "isItemSelectable",
|
|
1463
|
+
"privacy": "public",
|
|
1464
|
+
"type": {
|
|
1465
|
+
"text": "(item: !GridItem) => boolean"
|
|
1466
|
+
},
|
|
1467
|
+
"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.",
|
|
1468
|
+
"attribute": "is-item-selectable",
|
|
1469
|
+
"inheritedFrom": {
|
|
1470
|
+
"name": "SelectionMixin",
|
|
1471
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1472
|
+
}
|
|
1473
|
+
},
|
|
1474
|
+
{
|
|
1475
|
+
"kind": "field",
|
|
1476
|
+
"name": "itemHasChildrenPath",
|
|
1477
|
+
"privacy": "public",
|
|
1478
|
+
"type": {
|
|
1479
|
+
"text": "string"
|
|
1480
|
+
},
|
|
1481
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
1482
|
+
"attribute": "item-has-children-path",
|
|
1483
|
+
"inheritedFrom": {
|
|
1484
|
+
"name": "DataProviderMixin",
|
|
1485
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1486
|
+
}
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"kind": "field",
|
|
1490
|
+
"name": "itemIdPath",
|
|
1491
|
+
"privacy": "public",
|
|
1492
|
+
"type": {
|
|
1493
|
+
"text": "string"
|
|
1494
|
+
},
|
|
1495
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
1496
|
+
"attribute": "item-id-path",
|
|
1497
|
+
"inheritedFrom": {
|
|
1498
|
+
"name": "DataProviderMixin",
|
|
1499
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1500
|
+
}
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
"kind": "field",
|
|
1504
|
+
"name": "items",
|
|
1505
|
+
"privacy": "public",
|
|
1506
|
+
"type": {
|
|
1507
|
+
"text": "Array<!GridItem> | undefined"
|
|
1508
|
+
},
|
|
1509
|
+
"description": "An array containing the items which will be passed to renderer functions.",
|
|
1510
|
+
"attribute": "items",
|
|
1511
|
+
"inheritedFrom": {
|
|
1512
|
+
"name": "ArrayDataProviderMixin",
|
|
1513
|
+
"package": "@vaadin/grid/src/vaadin-grid-array-data-provider-mixin.js"
|
|
1514
|
+
}
|
|
1515
|
+
},
|
|
1516
|
+
{
|
|
1517
|
+
"kind": "field",
|
|
1518
|
+
"name": "loading",
|
|
1519
|
+
"privacy": "public",
|
|
1520
|
+
"type": {
|
|
1521
|
+
"text": "boolean"
|
|
1522
|
+
},
|
|
1523
|
+
"description": "`true` while data is being requested from the data provider.",
|
|
1524
|
+
"attribute": "loading",
|
|
1525
|
+
"inheritedFrom": {
|
|
1526
|
+
"name": "DataProviderMixin",
|
|
1527
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1528
|
+
}
|
|
1529
|
+
},
|
|
1530
|
+
{
|
|
1531
|
+
"kind": "field",
|
|
1532
|
+
"name": "multiSort",
|
|
1533
|
+
"privacy": "public",
|
|
1534
|
+
"type": {
|
|
1535
|
+
"text": "boolean"
|
|
1536
|
+
},
|
|
1537
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
1538
|
+
"attribute": "multi-sort",
|
|
1539
|
+
"inheritedFrom": {
|
|
1540
|
+
"name": "SortMixin",
|
|
1541
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1542
|
+
}
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"kind": "field",
|
|
1546
|
+
"name": "multiSortOnShiftClick",
|
|
1547
|
+
"privacy": "public",
|
|
1548
|
+
"type": {
|
|
1549
|
+
"text": "boolean"
|
|
1550
|
+
},
|
|
1551
|
+
"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.",
|
|
1552
|
+
"attribute": "multi-sort-on-shift-click",
|
|
1553
|
+
"inheritedFrom": {
|
|
1554
|
+
"name": "SortMixin",
|
|
1555
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1556
|
+
}
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"kind": "field",
|
|
1560
|
+
"name": "multiSortPriority",
|
|
1561
|
+
"privacy": "public",
|
|
1562
|
+
"type": {
|
|
1563
|
+
"text": "string"
|
|
1564
|
+
},
|
|
1565
|
+
"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\"`.",
|
|
1566
|
+
"attribute": "multi-sort-priority",
|
|
1567
|
+
"inheritedFrom": {
|
|
1568
|
+
"name": "SortMixin",
|
|
1569
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1570
|
+
}
|
|
1571
|
+
},
|
|
1572
|
+
{
|
|
1573
|
+
"kind": "field",
|
|
1574
|
+
"name": "noFilter",
|
|
1575
|
+
"privacy": "public",
|
|
1576
|
+
"description": "Disable filtering in the generated columns.",
|
|
1577
|
+
"attribute": "no-filter",
|
|
1578
|
+
"inheritedFrom": {
|
|
1579
|
+
"name": "CrudGridMixin",
|
|
1580
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1581
|
+
}
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"kind": "field",
|
|
1585
|
+
"name": "noHead",
|
|
1586
|
+
"privacy": "public",
|
|
1587
|
+
"description": "Do not add headers to columns.",
|
|
1588
|
+
"attribute": "no-head",
|
|
1589
|
+
"inheritedFrom": {
|
|
1590
|
+
"name": "CrudGridMixin",
|
|
1591
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1592
|
+
}
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"kind": "field",
|
|
1596
|
+
"name": "noSort",
|
|
1597
|
+
"privacy": "public",
|
|
1598
|
+
"description": "Disable sorting in the generated columns.",
|
|
1599
|
+
"attribute": "no-sort",
|
|
1600
|
+
"inheritedFrom": {
|
|
1601
|
+
"name": "CrudGridMixin",
|
|
1602
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1603
|
+
}
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"kind": "method",
|
|
1607
|
+
"name": "openItemDetails",
|
|
1608
|
+
"parameters": [
|
|
1609
|
+
{
|
|
1610
|
+
"name": "item",
|
|
1611
|
+
"type": {
|
|
1612
|
+
"text": "!GridItem"
|
|
1613
|
+
}
|
|
1614
|
+
}
|
|
1615
|
+
],
|
|
1616
|
+
"description": "Open the details row of a given item.",
|
|
1617
|
+
"inheritedFrom": {
|
|
1618
|
+
"name": "RowDetailsMixin",
|
|
1619
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1620
|
+
}
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
"kind": "field",
|
|
1624
|
+
"name": "pageSize",
|
|
1625
|
+
"privacy": "public",
|
|
1626
|
+
"type": {
|
|
1627
|
+
"text": "number"
|
|
1628
|
+
},
|
|
1629
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
1630
|
+
"attribute": "page-size",
|
|
1631
|
+
"inheritedFrom": {
|
|
1632
|
+
"name": "DataProviderMixin",
|
|
1633
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
{
|
|
1637
|
+
"kind": "method",
|
|
1638
|
+
"name": "recalculateColumnWidths",
|
|
1639
|
+
"description": "Updates the `width` of all columns which have `autoWidth` set to `true`.",
|
|
1640
|
+
"inheritedFrom": {
|
|
1641
|
+
"name": "ColumnAutoWidthMixin",
|
|
1642
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-auto-width-mixin.js"
|
|
1643
|
+
}
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"kind": "method",
|
|
1647
|
+
"name": "requestContentUpdate",
|
|
1648
|
+
"description": "Requests an update for the content of cells.\n\nWhile performing the update, the following renderers are invoked:\n- `Grid.rowDetailsRenderer`\n- `GridColumn.renderer`\n- `GridColumn.headerRenderer`\n- `GridColumn.footerRenderer`\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
|
|
1649
|
+
"inheritedFrom": {
|
|
1650
|
+
"name": "GridMixin",
|
|
1651
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
1652
|
+
}
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"kind": "field",
|
|
1656
|
+
"name": "rowDetailsRenderer",
|
|
1657
|
+
"privacy": "public",
|
|
1658
|
+
"type": {
|
|
1659
|
+
"text": "GridRowDetailsRenderer | null | undefined"
|
|
1660
|
+
},
|
|
1661
|
+
"description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
|
|
1662
|
+
"attribute": "row-details-renderer",
|
|
1663
|
+
"inheritedFrom": {
|
|
1664
|
+
"name": "RowDetailsMixin",
|
|
1665
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1666
|
+
}
|
|
1667
|
+
},
|
|
1668
|
+
{
|
|
1669
|
+
"kind": "field",
|
|
1670
|
+
"name": "rowsDraggable",
|
|
1671
|
+
"privacy": "public",
|
|
1672
|
+
"type": {
|
|
1673
|
+
"text": "boolean"
|
|
1674
|
+
},
|
|
1675
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
1676
|
+
"attribute": "rows-draggable",
|
|
1677
|
+
"inheritedFrom": {
|
|
1678
|
+
"name": "DragAndDropMixin",
|
|
1679
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1680
|
+
}
|
|
1681
|
+
},
|
|
1682
|
+
{
|
|
1683
|
+
"kind": "method",
|
|
1684
|
+
"name": "scrollToColumn",
|
|
1685
|
+
"parameters": [
|
|
1686
|
+
{
|
|
1687
|
+
"name": "indexOrColumn",
|
|
1688
|
+
"description": "Column element or column index",
|
|
1689
|
+
"type": {
|
|
1690
|
+
"text": "GridColumn | number"
|
|
1691
|
+
}
|
|
1692
|
+
}
|
|
1693
|
+
],
|
|
1694
|
+
"description": "Scrolls horizontally so that the column becomes visible in the viewport.\n\nThe column can be specified either by its index (among visible columns\nin visual order) or by the column element itself.",
|
|
1695
|
+
"inheritedFrom": {
|
|
1696
|
+
"name": "ScrollMixin",
|
|
1697
|
+
"package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
"kind": "method",
|
|
1702
|
+
"name": "scrollToIndex",
|
|
1703
|
+
"parameters": [
|
|
1704
|
+
{
|
|
1705
|
+
"name": "indexes",
|
|
1706
|
+
"description": "Row indexes to scroll to",
|
|
1707
|
+
"type": {
|
|
1708
|
+
"text": "...number"
|
|
1709
|
+
}
|
|
1710
|
+
}
|
|
1711
|
+
],
|
|
1712
|
+
"description": "Scroll to a specific row index in the virtual list. Note that the row index is\nnot always the same for any particular item. For example, sorting or filtering\nitems can affect the row index related to an item.\n\nThe `indexes` parameter can be either a single number or multiple numbers.\nThe grid will first try to scroll to the item at the first index on the top level.\nIn case the item at the first index is expanded, the grid will then try scroll to the\nitem at the second index within the children of the expanded first item, and so on.\nEach given index points to a child of the item at the previous index.\n\nUsing `Infinity` as an index will point to the last item on the level.",
|
|
1713
|
+
"inheritedFrom": {
|
|
1714
|
+
"name": "DataProviderMixin",
|
|
1715
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1716
|
+
}
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
"kind": "field",
|
|
1720
|
+
"name": "selectedItems",
|
|
1721
|
+
"privacy": "public",
|
|
1722
|
+
"type": {
|
|
1723
|
+
"text": "!Array<!GridItem>"
|
|
1724
|
+
},
|
|
1725
|
+
"description": "An array that contains the selected items.",
|
|
1726
|
+
"attribute": "selected-items",
|
|
1727
|
+
"inheritedFrom": {
|
|
1728
|
+
"name": "SelectionMixin",
|
|
1729
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1730
|
+
}
|
|
1731
|
+
},
|
|
1732
|
+
{
|
|
1733
|
+
"kind": "method",
|
|
1734
|
+
"name": "selectItem",
|
|
1735
|
+
"parameters": [
|
|
1736
|
+
{
|
|
1737
|
+
"name": "item",
|
|
1738
|
+
"description": "The item object",
|
|
1739
|
+
"type": {
|
|
1740
|
+
"text": "!GridItem"
|
|
1741
|
+
}
|
|
1742
|
+
}
|
|
1743
|
+
],
|
|
1744
|
+
"description": "Selects the given item.",
|
|
1745
|
+
"inheritedFrom": {
|
|
1746
|
+
"name": "SelectionMixin",
|
|
1747
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1748
|
+
}
|
|
1749
|
+
},
|
|
1750
|
+
{
|
|
1751
|
+
"kind": "method",
|
|
1752
|
+
"name": "setDefaultMultiSortPriority",
|
|
1753
|
+
"static": true,
|
|
1754
|
+
"parameters": [
|
|
1755
|
+
{
|
|
1756
|
+
"name": "priority",
|
|
1757
|
+
"type": {
|
|
1758
|
+
"text": "string"
|
|
1759
|
+
}
|
|
1760
|
+
}
|
|
1761
|
+
],
|
|
1762
|
+
"description": "Sets the default multi-sort priority to use for all grid instances.\nThis method should be called before creating any grid instances.\nChanging this setting does not affect the default for existing grids.",
|
|
1763
|
+
"inheritedFrom": {
|
|
1764
|
+
"name": "SortMixin",
|
|
1765
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1766
|
+
}
|
|
1767
|
+
},
|
|
1768
|
+
{
|
|
1769
|
+
"kind": "field",
|
|
1770
|
+
"name": "size",
|
|
1771
|
+
"privacy": "public",
|
|
1772
|
+
"type": {
|
|
1773
|
+
"text": "number"
|
|
1774
|
+
},
|
|
1775
|
+
"description": "The number of root-level items in the grid.",
|
|
1776
|
+
"attribute": "size",
|
|
1777
|
+
"inheritedFrom": {
|
|
1778
|
+
"name": "DataProviderMixin",
|
|
1779
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1780
|
+
}
|
|
1781
|
+
}
|
|
1782
|
+
],
|
|
1783
|
+
"mixins": [
|
|
1784
|
+
{
|
|
1785
|
+
"name": "CrudGridMixin",
|
|
1786
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1787
|
+
}
|
|
1788
|
+
],
|
|
1789
|
+
"superclass": {
|
|
1790
|
+
"name": "Grid",
|
|
1791
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1792
|
+
},
|
|
1793
|
+
"attributes": [
|
|
1794
|
+
{
|
|
1795
|
+
"name": "accessible-name",
|
|
1796
|
+
"type": {
|
|
1797
|
+
"text": "string"
|
|
1798
|
+
},
|
|
1799
|
+
"description": "String used to label the grid to screen reader users.",
|
|
1800
|
+
"fieldName": "accessibleName",
|
|
1801
|
+
"inheritedFrom": {
|
|
1802
|
+
"name": "A11yMixin",
|
|
1803
|
+
"package": "@vaadin/grid/src/vaadin-grid-a11y-mixin.js"
|
|
1804
|
+
}
|
|
1805
|
+
},
|
|
1806
|
+
{
|
|
1807
|
+
"name": "active-item",
|
|
1808
|
+
"type": {
|
|
1809
|
+
"text": "GridItem"
|
|
1810
|
+
},
|
|
1811
|
+
"description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
|
|
1812
|
+
"fieldName": "activeItem",
|
|
1813
|
+
"inheritedFrom": {
|
|
1814
|
+
"name": "ActiveItemMixin",
|
|
1815
|
+
"package": "@vaadin/grid/src/vaadin-grid-active-item-mixin.js"
|
|
1816
|
+
}
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
"name": "all-rows-visible",
|
|
1820
|
+
"type": {
|
|
1821
|
+
"text": "boolean"
|
|
1822
|
+
},
|
|
1823
|
+
"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.",
|
|
1824
|
+
"fieldName": "allRowsVisible",
|
|
1825
|
+
"inheritedFrom": {
|
|
1826
|
+
"name": "GridMixin",
|
|
1827
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
1828
|
+
}
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"name": "cell-part-name-generator",
|
|
1832
|
+
"type": {
|
|
1833
|
+
"text": "GridCellPartNameGenerator | null | undefined"
|
|
1834
|
+
},
|
|
1835
|
+
"description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, 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.",
|
|
1836
|
+
"fieldName": "cellPartNameGenerator",
|
|
1837
|
+
"inheritedFrom": {
|
|
1838
|
+
"name": "StylingMixin",
|
|
1839
|
+
"package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
|
|
1840
|
+
}
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"name": "column-rendering",
|
|
1844
|
+
"type": {
|
|
1845
|
+
"text": "!ColumnRendering"
|
|
1846
|
+
},
|
|
1847
|
+
"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.",
|
|
1848
|
+
"fieldName": "columnRendering",
|
|
1849
|
+
"inheritedFrom": {
|
|
1850
|
+
"name": "ScrollMixin",
|
|
1851
|
+
"package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
|
|
1852
|
+
}
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "column-reordering-allowed",
|
|
1856
|
+
"type": {
|
|
1857
|
+
"text": "boolean"
|
|
1858
|
+
},
|
|
1859
|
+
"description": "Set to true to allow column reordering.",
|
|
1860
|
+
"fieldName": "columnReorderingAllowed",
|
|
1861
|
+
"inheritedFrom": {
|
|
1862
|
+
"name": "ColumnReorderingMixin",
|
|
1863
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-reordering-mixin.js"
|
|
1864
|
+
}
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
"name": "data-provider",
|
|
1868
|
+
"type": {
|
|
1869
|
+
"text": "GridDataProvider | null | undefined"
|
|
1870
|
+
},
|
|
1871
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
|
|
1872
|
+
"fieldName": "dataProvider",
|
|
1873
|
+
"inheritedFrom": {
|
|
1874
|
+
"name": "DataProviderMixin",
|
|
1875
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1876
|
+
}
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"name": "drag-filter",
|
|
1880
|
+
"type": {
|
|
1881
|
+
"text": "GridDragAndDropFilter | null | undefined"
|
|
1882
|
+
},
|
|
1883
|
+
"description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, 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.",
|
|
1884
|
+
"fieldName": "dragFilter",
|
|
1885
|
+
"inheritedFrom": {
|
|
1886
|
+
"name": "DragAndDropMixin",
|
|
1887
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1888
|
+
}
|
|
1889
|
+
},
|
|
1890
|
+
{
|
|
1891
|
+
"name": "drop-filter",
|
|
1892
|
+
"type": {
|
|
1893
|
+
"text": "GridDragAndDropFilter | null | undefined"
|
|
1894
|
+
},
|
|
1895
|
+
"description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, 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.",
|
|
1896
|
+
"fieldName": "dropFilter",
|
|
1897
|
+
"inheritedFrom": {
|
|
1898
|
+
"name": "DragAndDropMixin",
|
|
1899
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1900
|
+
}
|
|
1901
|
+
},
|
|
1902
|
+
{
|
|
1903
|
+
"name": "drop-mode",
|
|
1904
|
+
"type": {
|
|
1905
|
+
"text": "GridDropMode | null | undefined"
|
|
1906
|
+
},
|
|
1907
|
+
"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.",
|
|
1908
|
+
"fieldName": "dropMode",
|
|
1909
|
+
"inheritedFrom": {
|
|
1910
|
+
"name": "DragAndDropMixin",
|
|
1911
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1912
|
+
}
|
|
1913
|
+
},
|
|
1914
|
+
{
|
|
1915
|
+
"name": "exclude",
|
|
1916
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
1917
|
+
"type": {
|
|
1918
|
+
"text": "string | RegExp"
|
|
1919
|
+
},
|
|
1920
|
+
"fieldName": "exclude",
|
|
1921
|
+
"inheritedFrom": {
|
|
1922
|
+
"name": "IncludedMixin",
|
|
1923
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
1924
|
+
}
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "hide-edit-column",
|
|
1928
|
+
"type": {
|
|
1929
|
+
"text": "boolean"
|
|
1930
|
+
},
|
|
1931
|
+
"description": "Determines whether the edit column should be hidden.",
|
|
1932
|
+
"fieldName": "hideEditColumn",
|
|
1933
|
+
"inheritedFrom": {
|
|
1934
|
+
"name": "CrudGridMixin",
|
|
1935
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
1936
|
+
}
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
"name": "interacting",
|
|
1940
|
+
"type": {
|
|
1941
|
+
"text": "boolean"
|
|
1942
|
+
},
|
|
1943
|
+
"description": "Indicates whether the grid is currently in interaction mode.\nIn interaction mode the user is currently interacting with a control,\nsuch as an input or a select, within a cell.\nIn interaction mode keyboard navigation between cells is disabled.\nInteraction mode also prevents the focus target cell of that section of\nthe grid from receiving focus, allowing the user to switch focus to\ncontrols in adjacent cells, rather than focussing the outer cell\nitself.",
|
|
1944
|
+
"fieldName": "interacting",
|
|
1945
|
+
"inheritedFrom": {
|
|
1946
|
+
"name": "KeyboardNavigationMixin",
|
|
1947
|
+
"package": "@vaadin/grid/src/vaadin-grid-keyboard-navigation-mixin.js"
|
|
1948
|
+
}
|
|
1949
|
+
},
|
|
1950
|
+
{
|
|
1951
|
+
"name": "is-attached",
|
|
1952
|
+
"fieldName": "isAttached",
|
|
1953
|
+
"inheritedFrom": {
|
|
1954
|
+
"name": "GridMixin",
|
|
1955
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
1956
|
+
}
|
|
1957
|
+
},
|
|
1958
|
+
{
|
|
1959
|
+
"name": "is-item-selectable",
|
|
1960
|
+
"type": {
|
|
1961
|
+
"text": "(item: !GridItem) => boolean"
|
|
1962
|
+
},
|
|
1963
|
+
"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.",
|
|
1964
|
+
"fieldName": "isItemSelectable",
|
|
1965
|
+
"inheritedFrom": {
|
|
1966
|
+
"name": "SelectionMixin",
|
|
1967
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1968
|
+
}
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"name": "item-has-children-path",
|
|
1972
|
+
"type": {
|
|
1973
|
+
"text": "string"
|
|
1974
|
+
},
|
|
1975
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
1976
|
+
"fieldName": "itemHasChildrenPath",
|
|
1977
|
+
"inheritedFrom": {
|
|
1978
|
+
"name": "DataProviderMixin",
|
|
1979
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1980
|
+
}
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"name": "item-id-path",
|
|
1984
|
+
"type": {
|
|
1985
|
+
"text": "string"
|
|
1986
|
+
},
|
|
1987
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
1988
|
+
"fieldName": "itemIdPath",
|
|
1989
|
+
"inheritedFrom": {
|
|
1990
|
+
"name": "DataProviderMixin",
|
|
1991
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1992
|
+
}
|
|
1993
|
+
},
|
|
1994
|
+
{
|
|
1995
|
+
"name": "loading",
|
|
1996
|
+
"type": {
|
|
1997
|
+
"text": "boolean"
|
|
1998
|
+
},
|
|
1999
|
+
"description": "`true` while data is being requested from the data provider.",
|
|
2000
|
+
"fieldName": "loading",
|
|
2001
|
+
"inheritedFrom": {
|
|
2002
|
+
"name": "DataProviderMixin",
|
|
2003
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
2004
|
+
}
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"name": "multi-sort",
|
|
2008
|
+
"type": {
|
|
2009
|
+
"text": "boolean"
|
|
2010
|
+
},
|
|
2011
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
2012
|
+
"fieldName": "multiSort",
|
|
2013
|
+
"inheritedFrom": {
|
|
2014
|
+
"name": "SortMixin",
|
|
2015
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
2016
|
+
}
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
"name": "multi-sort-on-shift-click",
|
|
2020
|
+
"type": {
|
|
2021
|
+
"text": "boolean"
|
|
2022
|
+
},
|
|
2023
|
+
"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.",
|
|
2024
|
+
"fieldName": "multiSortOnShiftClick",
|
|
2025
|
+
"inheritedFrom": {
|
|
2026
|
+
"name": "SortMixin",
|
|
2027
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
2028
|
+
}
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"name": "multi-sort-priority",
|
|
2032
|
+
"type": {
|
|
2033
|
+
"text": "string"
|
|
2034
|
+
},
|
|
2035
|
+
"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\"`.",
|
|
2036
|
+
"fieldName": "multiSortPriority",
|
|
2037
|
+
"inheritedFrom": {
|
|
2038
|
+
"name": "SortMixin",
|
|
2039
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
2040
|
+
}
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "no-filter",
|
|
2044
|
+
"description": "Disable filtering in the generated columns.",
|
|
2045
|
+
"fieldName": "noFilter",
|
|
2046
|
+
"inheritedFrom": {
|
|
2047
|
+
"name": "CrudGridMixin",
|
|
2048
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
2049
|
+
}
|
|
2050
|
+
},
|
|
2051
|
+
{
|
|
2052
|
+
"name": "no-head",
|
|
2053
|
+
"description": "Do not add headers to columns.",
|
|
2054
|
+
"fieldName": "noHead",
|
|
2055
|
+
"inheritedFrom": {
|
|
2056
|
+
"name": "CrudGridMixin",
|
|
2057
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
2058
|
+
}
|
|
2059
|
+
},
|
|
2060
|
+
{
|
|
2061
|
+
"name": "no-sort",
|
|
2062
|
+
"description": "Disable sorting in the generated columns.",
|
|
2063
|
+
"fieldName": "noSort",
|
|
2064
|
+
"inheritedFrom": {
|
|
2065
|
+
"name": "CrudGridMixin",
|
|
2066
|
+
"module": "src/vaadin-crud-grid-mixin.js"
|
|
2067
|
+
}
|
|
2068
|
+
},
|
|
2069
|
+
{
|
|
2070
|
+
"name": "page-size",
|
|
2071
|
+
"type": {
|
|
2072
|
+
"text": "number"
|
|
2073
|
+
},
|
|
2074
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
2075
|
+
"fieldName": "pageSize",
|
|
2076
|
+
"inheritedFrom": {
|
|
2077
|
+
"name": "DataProviderMixin",
|
|
2078
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
2079
|
+
}
|
|
2080
|
+
},
|
|
2081
|
+
{
|
|
2082
|
+
"name": "row-details-renderer",
|
|
2083
|
+
"type": {
|
|
2084
|
+
"text": "GridRowDetailsRenderer | null | undefined"
|
|
2085
|
+
},
|
|
2086
|
+
"description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
|
|
2087
|
+
"fieldName": "rowDetailsRenderer",
|
|
2088
|
+
"inheritedFrom": {
|
|
2089
|
+
"name": "RowDetailsMixin",
|
|
2090
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
2091
|
+
}
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
"name": "rows-draggable",
|
|
2095
|
+
"type": {
|
|
2096
|
+
"text": "boolean"
|
|
2097
|
+
},
|
|
2098
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
2099
|
+
"fieldName": "rowsDraggable",
|
|
2100
|
+
"inheritedFrom": {
|
|
2101
|
+
"name": "DragAndDropMixin",
|
|
2102
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
2103
|
+
}
|
|
2104
|
+
},
|
|
2105
|
+
{
|
|
2106
|
+
"name": "size",
|
|
2107
|
+
"type": {
|
|
2108
|
+
"text": "number"
|
|
2109
|
+
},
|
|
2110
|
+
"description": "The number of root-level items in the grid.",
|
|
2111
|
+
"fieldName": "size",
|
|
2112
|
+
"inheritedFrom": {
|
|
2113
|
+
"name": "DataProviderMixin",
|
|
2114
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
2115
|
+
}
|
|
2116
|
+
},
|
|
2117
|
+
{
|
|
2118
|
+
"name": "tabindex",
|
|
2119
|
+
"type": {
|
|
2120
|
+
"text": "number"
|
|
2121
|
+
},
|
|
2122
|
+
"description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
|
|
2123
|
+
"fieldName": "tabindex",
|
|
2124
|
+
"inheritedFrom": {
|
|
2125
|
+
"name": "TabindexMixin",
|
|
2126
|
+
"package": "@vaadin/a11y-base/src/tabindex-mixin.js"
|
|
2127
|
+
}
|
|
2128
|
+
}
|
|
2129
|
+
],
|
|
2130
|
+
"events": [
|
|
2131
|
+
{
|
|
2132
|
+
"type": {
|
|
2133
|
+
"text": "CustomEvent"
|
|
2134
|
+
},
|
|
2135
|
+
"description": "Fired when the `activeItem` property changes.",
|
|
2136
|
+
"name": "active-item-changed",
|
|
2137
|
+
"inheritedFrom": {
|
|
2138
|
+
"name": "Grid",
|
|
2139
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2140
|
+
}
|
|
2141
|
+
},
|
|
2142
|
+
{
|
|
2143
|
+
"type": {
|
|
2144
|
+
"text": "CustomEvent"
|
|
2145
|
+
},
|
|
2146
|
+
"description": "Fired when the cell is activated with click or keyboard.",
|
|
2147
|
+
"name": "cell-activate",
|
|
2148
|
+
"inheritedFrom": {
|
|
2149
|
+
"name": "Grid",
|
|
2150
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2151
|
+
}
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"type": {
|
|
2155
|
+
"text": "CustomEvent"
|
|
2156
|
+
},
|
|
2157
|
+
"description": "Fired when a cell is focused with click or keyboard navigation.",
|
|
2158
|
+
"name": "cell-focus",
|
|
2159
|
+
"inheritedFrom": {
|
|
2160
|
+
"name": "Grid",
|
|
2161
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2162
|
+
}
|
|
2163
|
+
},
|
|
2164
|
+
{
|
|
2165
|
+
"type": {
|
|
2166
|
+
"text": "CustomEvent"
|
|
2167
|
+
},
|
|
2168
|
+
"description": "Fired when the columns in the grid are reordered.",
|
|
2169
|
+
"name": "column-reorder",
|
|
2170
|
+
"inheritedFrom": {
|
|
2171
|
+
"name": "Grid",
|
|
2172
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2173
|
+
}
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"type": {
|
|
2177
|
+
"text": "CustomEvent"
|
|
2178
|
+
},
|
|
2179
|
+
"description": "Fired when the grid column resize is finished.",
|
|
2180
|
+
"name": "column-resize",
|
|
2181
|
+
"inheritedFrom": {
|
|
2182
|
+
"name": "Grid",
|
|
2183
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2184
|
+
}
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"type": {
|
|
2188
|
+
"text": "CustomEvent"
|
|
2189
|
+
},
|
|
2190
|
+
"description": "Fired when the `dataProvider` property changes.",
|
|
2191
|
+
"name": "data-provider-changed",
|
|
2192
|
+
"inheritedFrom": {
|
|
2193
|
+
"name": "Grid",
|
|
2194
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"type": {
|
|
2199
|
+
"text": "CustomEvent"
|
|
2200
|
+
},
|
|
2201
|
+
"description": "Fired when the `expandedItems` property changes.",
|
|
2202
|
+
"name": "expanded-items-changed",
|
|
2203
|
+
"inheritedFrom": {
|
|
2204
|
+
"name": "Grid",
|
|
2205
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2206
|
+
}
|
|
2207
|
+
},
|
|
2208
|
+
{
|
|
2209
|
+
"type": {
|
|
2210
|
+
"text": "CustomEvent"
|
|
2211
|
+
},
|
|
2212
|
+
"description": "Fired when the dragging of the rows ends.",
|
|
2213
|
+
"name": "grid-dragend",
|
|
2214
|
+
"inheritedFrom": {
|
|
2215
|
+
"name": "Grid",
|
|
2216
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"type": {
|
|
2221
|
+
"text": "CustomEvent"
|
|
2222
|
+
},
|
|
2223
|
+
"description": "Fired when starting to drag grid rows.",
|
|
2224
|
+
"name": "grid-dragstart",
|
|
2225
|
+
"inheritedFrom": {
|
|
2226
|
+
"name": "Grid",
|
|
2227
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2228
|
+
}
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
"type": {
|
|
2232
|
+
"text": "CustomEvent"
|
|
2233
|
+
},
|
|
2234
|
+
"description": "Fired when a drop occurs on top of the grid.",
|
|
2235
|
+
"name": "grid-drop",
|
|
2236
|
+
"inheritedFrom": {
|
|
2237
|
+
"name": "Grid",
|
|
2238
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2239
|
+
}
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"type": {
|
|
2243
|
+
"text": "CustomEvent"
|
|
2244
|
+
},
|
|
2245
|
+
"description": "Fired when the user selects or deselects an item through the selection column.",
|
|
2246
|
+
"name": "item-toggle",
|
|
2247
|
+
"inheritedFrom": {
|
|
2248
|
+
"name": "Grid",
|
|
2249
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2250
|
+
}
|
|
2251
|
+
},
|
|
2252
|
+
{
|
|
2253
|
+
"type": {
|
|
2254
|
+
"text": "CustomEvent"
|
|
2255
|
+
},
|
|
2256
|
+
"description": "Fired when the `loading` property changes.",
|
|
2257
|
+
"name": "loading-changed",
|
|
2258
|
+
"inheritedFrom": {
|
|
2259
|
+
"name": "Grid",
|
|
2260
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2261
|
+
}
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"type": {
|
|
2265
|
+
"text": "CustomEvent"
|
|
2266
|
+
},
|
|
2267
|
+
"description": "Fired when the `selectedItems` property changes.",
|
|
2268
|
+
"name": "selected-items-changed",
|
|
2269
|
+
"inheritedFrom": {
|
|
2270
|
+
"name": "Grid",
|
|
2271
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2272
|
+
}
|
|
2273
|
+
},
|
|
2274
|
+
{
|
|
2275
|
+
"type": {
|
|
2276
|
+
"text": "CustomEvent"
|
|
2277
|
+
},
|
|
2278
|
+
"description": "Fired when the `size` property changes.",
|
|
2279
|
+
"name": "size-changed",
|
|
2280
|
+
"inheritedFrom": {
|
|
2281
|
+
"name": "Grid",
|
|
2282
|
+
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2283
|
+
}
|
|
2284
|
+
}
|
|
2285
|
+
]
|
|
2286
|
+
}
|
|
2287
|
+
],
|
|
2288
|
+
"exports": [
|
|
2289
|
+
{
|
|
2290
|
+
"kind": "js",
|
|
2291
|
+
"name": "CrudGrid",
|
|
2292
|
+
"declaration": {
|
|
2293
|
+
"name": "CrudGrid",
|
|
2294
|
+
"module": "src/vaadin-crud-grid.js"
|
|
2295
|
+
}
|
|
2296
|
+
}
|
|
2297
|
+
]
|
|
2298
|
+
},
|
|
2299
|
+
{
|
|
2300
|
+
"kind": "javascript-module",
|
|
2301
|
+
"path": "src/vaadin-crud-helpers.js",
|
|
2302
|
+
"declarations": [
|
|
2303
|
+
{
|
|
2304
|
+
"kind": "function",
|
|
2305
|
+
"name": "capitalize",
|
|
2306
|
+
"parameters": [
|
|
2307
|
+
{
|
|
2308
|
+
"name": "path",
|
|
2309
|
+
"type": {
|
|
2310
|
+
"text": "string"
|
|
2311
|
+
}
|
|
2312
|
+
}
|
|
2313
|
+
],
|
|
2314
|
+
"description": "Convenience utility for capitalizing a string, with\nreplacing non-alphanumeric characters with spaces.",
|
|
2315
|
+
"return": {
|
|
2316
|
+
"type": {
|
|
2317
|
+
"text": "string"
|
|
2318
|
+
}
|
|
2319
|
+
}
|
|
2320
|
+
},
|
|
2321
|
+
{
|
|
2322
|
+
"kind": "function",
|
|
2323
|
+
"name": "getProperty",
|
|
2324
|
+
"parameters": [
|
|
2325
|
+
{
|
|
2326
|
+
"name": "path",
|
|
2327
|
+
"type": {
|
|
2328
|
+
"text": "string"
|
|
2329
|
+
}
|
|
2330
|
+
},
|
|
2331
|
+
{
|
|
2332
|
+
"name": "obj",
|
|
2333
|
+
"type": {
|
|
2334
|
+
"text": "Object"
|
|
2335
|
+
}
|
|
2336
|
+
}
|
|
2337
|
+
],
|
|
2338
|
+
"description": "Convenience utility for reading a value from a path.",
|
|
2339
|
+
"return": {
|
|
2340
|
+
"type": {
|
|
2341
|
+
"text": "*"
|
|
2342
|
+
}
|
|
2343
|
+
}
|
|
2344
|
+
},
|
|
2345
|
+
{
|
|
2346
|
+
"kind": "function",
|
|
2347
|
+
"name": "setProperty",
|
|
2348
|
+
"parameters": [
|
|
2349
|
+
{
|
|
2350
|
+
"name": "path",
|
|
2351
|
+
"type": {
|
|
2352
|
+
"text": "string"
|
|
2353
|
+
}
|
|
2354
|
+
},
|
|
2355
|
+
{
|
|
2356
|
+
"name": "value",
|
|
2357
|
+
"type": {
|
|
2358
|
+
"text": "*"
|
|
2359
|
+
}
|
|
2360
|
+
},
|
|
2361
|
+
{
|
|
2362
|
+
"name": "obj",
|
|
2363
|
+
"type": {
|
|
2364
|
+
"text": "Object"
|
|
2365
|
+
}
|
|
2366
|
+
}
|
|
2367
|
+
],
|
|
2368
|
+
"description": "Convenience utility for setting a value to a path.\n\nNote, if any part in the path is undefined, this\nfunction initializes it with an empty object."
|
|
2369
|
+
},
|
|
2370
|
+
{
|
|
2371
|
+
"kind": "function",
|
|
2372
|
+
"name": "isValidEditorPosition",
|
|
2373
|
+
"parameters": [
|
|
2374
|
+
{
|
|
2375
|
+
"name": "editorPosition"
|
|
2376
|
+
}
|
|
2377
|
+
]
|
|
2378
|
+
},
|
|
2379
|
+
{
|
|
2380
|
+
"kind": "function",
|
|
2381
|
+
"name": "editColumnDefaultRenderer",
|
|
2382
|
+
"parameters": [
|
|
2383
|
+
{
|
|
2384
|
+
"name": "root"
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"name": "column"
|
|
2388
|
+
}
|
|
2389
|
+
]
|
|
2390
|
+
},
|
|
2391
|
+
{
|
|
2392
|
+
"kind": "function",
|
|
2393
|
+
"name": "createField",
|
|
2394
|
+
"parameters": [
|
|
2395
|
+
{
|
|
2396
|
+
"name": "crudForm"
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"name": "parent"
|
|
2400
|
+
},
|
|
2401
|
+
{
|
|
2402
|
+
"name": "path"
|
|
2403
|
+
}
|
|
2404
|
+
]
|
|
2405
|
+
},
|
|
2406
|
+
{
|
|
2407
|
+
"kind": "function",
|
|
2408
|
+
"name": "createFields",
|
|
2409
|
+
"parameters": [
|
|
2410
|
+
{
|
|
2411
|
+
"name": "crudForm"
|
|
2412
|
+
},
|
|
2413
|
+
{
|
|
2414
|
+
"name": "parent"
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"name": "object"
|
|
2418
|
+
},
|
|
2419
|
+
{
|
|
2420
|
+
"name": "path"
|
|
2421
|
+
}
|
|
2422
|
+
]
|
|
2423
|
+
}
|
|
2424
|
+
],
|
|
2425
|
+
"exports": [
|
|
2426
|
+
{
|
|
2427
|
+
"kind": "js",
|
|
2428
|
+
"name": "capitalize",
|
|
2429
|
+
"declaration": {
|
|
2430
|
+
"name": "capitalize",
|
|
2431
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2432
|
+
}
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
"kind": "js",
|
|
2436
|
+
"name": "getProperty",
|
|
2437
|
+
"declaration": {
|
|
2438
|
+
"name": "getProperty",
|
|
2439
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2440
|
+
}
|
|
2441
|
+
},
|
|
2442
|
+
{
|
|
2443
|
+
"kind": "js",
|
|
2444
|
+
"name": "setProperty",
|
|
2445
|
+
"declaration": {
|
|
2446
|
+
"name": "setProperty",
|
|
2447
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2448
|
+
}
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
"kind": "js",
|
|
2452
|
+
"name": "isValidEditorPosition",
|
|
2453
|
+
"declaration": {
|
|
2454
|
+
"name": "isValidEditorPosition",
|
|
2455
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2456
|
+
}
|
|
2457
|
+
},
|
|
2458
|
+
{
|
|
2459
|
+
"kind": "js",
|
|
2460
|
+
"name": "editColumnDefaultRenderer",
|
|
2461
|
+
"declaration": {
|
|
2462
|
+
"name": "editColumnDefaultRenderer",
|
|
2463
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2464
|
+
}
|
|
2465
|
+
},
|
|
2466
|
+
{
|
|
2467
|
+
"kind": "js",
|
|
2468
|
+
"name": "createField",
|
|
2469
|
+
"declaration": {
|
|
2470
|
+
"name": "createField",
|
|
2471
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2472
|
+
}
|
|
2473
|
+
},
|
|
2474
|
+
{
|
|
2475
|
+
"kind": "js",
|
|
2476
|
+
"name": "createFields",
|
|
2477
|
+
"declaration": {
|
|
2478
|
+
"name": "createFields",
|
|
2479
|
+
"module": "src/vaadin-crud-helpers.js"
|
|
2480
|
+
}
|
|
2481
|
+
}
|
|
2482
|
+
]
|
|
2483
|
+
},
|
|
2484
|
+
{
|
|
2485
|
+
"kind": "javascript-module",
|
|
2486
|
+
"path": "src/vaadin-crud-include-mixin.js",
|
|
2487
|
+
"declarations": [
|
|
2488
|
+
{
|
|
2489
|
+
"kind": "mixin",
|
|
2490
|
+
"description": "",
|
|
2491
|
+
"name": "IncludedMixin",
|
|
2492
|
+
"members": [
|
|
2493
|
+
{
|
|
2494
|
+
"kind": "field",
|
|
2495
|
+
"name": "exclude",
|
|
2496
|
+
"privacy": "public",
|
|
2497
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
2498
|
+
"type": {
|
|
2499
|
+
"text": "string | RegExp"
|
|
2500
|
+
},
|
|
2501
|
+
"attribute": "exclude"
|
|
2502
|
+
},
|
|
2503
|
+
{
|
|
2504
|
+
"kind": "field",
|
|
2505
|
+
"name": "include",
|
|
2506
|
+
"privacy": "public",
|
|
2507
|
+
"description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
|
|
2508
|
+
"type": {
|
|
2509
|
+
"text": "string | !Array<string> | undefined"
|
|
2510
|
+
},
|
|
2511
|
+
"attribute": "include"
|
|
2512
|
+
}
|
|
2513
|
+
],
|
|
2514
|
+
"attributes": [
|
|
2515
|
+
{
|
|
2516
|
+
"name": "exclude",
|
|
2517
|
+
"description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
|
|
2518
|
+
"type": {
|
|
2519
|
+
"text": "string | RegExp"
|
|
2520
|
+
},
|
|
2521
|
+
"fieldName": "exclude"
|
|
2522
|
+
}
|
|
2523
|
+
],
|
|
2524
|
+
"parameters": [
|
|
2525
|
+
{
|
|
2526
|
+
"name": "superClass"
|
|
2527
|
+
}
|
|
2528
|
+
]
|
|
2529
|
+
}
|
|
2530
|
+
],
|
|
2531
|
+
"exports": [
|
|
2532
|
+
{
|
|
2533
|
+
"kind": "js",
|
|
2534
|
+
"name": "IncludedMixin",
|
|
2535
|
+
"declaration": {
|
|
2536
|
+
"name": "IncludedMixin",
|
|
2537
|
+
"module": "src/vaadin-crud-include-mixin.js"
|
|
2538
|
+
}
|
|
2539
|
+
}
|
|
2540
|
+
]
|
|
2541
|
+
},
|
|
2542
|
+
{
|
|
2543
|
+
"kind": "javascript-module",
|
|
2544
|
+
"path": "src/vaadin-crud-mixin.js",
|
|
2545
|
+
"declarations": [
|
|
2546
|
+
{
|
|
2547
|
+
"kind": "mixin",
|
|
2548
|
+
"description": "A mixin providing common crud functionality.",
|
|
2549
|
+
"name": "CrudMixin",
|
|
2550
|
+
"members": [
|
|
2551
|
+
{
|
|
2552
|
+
"kind": "field",
|
|
2553
|
+
"name": "dataProvider",
|
|
2554
|
+
"privacy": "public",
|
|
2555
|
+
"type": {
|
|
2556
|
+
"text": "CrudDataProvider | undefined"
|
|
2557
|
+
},
|
|
2558
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n`params.pageSize` Current page size\n`params.filters` Currently applied filters\n`params.sortOrders` Currently applied sorting orders\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items",
|
|
2559
|
+
"attribute": "data-provider"
|
|
2560
|
+
},
|
|
2561
|
+
{
|
|
2562
|
+
"kind": "field",
|
|
2563
|
+
"name": "editedItem",
|
|
2564
|
+
"privacy": "public",
|
|
2565
|
+
"type": {
|
|
2566
|
+
"text": "unknown"
|
|
2567
|
+
},
|
|
2568
|
+
"description": "The item being edited in the dialog.",
|
|
2569
|
+
"attribute": "edited-item"
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
"kind": "field",
|
|
2573
|
+
"name": "editOnClick",
|
|
2574
|
+
"privacy": "public",
|
|
2575
|
+
"type": {
|
|
2576
|
+
"text": "boolean"
|
|
2577
|
+
},
|
|
2578
|
+
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
2579
|
+
"attribute": "edit-on-click"
|
|
2580
|
+
},
|
|
2581
|
+
{
|
|
2582
|
+
"kind": "field",
|
|
2583
|
+
"name": "editorOpened",
|
|
2584
|
+
"privacy": "public",
|
|
2585
|
+
"type": {
|
|
2586
|
+
"text": "boolean"
|
|
2587
|
+
},
|
|
2588
|
+
"description": "Reflects the opened status of the editor.",
|
|
2589
|
+
"attribute": "editor-opened"
|
|
2590
|
+
},
|
|
2591
|
+
{
|
|
2592
|
+
"kind": "field",
|
|
2593
|
+
"name": "editorPosition",
|
|
2594
|
+
"privacy": "public",
|
|
2595
|
+
"type": {
|
|
2596
|
+
"text": "!CrudEditorPosition"
|
|
2597
|
+
},
|
|
2598
|
+
"description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
|
|
2599
|
+
"attribute": "editor-position"
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
"kind": "field",
|
|
2603
|
+
"name": "exclude",
|
|
2604
|
+
"privacy": "public",
|
|
2605
|
+
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
2606
|
+
"attribute": "exclude"
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
"kind": "field",
|
|
2610
|
+
"name": "include",
|
|
2611
|
+
"privacy": "public",
|
|
2612
|
+
"description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
2613
|
+
"attribute": "include"
|
|
2614
|
+
},
|
|
2615
|
+
{
|
|
2616
|
+
"kind": "field",
|
|
2617
|
+
"name": "items",
|
|
2618
|
+
"privacy": "public",
|
|
2619
|
+
"type": {
|
|
2620
|
+
"text": "Array<unknown> | undefined"
|
|
2621
|
+
},
|
|
2622
|
+
"description": "An array containing the items which will be stamped to the column template instances.",
|
|
2623
|
+
"attribute": "items"
|
|
2624
|
+
},
|
|
2625
|
+
{
|
|
2626
|
+
"kind": "field",
|
|
2627
|
+
"name": "noFilter",
|
|
2628
|
+
"privacy": "public",
|
|
2629
|
+
"description": "Disable filtering when grid is autoconfigured.",
|
|
2630
|
+
"attribute": "no-filter"
|
|
2631
|
+
},
|
|
2632
|
+
{
|
|
2633
|
+
"kind": "field",
|
|
2634
|
+
"name": "noHead",
|
|
2635
|
+
"privacy": "public",
|
|
2636
|
+
"description": "Remove grid headers when it is autoconfigured.",
|
|
2637
|
+
"attribute": "no-head"
|
|
2638
|
+
},
|
|
2639
|
+
{
|
|
2640
|
+
"kind": "field",
|
|
2641
|
+
"name": "noSort",
|
|
2642
|
+
"privacy": "public",
|
|
2643
|
+
"description": "Disable sorting when grid is autoconfigured.",
|
|
2644
|
+
"attribute": "no-sort"
|
|
2645
|
+
},
|
|
2646
|
+
{
|
|
2647
|
+
"kind": "field",
|
|
2648
|
+
"name": "noToolbar",
|
|
2649
|
+
"privacy": "public",
|
|
2650
|
+
"type": {
|
|
2651
|
+
"text": "boolean"
|
|
2652
|
+
},
|
|
2653
|
+
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
2654
|
+
"attribute": "no-toolbar"
|
|
2655
|
+
},
|
|
2656
|
+
{
|
|
2657
|
+
"kind": "field",
|
|
2658
|
+
"name": "size",
|
|
2659
|
+
"privacy": "public",
|
|
2660
|
+
"type": {
|
|
2661
|
+
"text": "number"
|
|
2662
|
+
},
|
|
2663
|
+
"description": "Number of items in the data set which is reported by the grid.\nTypically it reflects the number of filtered items displayed in the grid.\n\nNote: As with `<vaadin-grid>`, this property updates automatically only\nif `items` is used for data.",
|
|
2664
|
+
"attribute": "size"
|
|
2665
|
+
}
|
|
2666
|
+
],
|
|
2667
|
+
"attributes": [
|
|
2668
|
+
{
|
|
2669
|
+
"name": "data-provider",
|
|
2670
|
+
"type": {
|
|
2671
|
+
"text": "CrudDataProvider | undefined"
|
|
2672
|
+
},
|
|
2673
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n`params.pageSize` Current page size\n`params.filters` Currently applied filters\n`params.sortOrders` Currently applied sorting orders\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items",
|
|
2674
|
+
"fieldName": "dataProvider"
|
|
2675
|
+
},
|
|
2676
|
+
{
|
|
2677
|
+
"name": "edit-on-click",
|
|
2678
|
+
"type": {
|
|
2679
|
+
"text": "boolean"
|
|
2680
|
+
},
|
|
2681
|
+
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
2682
|
+
"fieldName": "editOnClick"
|
|
2683
|
+
},
|
|
2684
|
+
{
|
|
2685
|
+
"name": "editor-opened",
|
|
2686
|
+
"type": {
|
|
2687
|
+
"text": "boolean"
|
|
2688
|
+
},
|
|
2689
|
+
"description": "Reflects the opened status of the editor.",
|
|
2690
|
+
"fieldName": "editorOpened"
|
|
2691
|
+
},
|
|
2692
|
+
{
|
|
2693
|
+
"name": "editor-position",
|
|
2694
|
+
"type": {
|
|
2695
|
+
"text": "!CrudEditorPosition"
|
|
2696
|
+
},
|
|
2697
|
+
"description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
|
|
2698
|
+
"fieldName": "editorPosition"
|
|
2699
|
+
},
|
|
2700
|
+
{
|
|
2701
|
+
"name": "exclude",
|
|
2702
|
+
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
2703
|
+
"fieldName": "exclude"
|
|
2704
|
+
},
|
|
2705
|
+
{
|
|
2706
|
+
"name": "include",
|
|
2707
|
+
"description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
2708
|
+
"fieldName": "include"
|
|
2709
|
+
},
|
|
2710
|
+
{
|
|
2711
|
+
"name": "no-filter",
|
|
2712
|
+
"description": "Disable filtering when grid is autoconfigured.",
|
|
2713
|
+
"fieldName": "noFilter"
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "no-head",
|
|
2717
|
+
"description": "Remove grid headers when it is autoconfigured.",
|
|
2718
|
+
"fieldName": "noHead"
|
|
2719
|
+
},
|
|
2720
|
+
{
|
|
2721
|
+
"name": "no-sort",
|
|
2722
|
+
"description": "Disable sorting when grid is autoconfigured.",
|
|
2723
|
+
"fieldName": "noSort"
|
|
2724
|
+
},
|
|
2725
|
+
{
|
|
2726
|
+
"name": "no-toolbar",
|
|
2727
|
+
"type": {
|
|
2728
|
+
"text": "boolean"
|
|
2729
|
+
},
|
|
2730
|
+
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
2731
|
+
"fieldName": "noToolbar"
|
|
2732
|
+
},
|
|
2733
|
+
{
|
|
2734
|
+
"name": "size",
|
|
2735
|
+
"type": {
|
|
2736
|
+
"text": "number"
|
|
2737
|
+
},
|
|
2738
|
+
"description": "Number of items in the data set which is reported by the grid.\nTypically it reflects the number of filtered items displayed in the grid.\n\nNote: As with `<vaadin-grid>`, this property updates automatically only\nif `items` is used for data.",
|
|
2739
|
+
"fieldName": "size"
|
|
2740
|
+
}
|
|
2741
|
+
],
|
|
2742
|
+
"mixins": [
|
|
2743
|
+
{
|
|
2744
|
+
"name": "I18nMixin",
|
|
2745
|
+
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
2746
|
+
}
|
|
2747
|
+
],
|
|
2748
|
+
"parameters": [
|
|
2749
|
+
{
|
|
2750
|
+
"name": "superClass"
|
|
2751
|
+
}
|
|
2752
|
+
]
|
|
2753
|
+
}
|
|
2754
|
+
],
|
|
2755
|
+
"exports": [
|
|
2756
|
+
{
|
|
2757
|
+
"kind": "js",
|
|
2758
|
+
"name": "CrudMixin",
|
|
2759
|
+
"declaration": {
|
|
2760
|
+
"name": "CrudMixin",
|
|
2761
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2762
|
+
}
|
|
2763
|
+
}
|
|
2764
|
+
]
|
|
2765
|
+
},
|
|
2766
|
+
{
|
|
2767
|
+
"kind": "javascript-module",
|
|
2768
|
+
"path": "src/vaadin-crud.js",
|
|
2769
|
+
"declarations": [
|
|
2770
|
+
{
|
|
2771
|
+
"kind": "class",
|
|
2772
|
+
"description": "`<vaadin-crud>` is a Web Component for [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) operations.\n\n### Quick Start\n\nAssign an array to the [`items`](#/elements/vaadin-crud#property-items) property.\n\nA grid and an editor will be automatically generated and configured based on the data structure provided.\n\n```html\n<vaadin-crud></vaadin-crud>\n```\n\n```js\nconst crud = document.querySelector('vaadin-crud');\n\ncrud.items = [\n { name: 'John', surname: 'Lennon', role: 'singer' },\n { name: 'Ringo', surname: 'Starr', role: 'drums' },\n // ... more items\n];\n```\n\n### Data Provider Function\n\nOtherwise, you can provide a [`dataProvider`](#/elements/vaadin-crud#property-dataProvider) function.\n\n```js\nconst crud = document.querySelector('vaadin-crud');\n\nconst users = [\n { name: 'John', surname: 'Lennon', role: 'singer' },\n { name: 'Ringo', surname: 'Starr', role: 'drums' },\n // ... more items\n];\n\ncrud.dataProvider = (params, callback) => {\n const chunk = users.slice(params.page * params.pageSize, params.page * params.pageSize + params.pageSize);\n callback(chunk, people.length);\n};\n```\n\nNOTE: The auto-generated editor only supports string types. If you need to handle special cases\ncustomizing the editor is discussed below.\n\n### Customization\n\nAlternatively you can fully configure the component by using `slot` names.\n\nSlot name | Description\n---------------|----------------\n`grid` | To replace the auto-generated grid with a custom one.\n`form` | To replace the auto-generated form.\n`save-button` | To replace the \"Save\" button.\n`cancel-button`| To replace the \"Cancel\" button.\n`delete-button`| To replace the \"Delete\" button.\n`toolbar` | To provide the toolbar content (by default, it's empty).\n`new-button` | To replace the \"New item\" button.\n\n#### Example:\n\n```html\n<vaadin-crud id=\"crud\">\n <vaadin-grid slot=\"grid\">\n <vaadin-crud-edit-column></vaadin-crud-edit-column>\n <vaadin-grid-column id=\"column1\"></vaadin-grid-column>\n <vaadin-grid-column id=\"column2\"></vaadin-grid-column>\n </vaadin-grid>\n\n <vaadin-form-layout slot=\"form\">\n <vaadin-text-field label=\"First\" path=\"name\"></vaadin-text-field>\n <vaadin-text-field label=\"Surname\" path=\"surname\"></vaadin-text-field>\n </vaadin-form-layout>\n\n <div slot=\"toolbar\">Total singers: 2</div>\n <button slot=\"new-button\">New singer</button>\n\n <button slot=\"save-button\">Save changes</button>\n <button slot=\"cancel-button\">Discard changes</button>\n <button slot=\"delete-button\">Delete singer</button>\n</vaadin-crud>\n```\n```js\nconst crud = document.querySelector('#crud');\n\nconst column1 = document.querySelector('#column1');\ncolumn1.headerRenderer = (root, column) => {\n root.textContent = 'Name';\n};\ncolumn1.renderer = (root, column, model) => {\n root.textContent = model.item.name;\n};\n\nconst column2 = document.querySelector('#column2');\ncolumn2.headerRenderer = (root, column) => {\n root.textContent = 'Surname';\n};\ncolumn2.renderer = (root, column, model) => {\n root.textContent = model.item.surname;\n};\n\ncrud.items = [\n { name: 'John', surname: 'Lennon', role: 'singer' },\n { name: 'Ringo', surname: 'Starr', role: 'drums' },\n // ... more items\n];\n```\n\n### Helpers\n\nThe following elements are used to auto-configure the grid and the editor\n- [`<vaadin-crud-edit-column>`](#/elements/vaadin-crud-edit-column)\n- `<vaadin-crud-grid>` - can be replaced with custom [`<vaadin-grid>`](#/elements/vaadin-grid)\n- `<vaadin-crud-form>` - can be replaced with custom [`<vaadin-form-layout>`](#/elements/vaadin-form-layout)\n\n### Styling\n\nThe following shadow DOM parts are available for styling when the editor is rendered next to, or below, the grid:\n\nPart name | Description\n----------------|----------------\n`toolbar` | Toolbar container at the bottom of the grid. By default, it contains the `new` button\n`editor` | The editor container\n`scroller` | The wrapper for the header and the form\n`header` | The header of the editor\n`footer` | The footer of the editor\n\nThe following shadow DOM parts are available for styling when the editor renders as a dialog:\n\nPart name | Description\n----------------|----------------\n`toolbar` | Toolbar container at the bottom of the grid. By default, it contains the `new` button\n`overlay` | The dialog overlay\n`backdrop` | The dialog backdrop\n`header` | The header of the dialog\n`footer` | The footer of the dialog\n`content` | The wrapper for the form\n\nThe following custom properties are available:\n\nCustom Property | Description | Default\n----------------|----------------\n--vaadin-crud-editor-max-height | max height of editor when opened on the bottom | 40%\n--vaadin-crud-editor-max-width | max width of editor when opened on the side | 40%\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
2773
|
+
"name": "Crud",
|
|
2774
|
+
"members": [
|
|
2775
|
+
{
|
|
2776
|
+
"kind": "field",
|
|
2777
|
+
"name": "dataProvider",
|
|
2778
|
+
"privacy": "public",
|
|
2779
|
+
"type": {
|
|
2780
|
+
"text": "CrudDataProvider | undefined"
|
|
2781
|
+
},
|
|
2782
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n`params.pageSize` Current page size\n`params.filters` Currently applied filters\n`params.sortOrders` Currently applied sorting orders\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items",
|
|
2783
|
+
"attribute": "data-provider",
|
|
2784
|
+
"inheritedFrom": {
|
|
2785
|
+
"name": "CrudMixin",
|
|
2786
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2787
|
+
}
|
|
2788
|
+
},
|
|
2789
|
+
{
|
|
2790
|
+
"kind": "field",
|
|
2791
|
+
"name": "editedItem",
|
|
2792
|
+
"privacy": "public",
|
|
2793
|
+
"type": {
|
|
2794
|
+
"text": "unknown"
|
|
2795
|
+
},
|
|
2796
|
+
"description": "The item being edited in the dialog.",
|
|
2797
|
+
"attribute": "edited-item",
|
|
2798
|
+
"inheritedFrom": {
|
|
2799
|
+
"name": "CrudMixin",
|
|
2800
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2801
|
+
}
|
|
2802
|
+
},
|
|
2803
|
+
{
|
|
2804
|
+
"kind": "field",
|
|
2805
|
+
"name": "editOnClick",
|
|
2806
|
+
"privacy": "public",
|
|
2807
|
+
"type": {
|
|
2808
|
+
"text": "boolean"
|
|
2809
|
+
},
|
|
2810
|
+
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
2811
|
+
"attribute": "edit-on-click",
|
|
2812
|
+
"inheritedFrom": {
|
|
2813
|
+
"name": "CrudMixin",
|
|
2814
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2815
|
+
}
|
|
2816
|
+
},
|
|
2817
|
+
{
|
|
2818
|
+
"kind": "field",
|
|
2819
|
+
"name": "editorOpened",
|
|
2820
|
+
"privacy": "public",
|
|
2821
|
+
"type": {
|
|
2822
|
+
"text": "boolean"
|
|
2823
|
+
},
|
|
2824
|
+
"description": "Reflects the opened status of the editor.",
|
|
2825
|
+
"attribute": "editor-opened",
|
|
2826
|
+
"inheritedFrom": {
|
|
2827
|
+
"name": "CrudMixin",
|
|
2828
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2829
|
+
}
|
|
2830
|
+
},
|
|
2831
|
+
{
|
|
2832
|
+
"kind": "field",
|
|
2833
|
+
"name": "editorPosition",
|
|
2834
|
+
"privacy": "public",
|
|
2835
|
+
"type": {
|
|
2836
|
+
"text": "!CrudEditorPosition"
|
|
2837
|
+
},
|
|
2838
|
+
"description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
|
|
2839
|
+
"attribute": "editor-position",
|
|
2840
|
+
"inheritedFrom": {
|
|
2841
|
+
"name": "CrudMixin",
|
|
2842
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2843
|
+
}
|
|
2844
|
+
},
|
|
2845
|
+
{
|
|
2846
|
+
"kind": "field",
|
|
2847
|
+
"name": "exclude",
|
|
2848
|
+
"privacy": "public",
|
|
2849
|
+
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
2850
|
+
"attribute": "exclude",
|
|
2851
|
+
"inheritedFrom": {
|
|
2852
|
+
"name": "CrudMixin",
|
|
2853
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2854
|
+
}
|
|
2855
|
+
},
|
|
2856
|
+
{
|
|
2857
|
+
"kind": "field",
|
|
2858
|
+
"name": "include",
|
|
2859
|
+
"privacy": "public",
|
|
2860
|
+
"description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
2861
|
+
"attribute": "include",
|
|
2862
|
+
"inheritedFrom": {
|
|
2863
|
+
"name": "CrudMixin",
|
|
2864
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2865
|
+
}
|
|
2866
|
+
},
|
|
2867
|
+
{
|
|
2868
|
+
"kind": "field",
|
|
2869
|
+
"name": "items",
|
|
2870
|
+
"privacy": "public",
|
|
2871
|
+
"type": {
|
|
2872
|
+
"text": "Array<unknown> | undefined"
|
|
2873
|
+
},
|
|
2874
|
+
"description": "An array containing the items which will be stamped to the column template instances.",
|
|
2875
|
+
"attribute": "items",
|
|
2876
|
+
"inheritedFrom": {
|
|
2877
|
+
"name": "CrudMixin",
|
|
2878
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2879
|
+
}
|
|
2880
|
+
},
|
|
2881
|
+
{
|
|
2882
|
+
"kind": "field",
|
|
2883
|
+
"name": "noFilter",
|
|
2884
|
+
"privacy": "public",
|
|
2885
|
+
"description": "Disable filtering when grid is autoconfigured.",
|
|
2886
|
+
"attribute": "no-filter",
|
|
2887
|
+
"inheritedFrom": {
|
|
2888
|
+
"name": "CrudMixin",
|
|
2889
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2890
|
+
}
|
|
2891
|
+
},
|
|
2892
|
+
{
|
|
2893
|
+
"kind": "field",
|
|
2894
|
+
"name": "noHead",
|
|
2895
|
+
"privacy": "public",
|
|
2896
|
+
"description": "Remove grid headers when it is autoconfigured.",
|
|
2897
|
+
"attribute": "no-head",
|
|
2898
|
+
"inheritedFrom": {
|
|
2899
|
+
"name": "CrudMixin",
|
|
2900
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2901
|
+
}
|
|
2902
|
+
},
|
|
2903
|
+
{
|
|
2904
|
+
"kind": "field",
|
|
2905
|
+
"name": "noSort",
|
|
2906
|
+
"privacy": "public",
|
|
2907
|
+
"description": "Disable sorting when grid is autoconfigured.",
|
|
2908
|
+
"attribute": "no-sort",
|
|
2909
|
+
"inheritedFrom": {
|
|
2910
|
+
"name": "CrudMixin",
|
|
2911
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2912
|
+
}
|
|
2913
|
+
},
|
|
2914
|
+
{
|
|
2915
|
+
"kind": "field",
|
|
2916
|
+
"name": "noToolbar",
|
|
2917
|
+
"privacy": "public",
|
|
2918
|
+
"type": {
|
|
2919
|
+
"text": "boolean"
|
|
2920
|
+
},
|
|
2921
|
+
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
2922
|
+
"attribute": "no-toolbar",
|
|
2923
|
+
"inheritedFrom": {
|
|
2924
|
+
"name": "CrudMixin",
|
|
2925
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2926
|
+
}
|
|
2927
|
+
},
|
|
2928
|
+
{
|
|
2929
|
+
"kind": "field",
|
|
2930
|
+
"name": "size",
|
|
2931
|
+
"privacy": "public",
|
|
2932
|
+
"type": {
|
|
2933
|
+
"text": "number"
|
|
2934
|
+
},
|
|
2935
|
+
"description": "Number of items in the data set which is reported by the grid.\nTypically it reflects the number of filtered items displayed in the grid.\n\nNote: As with `<vaadin-grid>`, this property updates automatically only\nif `items` is used for data.",
|
|
2936
|
+
"attribute": "size",
|
|
2937
|
+
"inheritedFrom": {
|
|
2938
|
+
"name": "CrudMixin",
|
|
2939
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
2940
|
+
}
|
|
2941
|
+
}
|
|
2942
|
+
],
|
|
2943
|
+
"events": [
|
|
2944
|
+
{
|
|
2945
|
+
"type": {
|
|
2946
|
+
"text": "CustomEvent"
|
|
2947
|
+
},
|
|
2948
|
+
"description": "Fired when user discards edition.",
|
|
2949
|
+
"name": "cancel"
|
|
2950
|
+
},
|
|
2951
|
+
{
|
|
2952
|
+
"type": {
|
|
2953
|
+
"text": "CustomEvent"
|
|
2954
|
+
},
|
|
2955
|
+
"description": "Fired when user wants to delete item.",
|
|
2956
|
+
"name": "delete"
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
"type": {
|
|
2960
|
+
"text": "CustomEvent"
|
|
2961
|
+
},
|
|
2962
|
+
"description": "Fired when user wants to edit an existing item.",
|
|
2963
|
+
"name": "edit"
|
|
2964
|
+
},
|
|
2965
|
+
{
|
|
2966
|
+
"type": {
|
|
2967
|
+
"text": "CustomEvent"
|
|
2968
|
+
},
|
|
2969
|
+
"description": "Fired when `editedItem` property changes.",
|
|
2970
|
+
"name": "edited-item-changed"
|
|
2971
|
+
},
|
|
2972
|
+
{
|
|
2973
|
+
"type": {
|
|
2974
|
+
"text": "CustomEvent"
|
|
2975
|
+
},
|
|
2976
|
+
"description": "Fired when the `editorOpened` property changes.",
|
|
2977
|
+
"name": "editor-opened-changed"
|
|
2978
|
+
},
|
|
2979
|
+
{
|
|
2980
|
+
"type": {
|
|
2981
|
+
"text": "CustomEvent"
|
|
2982
|
+
},
|
|
2983
|
+
"description": "Fired when the `items` property changes.",
|
|
2984
|
+
"name": "items-changed"
|
|
2985
|
+
},
|
|
2986
|
+
{
|
|
2987
|
+
"type": {
|
|
2988
|
+
"text": "CustomEvent"
|
|
2989
|
+
},
|
|
2990
|
+
"description": "Fired when user wants to create a new item.",
|
|
2991
|
+
"name": "new"
|
|
2992
|
+
},
|
|
2993
|
+
{
|
|
2994
|
+
"type": {
|
|
2995
|
+
"text": "CustomEvent"
|
|
2996
|
+
},
|
|
2997
|
+
"description": "Fired when user wants to save a new or an existing item.",
|
|
2998
|
+
"name": "save"
|
|
2999
|
+
},
|
|
3000
|
+
{
|
|
3001
|
+
"type": {
|
|
3002
|
+
"text": "CustomEvent"
|
|
3003
|
+
},
|
|
3004
|
+
"description": "Fired when the `size` property changes.",
|
|
3005
|
+
"name": "size-changed"
|
|
3006
|
+
}
|
|
3007
|
+
],
|
|
3008
|
+
"mixins": [
|
|
3009
|
+
{
|
|
3010
|
+
"name": "CrudMixin",
|
|
3011
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3012
|
+
},
|
|
3013
|
+
{
|
|
3014
|
+
"name": "ElementMixin",
|
|
3015
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
3016
|
+
},
|
|
3017
|
+
{
|
|
3018
|
+
"name": "ThemableMixin",
|
|
3019
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
3020
|
+
},
|
|
3021
|
+
{
|
|
3022
|
+
"name": "PolylitMixin",
|
|
3023
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
3024
|
+
},
|
|
3025
|
+
{
|
|
3026
|
+
"name": "LumoInjectionMixin",
|
|
3027
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
3028
|
+
}
|
|
3029
|
+
],
|
|
3030
|
+
"superclass": {
|
|
3031
|
+
"name": "LitElement",
|
|
3032
|
+
"package": "lit"
|
|
3033
|
+
},
|
|
3034
|
+
"tagName": "vaadin-crud",
|
|
3035
|
+
"customElement": true,
|
|
3036
|
+
"attributes": [
|
|
3037
|
+
{
|
|
3038
|
+
"name": "data-provider",
|
|
3039
|
+
"type": {
|
|
3040
|
+
"text": "CrudDataProvider | undefined"
|
|
3041
|
+
},
|
|
3042
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n`params.pageSize` Current page size\n`params.filters` Currently applied filters\n`params.sortOrders` Currently applied sorting orders\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items",
|
|
3043
|
+
"fieldName": "dataProvider",
|
|
3044
|
+
"inheritedFrom": {
|
|
3045
|
+
"name": "CrudMixin",
|
|
3046
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3047
|
+
}
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
"name": "edit-on-click",
|
|
3051
|
+
"type": {
|
|
3052
|
+
"text": "boolean"
|
|
3053
|
+
},
|
|
3054
|
+
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
3055
|
+
"fieldName": "editOnClick",
|
|
3056
|
+
"inheritedFrom": {
|
|
3057
|
+
"name": "CrudMixin",
|
|
3058
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3059
|
+
}
|
|
3060
|
+
},
|
|
3061
|
+
{
|
|
3062
|
+
"name": "editor-opened",
|
|
3063
|
+
"type": {
|
|
3064
|
+
"text": "boolean"
|
|
3065
|
+
},
|
|
3066
|
+
"description": "Reflects the opened status of the editor.",
|
|
3067
|
+
"fieldName": "editorOpened",
|
|
3068
|
+
"inheritedFrom": {
|
|
3069
|
+
"name": "CrudMixin",
|
|
3070
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3071
|
+
}
|
|
3072
|
+
},
|
|
3073
|
+
{
|
|
3074
|
+
"name": "editor-position",
|
|
3075
|
+
"type": {
|
|
3076
|
+
"text": "!CrudEditorPosition"
|
|
3077
|
+
},
|
|
3078
|
+
"description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
|
|
3079
|
+
"fieldName": "editorPosition",
|
|
3080
|
+
"inheritedFrom": {
|
|
3081
|
+
"name": "CrudMixin",
|
|
3082
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3083
|
+
}
|
|
3084
|
+
},
|
|
3085
|
+
{
|
|
3086
|
+
"name": "exclude",
|
|
3087
|
+
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
3088
|
+
"fieldName": "exclude",
|
|
3089
|
+
"inheritedFrom": {
|
|
3090
|
+
"name": "CrudMixin",
|
|
3091
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3092
|
+
}
|
|
3093
|
+
},
|
|
3094
|
+
{
|
|
3095
|
+
"name": "include",
|
|
3096
|
+
"description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
3097
|
+
"fieldName": "include",
|
|
3098
|
+
"inheritedFrom": {
|
|
3099
|
+
"name": "CrudMixin",
|
|
3100
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3101
|
+
}
|
|
3102
|
+
},
|
|
3103
|
+
{
|
|
3104
|
+
"name": "no-filter",
|
|
3105
|
+
"description": "Disable filtering when grid is autoconfigured.",
|
|
3106
|
+
"fieldName": "noFilter",
|
|
3107
|
+
"inheritedFrom": {
|
|
3108
|
+
"name": "CrudMixin",
|
|
3109
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3110
|
+
}
|
|
3111
|
+
},
|
|
3112
|
+
{
|
|
3113
|
+
"name": "no-head",
|
|
3114
|
+
"description": "Remove grid headers when it is autoconfigured.",
|
|
3115
|
+
"fieldName": "noHead",
|
|
3116
|
+
"inheritedFrom": {
|
|
3117
|
+
"name": "CrudMixin",
|
|
3118
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3119
|
+
}
|
|
3120
|
+
},
|
|
3121
|
+
{
|
|
3122
|
+
"name": "no-sort",
|
|
3123
|
+
"description": "Disable sorting when grid is autoconfigured.",
|
|
3124
|
+
"fieldName": "noSort",
|
|
3125
|
+
"inheritedFrom": {
|
|
3126
|
+
"name": "CrudMixin",
|
|
3127
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3128
|
+
}
|
|
3129
|
+
},
|
|
3130
|
+
{
|
|
3131
|
+
"name": "no-toolbar",
|
|
3132
|
+
"type": {
|
|
3133
|
+
"text": "boolean"
|
|
3134
|
+
},
|
|
3135
|
+
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
3136
|
+
"fieldName": "noToolbar",
|
|
3137
|
+
"inheritedFrom": {
|
|
3138
|
+
"name": "CrudMixin",
|
|
3139
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3140
|
+
}
|
|
3141
|
+
},
|
|
3142
|
+
{
|
|
3143
|
+
"name": "size",
|
|
3144
|
+
"type": {
|
|
3145
|
+
"text": "number"
|
|
3146
|
+
},
|
|
3147
|
+
"description": "Number of items in the data set which is reported by the grid.\nTypically it reflects the number of filtered items displayed in the grid.\n\nNote: As with `<vaadin-grid>`, this property updates automatically only\nif `items` is used for data.",
|
|
3148
|
+
"fieldName": "size",
|
|
3149
|
+
"inheritedFrom": {
|
|
3150
|
+
"name": "CrudMixin",
|
|
3151
|
+
"module": "src/vaadin-crud-mixin.js"
|
|
3152
|
+
}
|
|
3153
|
+
}
|
|
3154
|
+
]
|
|
3155
|
+
}
|
|
3156
|
+
],
|
|
3157
|
+
"exports": [
|
|
3158
|
+
{
|
|
3159
|
+
"kind": "js",
|
|
3160
|
+
"name": "Crud",
|
|
3161
|
+
"declaration": {
|
|
3162
|
+
"name": "Crud",
|
|
3163
|
+
"module": "src/vaadin-crud.js"
|
|
3164
|
+
}
|
|
3165
|
+
}
|
|
3166
|
+
]
|
|
3167
|
+
}
|
|
3168
|
+
]
|
|
3169
|
+
}
|