@vaadin/crud 24.4.0-alpha1 → 24.4.0-dev.223e39f050
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/package.json +14 -14
- package/src/vaadin-crud.d.ts +3 -3
- package/src/vaadin-crud.js +0 -1
- package/theme/lumo/vaadin-crud.js +0 -1
- package/theme/material/vaadin-crud.js +0 -1
- package/web-types.json +0 -648
- package/web-types.lit.json +0 -307
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/crud",
|
|
3
|
-
"version": "24.4.0-
|
|
3
|
+
"version": "24.4.0-dev.223e39f050",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -37,18 +37,18 @@
|
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
39
39
|
"@polymer/polymer": "^3.0.0",
|
|
40
|
-
"@vaadin/a11y-base": "24.4.0-
|
|
41
|
-
"@vaadin/button": "24.4.0-
|
|
42
|
-
"@vaadin/component-base": "24.4.0-
|
|
43
|
-
"@vaadin/confirm-dialog": "24.4.0-
|
|
44
|
-
"@vaadin/dialog": "24.4.0-
|
|
45
|
-
"@vaadin/form-layout": "24.4.0-
|
|
46
|
-
"@vaadin/grid": "24.4.0-
|
|
47
|
-
"@vaadin/overlay": "24.4.0-
|
|
48
|
-
"@vaadin/text-field": "24.4.0-
|
|
49
|
-
"@vaadin/vaadin-lumo-styles": "24.4.0-
|
|
50
|
-
"@vaadin/vaadin-material-styles": "24.4.0-
|
|
51
|
-
"@vaadin/vaadin-themable-mixin": "24.4.0-
|
|
40
|
+
"@vaadin/a11y-base": "24.4.0-dev.223e39f050",
|
|
41
|
+
"@vaadin/button": "24.4.0-dev.223e39f050",
|
|
42
|
+
"@vaadin/component-base": "24.4.0-dev.223e39f050",
|
|
43
|
+
"@vaadin/confirm-dialog": "24.4.0-dev.223e39f050",
|
|
44
|
+
"@vaadin/dialog": "24.4.0-dev.223e39f050",
|
|
45
|
+
"@vaadin/form-layout": "24.4.0-dev.223e39f050",
|
|
46
|
+
"@vaadin/grid": "24.4.0-dev.223e39f050",
|
|
47
|
+
"@vaadin/overlay": "24.4.0-dev.223e39f050",
|
|
48
|
+
"@vaadin/text-field": "24.4.0-dev.223e39f050",
|
|
49
|
+
"@vaadin/vaadin-lumo-styles": "24.4.0-dev.223e39f050",
|
|
50
|
+
"@vaadin/vaadin-material-styles": "24.4.0-dev.223e39f050",
|
|
51
|
+
"@vaadin/vaadin-themable-mixin": "24.4.0-dev.223e39f050"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
54
|
"@esm-bundle/chai": "^4.3.4",
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"web-types.json",
|
|
61
61
|
"web-types.lit.json"
|
|
62
62
|
],
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "5e2e3bfc811c95aed9354235fab93fdbf43eb354"
|
|
64
64
|
}
|
package/src/vaadin-crud.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
*/
|
|
11
11
|
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
|
|
12
12
|
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
|
|
13
|
-
import type { GridFilterDefinition, GridSorterDefinition } from '@vaadin/grid/src/vaadin-grid.js';
|
|
13
|
+
import type { GridDefaultItem, GridFilterDefinition, GridSorterDefinition } from '@vaadin/grid/src/vaadin-grid.js';
|
|
14
14
|
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
|
|
15
15
|
|
|
16
16
|
export type CrudDataProviderCallback<T> = (items: T[], size?: number) => void;
|
|
@@ -262,7 +262,7 @@ export type CrudEventMap<T> = CrudCustomEventMap<T> & HTMLElementEventMap;
|
|
|
262
262
|
* @fires {CustomEvent} save - Fired when user wants to save a new or an existing item.
|
|
263
263
|
* @fires {CustomEvent} cancel - Fired when user discards edition.
|
|
264
264
|
*/
|
|
265
|
-
declare class Crud<Item> extends ControllerMixin(ElementMixin(ThemableMixin(HTMLElement))) {
|
|
265
|
+
declare class Crud<Item = GridDefaultItem> extends ControllerMixin(ElementMixin(ThemableMixin(HTMLElement))) {
|
|
266
266
|
/**
|
|
267
267
|
* An array containing the items which will be stamped to the column template instances.
|
|
268
268
|
*/
|
|
@@ -419,7 +419,7 @@ declare class Crud<Item> extends ControllerMixin(ElementMixin(ThemableMixin(HTML
|
|
|
419
419
|
|
|
420
420
|
declare global {
|
|
421
421
|
interface HTMLElementTagNameMap {
|
|
422
|
-
'vaadin-crud': Crud<
|
|
422
|
+
'vaadin-crud': Crud<GridDefaultItem>;
|
|
423
423
|
}
|
|
424
424
|
}
|
|
425
425
|
|
package/src/vaadin-crud.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import '@vaadin/button/theme/lumo/vaadin-button.js';
|
|
2
2
|
import '@vaadin/confirm-dialog/theme/lumo/vaadin-confirm-dialog.js';
|
|
3
|
-
import '@vaadin/dialog/theme/lumo/vaadin-dialog.js';
|
|
4
3
|
import '@vaadin/form-layout/theme/lumo/vaadin-form-layout.js';
|
|
5
4
|
import '@vaadin/grid/theme/lumo/vaadin-grid.js';
|
|
6
5
|
import '@vaadin/grid/theme/lumo/vaadin-grid-sorter.js';
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import '@vaadin/button/theme/material/vaadin-button.js';
|
|
2
2
|
import '@vaadin/confirm-dialog/theme/material/vaadin-confirm-dialog.js';
|
|
3
|
-
import '@vaadin/dialog/theme/material/vaadin-dialog.js';
|
|
4
3
|
import '@vaadin/form-layout/theme/material/vaadin-form-layout.js';
|
|
5
4
|
import '@vaadin/grid/theme/material/vaadin-grid.js';
|
|
6
5
|
import '@vaadin/grid/theme/material/vaadin-grid-sorter.js';
|
package/web-types.json
DELETED
|
@@ -1,648 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://json.schemastore.org/web-types",
|
|
3
|
-
"name": "@vaadin/crud",
|
|
4
|
-
"version": "24.4.0-alpha1",
|
|
5
|
-
"description-markup": "markdown",
|
|
6
|
-
"contributions": {
|
|
7
|
-
"html": {
|
|
8
|
-
"elements": [
|
|
9
|
-
{
|
|
10
|
-
"name": "vaadin-crud-edit",
|
|
11
|
-
"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.",
|
|
12
|
-
"attributes": [
|
|
13
|
-
{
|
|
14
|
-
"name": "theme",
|
|
15
|
-
"description": "The theme variants to apply to the component.",
|
|
16
|
-
"value": {
|
|
17
|
-
"type": [
|
|
18
|
-
"string",
|
|
19
|
-
"null",
|
|
20
|
-
"undefined"
|
|
21
|
-
]
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
],
|
|
25
|
-
"js": {
|
|
26
|
-
"properties": [],
|
|
27
|
-
"events": [
|
|
28
|
-
{
|
|
29
|
-
"name": "edit",
|
|
30
|
-
"description": "Fired when user on the icon."
|
|
31
|
-
}
|
|
32
|
-
]
|
|
33
|
-
}
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"name": "vaadin-crud-edit-column",
|
|
37
|
-
"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 items=\"[[items]]\">\n <vaadin-crud-edit-column></vaadin-crud-edit-column>\n\n <vaadin-grid-column>\n ...\n```",
|
|
38
|
-
"attributes": [
|
|
39
|
-
{
|
|
40
|
-
"name": "resizable",
|
|
41
|
-
"description": "When set to true, the column is user-resizable.",
|
|
42
|
-
"value": {
|
|
43
|
-
"type": [
|
|
44
|
-
"boolean",
|
|
45
|
-
"null",
|
|
46
|
-
"undefined"
|
|
47
|
-
]
|
|
48
|
-
}
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"name": "frozen",
|
|
52
|
-
"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.",
|
|
53
|
-
"value": {
|
|
54
|
-
"type": [
|
|
55
|
-
"boolean"
|
|
56
|
-
]
|
|
57
|
-
}
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
"name": "frozen-to-end",
|
|
61
|
-
"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.",
|
|
62
|
-
"value": {
|
|
63
|
-
"type": [
|
|
64
|
-
"boolean"
|
|
65
|
-
]
|
|
66
|
-
}
|
|
67
|
-
},
|
|
68
|
-
{
|
|
69
|
-
"name": "row-header",
|
|
70
|
-
"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.",
|
|
71
|
-
"value": {
|
|
72
|
-
"type": [
|
|
73
|
-
"boolean"
|
|
74
|
-
]
|
|
75
|
-
}
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
"name": "hidden",
|
|
79
|
-
"description": "When set to true, the cells for this column are hidden.",
|
|
80
|
-
"value": {
|
|
81
|
-
"type": [
|
|
82
|
-
"boolean",
|
|
83
|
-
"null",
|
|
84
|
-
"undefined"
|
|
85
|
-
]
|
|
86
|
-
}
|
|
87
|
-
},
|
|
88
|
-
{
|
|
89
|
-
"name": "header",
|
|
90
|
-
"description": "Text content to display in the header cell of the column.",
|
|
91
|
-
"value": {
|
|
92
|
-
"type": [
|
|
93
|
-
"string",
|
|
94
|
-
"null",
|
|
95
|
-
"undefined"
|
|
96
|
-
]
|
|
97
|
-
}
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"name": "text-align",
|
|
101
|
-
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
102
|
-
"value": {
|
|
103
|
-
"type": [
|
|
104
|
-
"GridColumnTextAlign",
|
|
105
|
-
"null",
|
|
106
|
-
"undefined"
|
|
107
|
-
]
|
|
108
|
-
}
|
|
109
|
-
},
|
|
110
|
-
{
|
|
111
|
-
"name": "header-part-name",
|
|
112
|
-
"description": "Custom part name for the header cell.",
|
|
113
|
-
"value": {
|
|
114
|
-
"type": [
|
|
115
|
-
"string",
|
|
116
|
-
"null",
|
|
117
|
-
"undefined"
|
|
118
|
-
]
|
|
119
|
-
}
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
"name": "footer-part-name",
|
|
123
|
-
"description": "Custom part name for the footer cell.",
|
|
124
|
-
"value": {
|
|
125
|
-
"type": [
|
|
126
|
-
"string",
|
|
127
|
-
"null",
|
|
128
|
-
"undefined"
|
|
129
|
-
]
|
|
130
|
-
}
|
|
131
|
-
},
|
|
132
|
-
{
|
|
133
|
-
"name": "width",
|
|
134
|
-
"description": "Width of the cells for this column.",
|
|
135
|
-
"value": {
|
|
136
|
-
"type": [
|
|
137
|
-
"string",
|
|
138
|
-
"null",
|
|
139
|
-
"undefined"
|
|
140
|
-
]
|
|
141
|
-
}
|
|
142
|
-
},
|
|
143
|
-
{
|
|
144
|
-
"name": "flex-grow",
|
|
145
|
-
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
146
|
-
"value": {
|
|
147
|
-
"type": [
|
|
148
|
-
"number"
|
|
149
|
-
]
|
|
150
|
-
}
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"name": "path",
|
|
154
|
-
"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.",
|
|
155
|
-
"value": {
|
|
156
|
-
"type": [
|
|
157
|
-
"string",
|
|
158
|
-
"null",
|
|
159
|
-
"undefined"
|
|
160
|
-
]
|
|
161
|
-
}
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
"name": "auto-width",
|
|
165
|
-
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
166
|
-
"value": {
|
|
167
|
-
"type": [
|
|
168
|
-
"boolean"
|
|
169
|
-
]
|
|
170
|
-
}
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
"name": "aria-label",
|
|
174
|
-
"description": "The arial-label for the edit button",
|
|
175
|
-
"value": {
|
|
176
|
-
"type": [
|
|
177
|
-
"string",
|
|
178
|
-
"null",
|
|
179
|
-
"undefined"
|
|
180
|
-
]
|
|
181
|
-
}
|
|
182
|
-
},
|
|
183
|
-
{
|
|
184
|
-
"name": "theme",
|
|
185
|
-
"description": "The theme variants to apply to the component.",
|
|
186
|
-
"value": {
|
|
187
|
-
"type": [
|
|
188
|
-
"string",
|
|
189
|
-
"null",
|
|
190
|
-
"undefined"
|
|
191
|
-
]
|
|
192
|
-
}
|
|
193
|
-
}
|
|
194
|
-
],
|
|
195
|
-
"js": {
|
|
196
|
-
"properties": [
|
|
197
|
-
{
|
|
198
|
-
"name": "resizable",
|
|
199
|
-
"description": "When set to true, the column is user-resizable.",
|
|
200
|
-
"value": {
|
|
201
|
-
"type": [
|
|
202
|
-
"boolean",
|
|
203
|
-
"null",
|
|
204
|
-
"undefined"
|
|
205
|
-
]
|
|
206
|
-
}
|
|
207
|
-
},
|
|
208
|
-
{
|
|
209
|
-
"name": "frozen",
|
|
210
|
-
"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.",
|
|
211
|
-
"value": {
|
|
212
|
-
"type": [
|
|
213
|
-
"boolean"
|
|
214
|
-
]
|
|
215
|
-
}
|
|
216
|
-
},
|
|
217
|
-
{
|
|
218
|
-
"name": "frozenToEnd",
|
|
219
|
-
"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.",
|
|
220
|
-
"value": {
|
|
221
|
-
"type": [
|
|
222
|
-
"boolean"
|
|
223
|
-
]
|
|
224
|
-
}
|
|
225
|
-
},
|
|
226
|
-
{
|
|
227
|
-
"name": "rowHeader",
|
|
228
|
-
"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.",
|
|
229
|
-
"value": {
|
|
230
|
-
"type": [
|
|
231
|
-
"boolean"
|
|
232
|
-
]
|
|
233
|
-
}
|
|
234
|
-
},
|
|
235
|
-
{
|
|
236
|
-
"name": "hidden",
|
|
237
|
-
"description": "When set to true, the cells for this column are hidden.",
|
|
238
|
-
"value": {
|
|
239
|
-
"type": [
|
|
240
|
-
"boolean",
|
|
241
|
-
"null",
|
|
242
|
-
"undefined"
|
|
243
|
-
]
|
|
244
|
-
}
|
|
245
|
-
},
|
|
246
|
-
{
|
|
247
|
-
"name": "header",
|
|
248
|
-
"description": "Text content to display in the header cell of the column.",
|
|
249
|
-
"value": {
|
|
250
|
-
"type": [
|
|
251
|
-
"string",
|
|
252
|
-
"null",
|
|
253
|
-
"undefined"
|
|
254
|
-
]
|
|
255
|
-
}
|
|
256
|
-
},
|
|
257
|
-
{
|
|
258
|
-
"name": "textAlign",
|
|
259
|
-
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
260
|
-
"value": {
|
|
261
|
-
"type": [
|
|
262
|
-
"GridColumnTextAlign",
|
|
263
|
-
"null",
|
|
264
|
-
"undefined"
|
|
265
|
-
]
|
|
266
|
-
}
|
|
267
|
-
},
|
|
268
|
-
{
|
|
269
|
-
"name": "headerPartName",
|
|
270
|
-
"description": "Custom part name for the header cell.",
|
|
271
|
-
"value": {
|
|
272
|
-
"type": [
|
|
273
|
-
"string",
|
|
274
|
-
"null",
|
|
275
|
-
"undefined"
|
|
276
|
-
]
|
|
277
|
-
}
|
|
278
|
-
},
|
|
279
|
-
{
|
|
280
|
-
"name": "footerPartName",
|
|
281
|
-
"description": "Custom part name for the footer cell.",
|
|
282
|
-
"value": {
|
|
283
|
-
"type": [
|
|
284
|
-
"string",
|
|
285
|
-
"null",
|
|
286
|
-
"undefined"
|
|
287
|
-
]
|
|
288
|
-
}
|
|
289
|
-
},
|
|
290
|
-
{
|
|
291
|
-
"name": "headerRenderer",
|
|
292
|
-
"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.",
|
|
293
|
-
"value": {
|
|
294
|
-
"type": [
|
|
295
|
-
"GridHeaderFooterRenderer",
|
|
296
|
-
"null",
|
|
297
|
-
"undefined"
|
|
298
|
-
]
|
|
299
|
-
}
|
|
300
|
-
},
|
|
301
|
-
{
|
|
302
|
-
"name": "footerRenderer",
|
|
303
|
-
"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.",
|
|
304
|
-
"value": {
|
|
305
|
-
"type": [
|
|
306
|
-
"GridHeaderFooterRenderer",
|
|
307
|
-
"null",
|
|
308
|
-
"undefined"
|
|
309
|
-
]
|
|
310
|
-
}
|
|
311
|
-
},
|
|
312
|
-
{
|
|
313
|
-
"name": "renderer",
|
|
314
|
-
"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.",
|
|
315
|
-
"value": {
|
|
316
|
-
"type": [
|
|
317
|
-
"GridBodyRenderer",
|
|
318
|
-
"null",
|
|
319
|
-
"undefined"
|
|
320
|
-
]
|
|
321
|
-
}
|
|
322
|
-
},
|
|
323
|
-
{
|
|
324
|
-
"name": "path",
|
|
325
|
-
"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.",
|
|
326
|
-
"value": {
|
|
327
|
-
"type": [
|
|
328
|
-
"string",
|
|
329
|
-
"null",
|
|
330
|
-
"undefined"
|
|
331
|
-
]
|
|
332
|
-
}
|
|
333
|
-
},
|
|
334
|
-
{
|
|
335
|
-
"name": "autoWidth",
|
|
336
|
-
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
337
|
-
"value": {
|
|
338
|
-
"type": [
|
|
339
|
-
"boolean"
|
|
340
|
-
]
|
|
341
|
-
}
|
|
342
|
-
},
|
|
343
|
-
{
|
|
344
|
-
"name": "ariaLabel",
|
|
345
|
-
"description": "The arial-label for the edit button",
|
|
346
|
-
"value": {
|
|
347
|
-
"type": [
|
|
348
|
-
"string",
|
|
349
|
-
"null",
|
|
350
|
-
"undefined"
|
|
351
|
-
]
|
|
352
|
-
}
|
|
353
|
-
}
|
|
354
|
-
],
|
|
355
|
-
"events": []
|
|
356
|
-
}
|
|
357
|
-
},
|
|
358
|
-
{
|
|
359
|
-
"name": "vaadin-crud",
|
|
360
|
-
"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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/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```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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/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>`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud-edit-column)\n- `<vaadin-crud-grid>` - can be replaced with custom [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-grid)\n- `<vaadin-crud-form>` - can be replaced with custom [`<vaadin-form-layout>`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-form-layout)\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`toolbar` | Toolbar container at the bottom. By default it contains the the `new` button\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.",
|
|
361
|
-
"attributes": [
|
|
362
|
-
{
|
|
363
|
-
"name": "editor-position",
|
|
364
|
-
"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)",
|
|
365
|
-
"value": {
|
|
366
|
-
"type": [
|
|
367
|
-
"CrudEditorPosition"
|
|
368
|
-
]
|
|
369
|
-
}
|
|
370
|
-
},
|
|
371
|
-
{
|
|
372
|
-
"name": "edit-on-click",
|
|
373
|
-
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
374
|
-
"value": {
|
|
375
|
-
"type": [
|
|
376
|
-
"boolean"
|
|
377
|
-
]
|
|
378
|
-
}
|
|
379
|
-
},
|
|
380
|
-
{
|
|
381
|
-
"name": "no-filter",
|
|
382
|
-
"description": "Disable filtering when grid is autoconfigured.",
|
|
383
|
-
"value": {
|
|
384
|
-
"type": [
|
|
385
|
-
"boolean",
|
|
386
|
-
"null",
|
|
387
|
-
"undefined"
|
|
388
|
-
]
|
|
389
|
-
}
|
|
390
|
-
},
|
|
391
|
-
{
|
|
392
|
-
"name": "no-sort",
|
|
393
|
-
"description": "Disable sorting when grid is autoconfigured.",
|
|
394
|
-
"value": {
|
|
395
|
-
"type": [
|
|
396
|
-
"boolean",
|
|
397
|
-
"null",
|
|
398
|
-
"undefined"
|
|
399
|
-
]
|
|
400
|
-
}
|
|
401
|
-
},
|
|
402
|
-
{
|
|
403
|
-
"name": "no-head",
|
|
404
|
-
"description": "Remove grid headers when it is autoconfigured.",
|
|
405
|
-
"value": {
|
|
406
|
-
"type": [
|
|
407
|
-
"boolean",
|
|
408
|
-
"null",
|
|
409
|
-
"undefined"
|
|
410
|
-
]
|
|
411
|
-
}
|
|
412
|
-
},
|
|
413
|
-
{
|
|
414
|
-
"name": "include",
|
|
415
|
-
"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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
416
|
-
"value": {
|
|
417
|
-
"type": [
|
|
418
|
-
"string",
|
|
419
|
-
"null",
|
|
420
|
-
"undefined"
|
|
421
|
-
]
|
|
422
|
-
}
|
|
423
|
-
},
|
|
424
|
-
{
|
|
425
|
-
"name": "exclude",
|
|
426
|
-
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
427
|
-
"value": {
|
|
428
|
-
"type": [
|
|
429
|
-
"string",
|
|
430
|
-
"null",
|
|
431
|
-
"undefined"
|
|
432
|
-
]
|
|
433
|
-
}
|
|
434
|
-
},
|
|
435
|
-
{
|
|
436
|
-
"name": "editor-opened",
|
|
437
|
-
"description": "Reflects the opened status of the editor.",
|
|
438
|
-
"value": {
|
|
439
|
-
"type": [
|
|
440
|
-
"boolean",
|
|
441
|
-
"null",
|
|
442
|
-
"undefined"
|
|
443
|
-
]
|
|
444
|
-
}
|
|
445
|
-
},
|
|
446
|
-
{
|
|
447
|
-
"name": "no-toolbar",
|
|
448
|
-
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
449
|
-
"value": {
|
|
450
|
-
"type": [
|
|
451
|
-
"boolean",
|
|
452
|
-
"null",
|
|
453
|
-
"undefined"
|
|
454
|
-
]
|
|
455
|
-
}
|
|
456
|
-
},
|
|
457
|
-
{
|
|
458
|
-
"name": "theme",
|
|
459
|
-
"description": "The theme variants to apply to the component.",
|
|
460
|
-
"value": {
|
|
461
|
-
"type": [
|
|
462
|
-
"string",
|
|
463
|
-
"null",
|
|
464
|
-
"undefined"
|
|
465
|
-
]
|
|
466
|
-
}
|
|
467
|
-
}
|
|
468
|
-
],
|
|
469
|
-
"js": {
|
|
470
|
-
"properties": [
|
|
471
|
-
{
|
|
472
|
-
"name": "items",
|
|
473
|
-
"description": "An array containing the items which will be stamped to the column template instances.",
|
|
474
|
-
"value": {
|
|
475
|
-
"type": [
|
|
476
|
-
"Array.<unknown>",
|
|
477
|
-
"undefined"
|
|
478
|
-
]
|
|
479
|
-
}
|
|
480
|
-
},
|
|
481
|
-
{
|
|
482
|
-
"name": "editedItem",
|
|
483
|
-
"description": "The item being edited in the dialog.",
|
|
484
|
-
"value": {
|
|
485
|
-
"type": [
|
|
486
|
-
"unknown"
|
|
487
|
-
]
|
|
488
|
-
}
|
|
489
|
-
},
|
|
490
|
-
{
|
|
491
|
-
"name": "editorPosition",
|
|
492
|
-
"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)",
|
|
493
|
-
"value": {
|
|
494
|
-
"type": [
|
|
495
|
-
"CrudEditorPosition"
|
|
496
|
-
]
|
|
497
|
-
}
|
|
498
|
-
},
|
|
499
|
-
{
|
|
500
|
-
"name": "editOnClick",
|
|
501
|
-
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
502
|
-
"value": {
|
|
503
|
-
"type": [
|
|
504
|
-
"boolean"
|
|
505
|
-
]
|
|
506
|
-
}
|
|
507
|
-
},
|
|
508
|
-
{
|
|
509
|
-
"name": "dataProvider",
|
|
510
|
-
"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",
|
|
511
|
-
"value": {
|
|
512
|
-
"type": [
|
|
513
|
-
"CrudDataProvider",
|
|
514
|
-
"undefined"
|
|
515
|
-
]
|
|
516
|
-
}
|
|
517
|
-
},
|
|
518
|
-
{
|
|
519
|
-
"name": "noFilter",
|
|
520
|
-
"description": "Disable filtering when grid is autoconfigured.",
|
|
521
|
-
"value": {
|
|
522
|
-
"type": [
|
|
523
|
-
"boolean",
|
|
524
|
-
"null",
|
|
525
|
-
"undefined"
|
|
526
|
-
]
|
|
527
|
-
}
|
|
528
|
-
},
|
|
529
|
-
{
|
|
530
|
-
"name": "noSort",
|
|
531
|
-
"description": "Disable sorting when grid is autoconfigured.",
|
|
532
|
-
"value": {
|
|
533
|
-
"type": [
|
|
534
|
-
"boolean",
|
|
535
|
-
"null",
|
|
536
|
-
"undefined"
|
|
537
|
-
]
|
|
538
|
-
}
|
|
539
|
-
},
|
|
540
|
-
{
|
|
541
|
-
"name": "noHead",
|
|
542
|
-
"description": "Remove grid headers when it is autoconfigured.",
|
|
543
|
-
"value": {
|
|
544
|
-
"type": [
|
|
545
|
-
"boolean",
|
|
546
|
-
"null",
|
|
547
|
-
"undefined"
|
|
548
|
-
]
|
|
549
|
-
}
|
|
550
|
-
},
|
|
551
|
-
{
|
|
552
|
-
"name": "include",
|
|
553
|
-
"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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
554
|
-
"value": {
|
|
555
|
-
"type": [
|
|
556
|
-
"string",
|
|
557
|
-
"null",
|
|
558
|
-
"undefined"
|
|
559
|
-
]
|
|
560
|
-
}
|
|
561
|
-
},
|
|
562
|
-
{
|
|
563
|
-
"name": "exclude",
|
|
564
|
-
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
565
|
-
"value": {
|
|
566
|
-
"type": [
|
|
567
|
-
"string",
|
|
568
|
-
"null",
|
|
569
|
-
"undefined"
|
|
570
|
-
]
|
|
571
|
-
}
|
|
572
|
-
},
|
|
573
|
-
{
|
|
574
|
-
"name": "editorOpened",
|
|
575
|
-
"description": "Reflects the opened status of the editor.",
|
|
576
|
-
"value": {
|
|
577
|
-
"type": [
|
|
578
|
-
"boolean",
|
|
579
|
-
"null",
|
|
580
|
-
"undefined"
|
|
581
|
-
]
|
|
582
|
-
}
|
|
583
|
-
},
|
|
584
|
-
{
|
|
585
|
-
"name": "noToolbar",
|
|
586
|
-
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
587
|
-
"value": {
|
|
588
|
-
"type": [
|
|
589
|
-
"boolean",
|
|
590
|
-
"null",
|
|
591
|
-
"undefined"
|
|
592
|
-
]
|
|
593
|
-
}
|
|
594
|
-
},
|
|
595
|
-
{
|
|
596
|
-
"name": "i18n",
|
|
597
|
-
"description": "The object used to localize this component.\nFor changing the default localization, change the entire\n_i18n_ object or just the property you want to modify.\n\nThe object has the following JSON structure and default values:\n\n```\n{\n newItem: 'New item',\n editItem: 'Edit item',\n saveItem: 'Save',\n cancel: 'Cancel',\n deleteItem: 'Delete...',\n editLabel: 'Edit',\n confirm: {\n delete: {\n title: 'Confirm delete',\n content: 'Are you sure you want to delete the selected item? This action cannot be undone.',\n button: {\n confirm: 'Delete',\n dismiss: 'Cancel'\n }\n },\n cancel: {\n title: 'Unsaved changes',\n content: 'There are unsaved modifications to the item.',\n button: {\n confirm: 'Discard',\n dismiss: 'Continue editing'\n }\n }\n }\n}\n```",
|
|
598
|
-
"value": {
|
|
599
|
-
"type": [
|
|
600
|
-
"CrudI18n"
|
|
601
|
-
]
|
|
602
|
-
}
|
|
603
|
-
}
|
|
604
|
-
],
|
|
605
|
-
"events": [
|
|
606
|
-
{
|
|
607
|
-
"name": "cancel",
|
|
608
|
-
"description": "Fired when user discards edition. If the default is prevented, then\nno action is performed, user is responsible to close dialog and reset\nitem and grid."
|
|
609
|
-
},
|
|
610
|
-
{
|
|
611
|
-
"name": "delete",
|
|
612
|
-
"description": "Fired when user wants to delete item. If the default is prevented, then\nno action is performed, items array is not modified nor dialog closed"
|
|
613
|
-
},
|
|
614
|
-
{
|
|
615
|
-
"name": "edit",
|
|
616
|
-
"description": "Fired when user wants to edit an existing item. If the default is prevented, then\na new item is not assigned to the form, giving that responsibility to the app, though\ndialog is always opened."
|
|
617
|
-
},
|
|
618
|
-
{
|
|
619
|
-
"name": "new",
|
|
620
|
-
"description": "Fired when user wants to create a new item."
|
|
621
|
-
},
|
|
622
|
-
{
|
|
623
|
-
"name": "save",
|
|
624
|
-
"description": "Fired when user wants to save a new or an existing item. If the default is prevented, then\nno action is performed, items array is not modified nor dialog closed"
|
|
625
|
-
},
|
|
626
|
-
{
|
|
627
|
-
"name": "items-changed",
|
|
628
|
-
"description": "Fired when the `items` property changes."
|
|
629
|
-
},
|
|
630
|
-
{
|
|
631
|
-
"name": "edited-item-changed",
|
|
632
|
-
"description": "Fired when the `editedItem` property changes."
|
|
633
|
-
},
|
|
634
|
-
{
|
|
635
|
-
"name": "editor-opened-changed",
|
|
636
|
-
"description": "Fired when the `editorOpened` property changes."
|
|
637
|
-
},
|
|
638
|
-
{
|
|
639
|
-
"name": "size-changed",
|
|
640
|
-
"description": "Fired when the `size` property changes."
|
|
641
|
-
}
|
|
642
|
-
]
|
|
643
|
-
}
|
|
644
|
-
}
|
|
645
|
-
]
|
|
646
|
-
}
|
|
647
|
-
}
|
|
648
|
-
}
|
package/web-types.lit.json
DELETED
|
@@ -1,307 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://json.schemastore.org/web-types",
|
|
3
|
-
"name": "@vaadin/crud",
|
|
4
|
-
"version": "24.4.0-alpha1",
|
|
5
|
-
"description-markup": "markdown",
|
|
6
|
-
"framework": "lit",
|
|
7
|
-
"framework-config": {
|
|
8
|
-
"enable-when": {
|
|
9
|
-
"node-packages": [
|
|
10
|
-
"lit"
|
|
11
|
-
]
|
|
12
|
-
}
|
|
13
|
-
},
|
|
14
|
-
"contributions": {
|
|
15
|
-
"html": {
|
|
16
|
-
"elements": [
|
|
17
|
-
{
|
|
18
|
-
"name": "vaadin-crud-edit",
|
|
19
|
-
"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.",
|
|
20
|
-
"extension": true,
|
|
21
|
-
"attributes": [
|
|
22
|
-
{
|
|
23
|
-
"name": "@edit",
|
|
24
|
-
"description": "Fired when user on the icon.",
|
|
25
|
-
"value": {
|
|
26
|
-
"kind": "expression"
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
]
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"name": "vaadin-crud-edit-column",
|
|
33
|
-
"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 items=\"[[items]]\">\n <vaadin-crud-edit-column></vaadin-crud-edit-column>\n\n <vaadin-grid-column>\n ...\n```",
|
|
34
|
-
"extension": true,
|
|
35
|
-
"attributes": [
|
|
36
|
-
{
|
|
37
|
-
"name": "?resizable",
|
|
38
|
-
"description": "When set to true, the column is user-resizable.",
|
|
39
|
-
"value": {
|
|
40
|
-
"kind": "expression"
|
|
41
|
-
}
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
"name": "?frozen",
|
|
45
|
-
"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.",
|
|
46
|
-
"value": {
|
|
47
|
-
"kind": "expression"
|
|
48
|
-
}
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"name": "?frozenToEnd",
|
|
52
|
-
"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.",
|
|
53
|
-
"value": {
|
|
54
|
-
"kind": "expression"
|
|
55
|
-
}
|
|
56
|
-
},
|
|
57
|
-
{
|
|
58
|
-
"name": "?rowHeader",
|
|
59
|
-
"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.",
|
|
60
|
-
"value": {
|
|
61
|
-
"kind": "expression"
|
|
62
|
-
}
|
|
63
|
-
},
|
|
64
|
-
{
|
|
65
|
-
"name": "?hidden",
|
|
66
|
-
"description": "When set to true, the cells for this column are hidden.",
|
|
67
|
-
"value": {
|
|
68
|
-
"kind": "expression"
|
|
69
|
-
}
|
|
70
|
-
},
|
|
71
|
-
{
|
|
72
|
-
"name": "?autoWidth",
|
|
73
|
-
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
74
|
-
"value": {
|
|
75
|
-
"kind": "expression"
|
|
76
|
-
}
|
|
77
|
-
},
|
|
78
|
-
{
|
|
79
|
-
"name": ".header",
|
|
80
|
-
"description": "Text content to display in the header cell of the column.",
|
|
81
|
-
"value": {
|
|
82
|
-
"kind": "expression"
|
|
83
|
-
}
|
|
84
|
-
},
|
|
85
|
-
{
|
|
86
|
-
"name": ".textAlign",
|
|
87
|
-
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
88
|
-
"value": {
|
|
89
|
-
"kind": "expression"
|
|
90
|
-
}
|
|
91
|
-
},
|
|
92
|
-
{
|
|
93
|
-
"name": ".headerPartName",
|
|
94
|
-
"description": "Custom part name for the header cell.",
|
|
95
|
-
"value": {
|
|
96
|
-
"kind": "expression"
|
|
97
|
-
}
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"name": ".footerPartName",
|
|
101
|
-
"description": "Custom part name for the footer cell.",
|
|
102
|
-
"value": {
|
|
103
|
-
"kind": "expression"
|
|
104
|
-
}
|
|
105
|
-
},
|
|
106
|
-
{
|
|
107
|
-
"name": ".headerRenderer",
|
|
108
|
-
"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.",
|
|
109
|
-
"value": {
|
|
110
|
-
"kind": "expression"
|
|
111
|
-
}
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
"name": ".footerRenderer",
|
|
115
|
-
"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.",
|
|
116
|
-
"value": {
|
|
117
|
-
"kind": "expression"
|
|
118
|
-
}
|
|
119
|
-
},
|
|
120
|
-
{
|
|
121
|
-
"name": ".renderer",
|
|
122
|
-
"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.",
|
|
123
|
-
"value": {
|
|
124
|
-
"kind": "expression"
|
|
125
|
-
}
|
|
126
|
-
},
|
|
127
|
-
{
|
|
128
|
-
"name": ".path",
|
|
129
|
-
"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.",
|
|
130
|
-
"value": {
|
|
131
|
-
"kind": "expression"
|
|
132
|
-
}
|
|
133
|
-
},
|
|
134
|
-
{
|
|
135
|
-
"name": ".ariaLabel",
|
|
136
|
-
"description": "The arial-label for the edit button",
|
|
137
|
-
"value": {
|
|
138
|
-
"kind": "expression"
|
|
139
|
-
}
|
|
140
|
-
}
|
|
141
|
-
]
|
|
142
|
-
},
|
|
143
|
-
{
|
|
144
|
-
"name": "vaadin-crud",
|
|
145
|
-
"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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/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```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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/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>`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud-edit-column)\n- `<vaadin-crud-grid>` - can be replaced with custom [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-grid)\n- `<vaadin-crud-form>` - can be replaced with custom [`<vaadin-form-layout>`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-form-layout)\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`toolbar` | Toolbar container at the bottom. By default it contains the the `new` button\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.",
|
|
146
|
-
"extension": true,
|
|
147
|
-
"attributes": [
|
|
148
|
-
{
|
|
149
|
-
"name": "?editOnClick",
|
|
150
|
-
"description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.",
|
|
151
|
-
"value": {
|
|
152
|
-
"kind": "expression"
|
|
153
|
-
}
|
|
154
|
-
},
|
|
155
|
-
{
|
|
156
|
-
"name": "?noFilter",
|
|
157
|
-
"description": "Disable filtering when grid is autoconfigured.",
|
|
158
|
-
"value": {
|
|
159
|
-
"kind": "expression"
|
|
160
|
-
}
|
|
161
|
-
},
|
|
162
|
-
{
|
|
163
|
-
"name": "?noSort",
|
|
164
|
-
"description": "Disable sorting when grid is autoconfigured.",
|
|
165
|
-
"value": {
|
|
166
|
-
"kind": "expression"
|
|
167
|
-
}
|
|
168
|
-
},
|
|
169
|
-
{
|
|
170
|
-
"name": "?noHead",
|
|
171
|
-
"description": "Remove grid headers when it is autoconfigured.",
|
|
172
|
-
"value": {
|
|
173
|
-
"kind": "expression"
|
|
174
|
-
}
|
|
175
|
-
},
|
|
176
|
-
{
|
|
177
|
-
"name": "?editorOpened",
|
|
178
|
-
"description": "Reflects the opened status of the editor.",
|
|
179
|
-
"value": {
|
|
180
|
-
"kind": "expression"
|
|
181
|
-
}
|
|
182
|
-
},
|
|
183
|
-
{
|
|
184
|
-
"name": "?noToolbar",
|
|
185
|
-
"description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.",
|
|
186
|
-
"value": {
|
|
187
|
-
"kind": "expression"
|
|
188
|
-
}
|
|
189
|
-
},
|
|
190
|
-
{
|
|
191
|
-
"name": ".items",
|
|
192
|
-
"description": "An array containing the items which will be stamped to the column template instances.",
|
|
193
|
-
"value": {
|
|
194
|
-
"kind": "expression"
|
|
195
|
-
}
|
|
196
|
-
},
|
|
197
|
-
{
|
|
198
|
-
"name": ".editedItem",
|
|
199
|
-
"description": "The item being edited in the dialog.",
|
|
200
|
-
"value": {
|
|
201
|
-
"kind": "expression"
|
|
202
|
-
}
|
|
203
|
-
},
|
|
204
|
-
{
|
|
205
|
-
"name": ".editorPosition",
|
|
206
|
-
"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)",
|
|
207
|
-
"value": {
|
|
208
|
-
"kind": "expression"
|
|
209
|
-
}
|
|
210
|
-
},
|
|
211
|
-
{
|
|
212
|
-
"name": ".dataProvider",
|
|
213
|
-
"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",
|
|
214
|
-
"value": {
|
|
215
|
-
"kind": "expression"
|
|
216
|
-
}
|
|
217
|
-
},
|
|
218
|
-
{
|
|
219
|
-
"name": ".include",
|
|
220
|
-
"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`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
|
|
221
|
-
"value": {
|
|
222
|
-
"kind": "expression"
|
|
223
|
-
}
|
|
224
|
-
},
|
|
225
|
-
{
|
|
226
|
-
"name": ".exclude",
|
|
227
|
-
"description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](https://cdn.vaadin.com/vaadin-web-components/24.4.0-alpha1/#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
|
|
228
|
-
"value": {
|
|
229
|
-
"kind": "expression"
|
|
230
|
-
}
|
|
231
|
-
},
|
|
232
|
-
{
|
|
233
|
-
"name": ".i18n",
|
|
234
|
-
"description": "The object used to localize this component.\nFor changing the default localization, change the entire\n_i18n_ object or just the property you want to modify.\n\nThe object has the following JSON structure and default values:\n\n```\n{\n newItem: 'New item',\n editItem: 'Edit item',\n saveItem: 'Save',\n cancel: 'Cancel',\n deleteItem: 'Delete...',\n editLabel: 'Edit',\n confirm: {\n delete: {\n title: 'Confirm delete',\n content: 'Are you sure you want to delete the selected item? This action cannot be undone.',\n button: {\n confirm: 'Delete',\n dismiss: 'Cancel'\n }\n },\n cancel: {\n title: 'Unsaved changes',\n content: 'There are unsaved modifications to the item.',\n button: {\n confirm: 'Discard',\n dismiss: 'Continue editing'\n }\n }\n }\n}\n```",
|
|
235
|
-
"value": {
|
|
236
|
-
"kind": "expression"
|
|
237
|
-
}
|
|
238
|
-
},
|
|
239
|
-
{
|
|
240
|
-
"name": "@cancel",
|
|
241
|
-
"description": "Fired when user discards edition. If the default is prevented, then\nno action is performed, user is responsible to close dialog and reset\nitem and grid.",
|
|
242
|
-
"value": {
|
|
243
|
-
"kind": "expression"
|
|
244
|
-
}
|
|
245
|
-
},
|
|
246
|
-
{
|
|
247
|
-
"name": "@delete",
|
|
248
|
-
"description": "Fired when user wants to delete item. If the default is prevented, then\nno action is performed, items array is not modified nor dialog closed",
|
|
249
|
-
"value": {
|
|
250
|
-
"kind": "expression"
|
|
251
|
-
}
|
|
252
|
-
},
|
|
253
|
-
{
|
|
254
|
-
"name": "@edit",
|
|
255
|
-
"description": "Fired when user wants to edit an existing item. If the default is prevented, then\na new item is not assigned to the form, giving that responsibility to the app, though\ndialog is always opened.",
|
|
256
|
-
"value": {
|
|
257
|
-
"kind": "expression"
|
|
258
|
-
}
|
|
259
|
-
},
|
|
260
|
-
{
|
|
261
|
-
"name": "@new",
|
|
262
|
-
"description": "Fired when user wants to create a new item.",
|
|
263
|
-
"value": {
|
|
264
|
-
"kind": "expression"
|
|
265
|
-
}
|
|
266
|
-
},
|
|
267
|
-
{
|
|
268
|
-
"name": "@save",
|
|
269
|
-
"description": "Fired when user wants to save a new or an existing item. If the default is prevented, then\nno action is performed, items array is not modified nor dialog closed",
|
|
270
|
-
"value": {
|
|
271
|
-
"kind": "expression"
|
|
272
|
-
}
|
|
273
|
-
},
|
|
274
|
-
{
|
|
275
|
-
"name": "@items-changed",
|
|
276
|
-
"description": "Fired when the `items` property changes.",
|
|
277
|
-
"value": {
|
|
278
|
-
"kind": "expression"
|
|
279
|
-
}
|
|
280
|
-
},
|
|
281
|
-
{
|
|
282
|
-
"name": "@edited-item-changed",
|
|
283
|
-
"description": "Fired when the `editedItem` property changes.",
|
|
284
|
-
"value": {
|
|
285
|
-
"kind": "expression"
|
|
286
|
-
}
|
|
287
|
-
},
|
|
288
|
-
{
|
|
289
|
-
"name": "@editor-opened-changed",
|
|
290
|
-
"description": "Fired when the `editorOpened` property changes.",
|
|
291
|
-
"value": {
|
|
292
|
-
"kind": "expression"
|
|
293
|
-
}
|
|
294
|
-
},
|
|
295
|
-
{
|
|
296
|
-
"name": "@size-changed",
|
|
297
|
-
"description": "Fired when the `size` property changes.",
|
|
298
|
-
"value": {
|
|
299
|
-
"kind": "expression"
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
]
|
|
303
|
-
}
|
|
304
|
-
]
|
|
305
|
-
}
|
|
306
|
-
}
|
|
307
|
-
}
|