@vaadin/upload 25.1.2 → 25.2.0-alpha10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/custom-elements.json +27 -15
  2. package/package.json +11 -11
  3. package/src/styles/vaadin-upload-file-base-styles.js +0 -1
  4. package/src/vaadin-upload-file-list-mixin.d.ts +37 -0
  5. package/src/vaadin-upload-file-list-mixin.js +52 -0
  6. package/src/vaadin-upload-file.d.ts +6 -6
  7. package/src/vaadin-upload-file.js +3 -30
  8. package/src/vaadin-upload-helpers.js +1 -1
  9. package/src/vaadin-upload-manager.js +2 -2
  10. package/src/vaadin-upload-mixin.d.ts +2 -1
  11. package/src/vaadin-upload-mixin.js +2 -1
  12. package/src/vaadin-upload.d.ts +8 -8
  13. package/src/vaadin-upload.js +8 -114
  14. package/web-types.json +125 -281
  15. package/web-types.lit.json +90 -97
package/web-types.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/upload",
4
- "version": "25.1.2",
4
+ "version": "25.2.0-alpha10",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -15,9 +15,7 @@
15
15
  "description": "Capture attribute for mobile file input.",
16
16
  "value": {
17
17
  "type": [
18
- "string",
19
- "null",
20
- "undefined"
18
+ "string"
21
19
  ]
22
20
  }
23
21
  },
@@ -26,9 +24,7 @@
26
24
  "description": "If true, the user cannot interact with this element.",
27
25
  "value": {
28
26
  "type": [
29
- "boolean",
30
- "null",
31
- "undefined"
27
+ "boolean"
32
28
  ]
33
29
  }
34
30
  },
@@ -37,9 +33,7 @@
37
33
  "description": "True when max files has been reached on the manager.",
38
34
  "value": {
39
35
  "type": [
40
- "boolean",
41
- "null",
42
- "undefined"
36
+ "boolean"
43
37
  ]
44
38
  }
45
39
  },
@@ -62,9 +56,7 @@
62
56
  "description": "Capture attribute for mobile file input.",
63
57
  "value": {
64
58
  "type": [
65
- "string",
66
- "null",
67
- "undefined"
59
+ "string"
68
60
  ]
69
61
  }
70
62
  },
@@ -73,7 +65,7 @@
73
65
  "description": "Whether the button is disabled.\nReturns true if either explicitly disabled, manager is disabled, or maxFilesReached is true.",
74
66
  "value": {
75
67
  "type": [
76
- "?"
68
+ "boolean"
77
69
  ]
78
70
  }
79
71
  },
@@ -92,9 +84,7 @@
92
84
  "description": "True when max files has been reached on the manager.",
93
85
  "value": {
94
86
  "type": [
95
- "boolean",
96
- "null",
97
- "undefined"
87
+ "boolean"
98
88
  ]
99
89
  }
100
90
  }
@@ -111,22 +101,59 @@
111
101
  "description": "Whether the drop zone is disabled.\nReturns true if either explicitly disabled, manager is disabled, or no manager is set.",
112
102
  "value": {
113
103
  "type": [
114
- "boolean",
115
- "null",
116
- "undefined"
104
+ "boolean"
117
105
  ]
118
106
  }
119
107
  },
120
108
  {
121
- "name": "max-files-reached",
122
- "description": "True when max files has been reached on the manager.",
109
+ "name": "theme",
110
+ "description": "The theme variants to apply to the component.",
123
111
  "value": {
124
112
  "type": [
125
- "boolean",
113
+ "string",
126
114
  "null",
127
115
  "undefined"
128
116
  ]
129
117
  }
118
+ }
119
+ ],
120
+ "js": {
121
+ "properties": [
122
+ {
123
+ "name": "disabled",
124
+ "description": "Whether the drop zone is disabled.\nReturns true if either explicitly disabled, manager is disabled, or no manager is set.",
125
+ "value": {
126
+ "type": [
127
+ "boolean"
128
+ ]
129
+ }
130
+ },
131
+ {
132
+ "name": "manager",
133
+ "description": "Reference to an UploadManager.\nWhen set, dropped files will be automatically added to the manager.",
134
+ "value": {
135
+ "type": [
136
+ "Object",
137
+ "null"
138
+ ]
139
+ }
140
+ }
141
+ ],
142
+ "events": []
143
+ }
144
+ },
145
+ {
146
+ "name": "vaadin-upload-file-list",
147
+ "description": "`<vaadin-upload-file-list>` is a Web Component that displays a list of uploaded files.\nIt automatically syncs files from the manager and forwards file events back to it.\n\n```html\n<vaadin-upload-file-list></vaadin-upload-file-list>\n```\n\nThe file list must be linked to an UploadManager by setting the `manager` property:\n\n```javascript\nimport { UploadManager } from '@vaadin/upload/vaadin-upload-manager.js';\n\nconst manager = new UploadManager({ target: '/api/upload' });\nconst fileList = document.querySelector('vaadin-upload-file-list');\nfileList.manager = manager;\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------|-------------\n`list` | The `<ul>` element wrapping the file items\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------|-------------\n`disabled` | Set when the element is disabled\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------|\n`--vaadin-upload-file-list-divider-color` |\n`--vaadin-upload-file-list-divider-width` |\n`--vaadin-upload-file-border-radius` |\n`--vaadin-upload-file-button-background` |\n`--vaadin-upload-file-button-border-color` |\n`--vaadin-upload-file-button-border-radius` |\n`--vaadin-upload-file-button-border-width` |\n`--vaadin-upload-file-button-text-color` |\n`--vaadin-upload-file-button-padding` |\n`--vaadin-upload-file-done-color` |\n`--vaadin-upload-file-error-color` |\n`--vaadin-upload-file-error-font-size` |\n`--vaadin-upload-file-error-font-weight` |\n`--vaadin-upload-file-error-line-height` |\n`--vaadin-upload-file-gap` |\n`--vaadin-upload-file-name-color` |\n`--vaadin-upload-file-name-font-size` |\n`--vaadin-upload-file-name-font-weight` |\n`--vaadin-upload-file-name-line-height` |\n`--vaadin-upload-file-padding` |\n`--vaadin-upload-file-status-color` |\n`--vaadin-upload-file-status-font-size` |\n`--vaadin-upload-file-status-font-weight` |\n`--vaadin-upload-file-status-line-height` |\n`--vaadin-upload-file-warning-color` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
148
+ "attributes": [
149
+ {
150
+ "name": "disabled",
151
+ "description": "If true, the user cannot interact with this element.",
152
+ "value": {
153
+ "type": [
154
+ "boolean"
155
+ ]
156
+ }
130
157
  },
131
158
  {
132
159
  "name": "theme",
@@ -144,33 +171,29 @@
144
171
  "properties": [
145
172
  {
146
173
  "name": "disabled",
147
- "description": "Whether the drop zone is disabled.\nReturns true if either explicitly disabled, manager is disabled, or no manager is set.",
174
+ "description": "If true, the user cannot interact with this element.",
148
175
  "value": {
149
176
  "type": [
150
- "boolean",
151
- "null",
152
- "undefined"
177
+ "boolean"
153
178
  ]
154
179
  }
155
180
  },
156
181
  {
157
- "name": "manager",
158
- "description": "Reference to an UploadManager.\nWhen set, dropped files will be automatically added to the manager.",
182
+ "name": "i18n",
183
+ "description": "The object used to localize this component.\nTo change the default localization, replace this with an object\nthat provides all properties, or just the individual properties\nyou want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n file: {\n retry: 'Retry',\n start: 'Start',\n remove: 'Remove'\n },\n error: {\n tooManyFiles: 'Too Many Files.',\n fileIsTooBig: 'File is Too Big.',\n incorrectFileType: 'Incorrect File Type.'\n },\n uploading: {\n status: {\n connecting: 'Connecting...',\n stalled: 'Stalled',\n processing: 'Processing File...',\n held: 'Queued'\n },\n remainingTime: {\n prefix: 'remaining time: ',\n unknown: 'unknown remaining time'\n },\n error: {\n serverUnavailable: 'Upload failed, please try again later',\n unexpectedServerError: 'Upload failed due to server error',\n forbidden: 'Upload forbidden',\n fileTooLarge: 'File is too large'\n }\n },\n units: {\n size: ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']\n }\n}\n```",
159
184
  "value": {
160
185
  "type": [
161
- "Object",
162
- "null"
186
+ "Object"
163
187
  ]
164
188
  }
165
189
  },
166
190
  {
167
- "name": "maxFilesReached",
168
- "description": "True when max files has been reached on the manager.",
191
+ "name": "manager",
192
+ "description": "Reference to an UploadManager to link this file list to.\nWhen set, the file list automatically:\n- Syncs files from the manager\n- Forwards retry/abort/start/remove events back to the manager",
169
193
  "value": {
170
194
  "type": [
171
- "boolean",
172
- "null",
173
- "undefined"
195
+ "Object",
196
+ "null"
174
197
  ]
175
198
  }
176
199
  }
@@ -187,9 +210,7 @@
187
210
  "description": "True if uploading is completed, false otherwise.",
188
211
  "value": {
189
212
  "type": [
190
- "boolean",
191
- "null",
192
- "undefined"
213
+ "boolean"
193
214
  ]
194
215
  }
195
216
  },
@@ -198,9 +219,7 @@
198
219
  "description": "If true, the user cannot interact with this element.",
199
220
  "value": {
200
221
  "type": [
201
- "boolean",
202
- "null",
203
- "undefined"
222
+ "boolean"
204
223
  ]
205
224
  }
206
225
  },
@@ -209,9 +228,7 @@
209
228
  "description": "Error message returned by the server, if any.",
210
229
  "value": {
211
230
  "type": [
212
- "string",
213
- "null",
214
- "undefined"
231
+ "string"
215
232
  ]
216
233
  }
217
234
  },
@@ -220,9 +237,7 @@
220
237
  "description": "Name of the uploading file.",
221
238
  "value": {
222
239
  "type": [
223
- "string",
224
- "null",
225
- "undefined"
240
+ "string"
226
241
  ]
227
242
  }
228
243
  },
@@ -231,9 +246,7 @@
231
246
  "description": "True if uploading is not started, false otherwise.",
232
247
  "value": {
233
248
  "type": [
234
- "boolean",
235
- "null",
236
- "undefined"
249
+ "boolean"
237
250
  ]
238
251
  }
239
252
  },
@@ -242,9 +255,7 @@
242
255
  "description": "True if remaining time is unknown, false otherwise.",
243
256
  "value": {
244
257
  "type": [
245
- "boolean",
246
- "null",
247
- "undefined"
258
+ "boolean"
248
259
  ]
249
260
  }
250
261
  },
@@ -253,9 +264,7 @@
253
264
  "description": "Number representing the uploading progress.",
254
265
  "value": {
255
266
  "type": [
256
- "number",
257
- "null",
258
- "undefined"
267
+ "number"
259
268
  ]
260
269
  }
261
270
  },
@@ -264,9 +273,7 @@
264
273
  "description": "Uploading status.",
265
274
  "value": {
266
275
  "type": [
267
- "string",
268
- "null",
269
- "undefined"
276
+ "string"
270
277
  ]
271
278
  }
272
279
  },
@@ -286,9 +293,7 @@
286
293
  "description": "True if uploading is in progress, false otherwise.",
287
294
  "value": {
288
295
  "type": [
289
- "boolean",
290
- "null",
291
- "undefined"
296
+ "boolean"
292
297
  ]
293
298
  }
294
299
  }
@@ -300,9 +305,7 @@
300
305
  "description": "True if uploading is completed, false otherwise.",
301
306
  "value": {
302
307
  "type": [
303
- "boolean",
304
- "null",
305
- "undefined"
308
+ "boolean"
306
309
  ]
307
310
  }
308
311
  },
@@ -311,9 +314,7 @@
311
314
  "description": "If true, the user cannot interact with this element.",
312
315
  "value": {
313
316
  "type": [
314
- "boolean",
315
- "null",
316
- "undefined"
317
+ "boolean"
317
318
  ]
318
319
  }
319
320
  },
@@ -322,9 +323,7 @@
322
323
  "description": "Error message returned by the server, if any.",
323
324
  "value": {
324
325
  "type": [
325
- "string",
326
- "null",
327
- "undefined"
326
+ "string"
328
327
  ]
329
328
  }
330
329
  },
@@ -333,9 +332,7 @@
333
332
  "description": "The object representing a file.",
334
333
  "value": {
335
334
  "type": [
336
- "Object",
337
- "null",
338
- "undefined"
335
+ "object"
339
336
  ]
340
337
  }
341
338
  },
@@ -344,9 +341,7 @@
344
341
  "description": "Name of the uploading file.",
345
342
  "value": {
346
343
  "type": [
347
- "string",
348
- "null",
349
- "undefined"
344
+ "string"
350
345
  ]
351
346
  }
352
347
  },
@@ -355,9 +350,7 @@
355
350
  "description": "True if uploading is not started, false otherwise.",
356
351
  "value": {
357
352
  "type": [
358
- "boolean",
359
- "null",
360
- "undefined"
353
+ "boolean"
361
354
  ]
362
355
  }
363
356
  },
@@ -366,9 +359,7 @@
366
359
  "description": "The object used to localize this component.",
367
360
  "value": {
368
361
  "type": [
369
- "Object",
370
- "null",
371
- "undefined"
362
+ "object"
372
363
  ]
373
364
  }
374
365
  },
@@ -377,9 +368,7 @@
377
368
  "description": "True if remaining time is unknown, false otherwise.",
378
369
  "value": {
379
370
  "type": [
380
- "boolean",
381
- "null",
382
- "undefined"
371
+ "boolean"
383
372
  ]
384
373
  }
385
374
  },
@@ -388,9 +377,7 @@
388
377
  "description": "Number representing the uploading progress.",
389
378
  "value": {
390
379
  "type": [
391
- "number",
392
- "null",
393
- "undefined"
380
+ "number"
394
381
  ]
395
382
  }
396
383
  },
@@ -399,9 +386,7 @@
399
386
  "description": "Uploading status.",
400
387
  "value": {
401
388
  "type": [
402
- "string",
403
- "null",
404
- "undefined"
389
+ "string"
405
390
  ]
406
391
  }
407
392
  },
@@ -410,9 +395,7 @@
410
395
  "description": "True if uploading is in progress, false otherwise.",
411
396
  "value": {
412
397
  "type": [
413
- "boolean",
414
- "null",
415
- "undefined"
398
+ "boolean"
416
399
  ]
417
400
  }
418
401
  }
@@ -420,106 +403,19 @@
420
403
  "events": [
421
404
  {
422
405
  "name": "file-abort",
423
- "description": "Fired when abort button is pressed. It is listened by `vaadin-upload` which\nwill abort the upload in progress, and then remove the file from the list."
406
+ "description": "Fired when the abort button is pressed to request aborting the upload of this file."
424
407
  },
425
408
  {
426
409
  "name": "file-retry",
427
- "description": "Fired when the retry button is pressed. It is listened by `vaadin-upload`\nwhich will start a new upload process of this file."
410
+ "description": "Fired when the retry button is pressed to request retrying the upload of this file."
428
411
  },
429
412
  {
430
413
  "name": "file-start",
431
- "description": "Fired when the start button is pressed. It is listened by `vaadin-upload`\nwhich will start a new upload process of this file."
414
+ "description": "Fired when the start button is pressed to request starting the upload of this file."
432
415
  }
433
416
  ]
434
417
  }
435
418
  },
436
- {
437
- "name": "vaadin-upload-file-list",
438
- "description": "`<vaadin-upload-file-list>` is a Web Component that displays a list of uploaded files.\nIt automatically syncs files from the manager and forwards file events back to it.\n\n```html\n<vaadin-upload-file-list></vaadin-upload-file-list>\n```\n\nThe file list must be linked to an UploadManager by setting the `manager` property:\n\n```javascript\nimport { UploadManager } from '@vaadin/upload/vaadin-upload-manager.js';\n\nconst manager = new UploadManager({ target: '/api/upload' });\nconst fileList = document.querySelector('vaadin-upload-file-list');\nfileList.manager = manager;\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------|-------------\n`list` | The `<ul>` element wrapping the file items\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------|-------------\n`disabled` | Set when the element is disabled\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------|\n`--vaadin-upload-file-list-divider-color` |\n`--vaadin-upload-file-list-divider-width` |\n`--vaadin-upload-file-border-radius` |\n`--vaadin-upload-file-button-background` |\n`--vaadin-upload-file-button-border-color` |\n`--vaadin-upload-file-button-border-radius` |\n`--vaadin-upload-file-button-border-width` |\n`--vaadin-upload-file-button-text-color` |\n`--vaadin-upload-file-button-padding` |\n`--vaadin-upload-file-done-color` |\n`--vaadin-upload-file-error-color` |\n`--vaadin-upload-file-error-font-size` |\n`--vaadin-upload-file-error-font-weight` |\n`--vaadin-upload-file-error-line-height` |\n`--vaadin-upload-file-gap` |\n`--vaadin-upload-file-name-color` |\n`--vaadin-upload-file-name-font-size` |\n`--vaadin-upload-file-name-font-weight` |\n`--vaadin-upload-file-name-line-height` |\n`--vaadin-upload-file-padding` |\n`--vaadin-upload-file-status-color` |\n`--vaadin-upload-file-status-font-size` |\n`--vaadin-upload-file-status-font-weight` |\n`--vaadin-upload-file-status-line-height` |\n`--vaadin-upload-file-warning-color` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
439
- "attributes": [
440
- {
441
- "name": "disabled",
442
- "description": "If true, the user cannot interact with this element.",
443
- "value": {
444
- "type": [
445
- "boolean",
446
- "null",
447
- "undefined"
448
- ]
449
- }
450
- },
451
- {
452
- "name": "i18n",
453
- "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
454
- "value": {
455
- "type": [
456
- "Object",
457
- "null",
458
- "undefined"
459
- ]
460
- }
461
- },
462
- {
463
- "name": "theme",
464
- "description": "The theme variants to apply to the component.",
465
- "value": {
466
- "type": [
467
- "string",
468
- "null",
469
- "undefined"
470
- ]
471
- }
472
- }
473
- ],
474
- "js": {
475
- "properties": [
476
- {
477
- "name": "disabled",
478
- "description": "If true, the user cannot interact with this element.",
479
- "value": {
480
- "type": [
481
- "boolean",
482
- "null",
483
- "undefined"
484
- ]
485
- }
486
- },
487
- {
488
- "name": "i18n",
489
- "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
490
- "value": {
491
- "type": [
492
- "Object",
493
- "null",
494
- "undefined"
495
- ]
496
- }
497
- },
498
- {
499
- "name": "items",
500
- "description": "The array of files being processed, or already uploaded.",
501
- "value": {
502
- "type": [
503
- "Array",
504
- "null",
505
- "undefined"
506
- ]
507
- }
508
- },
509
- {
510
- "name": "manager",
511
- "description": "Reference to an UploadManager to link this file list to.\nWhen set, the file list automatically:\n- Syncs files from the manager\n- Forwards retry/abort/start/remove events back to the manager",
512
- "value": {
513
- "type": [
514
- "Object",
515
- "null"
516
- ]
517
- }
518
- }
519
- ],
520
- "events": []
521
- }
522
- },
523
419
  {
524
420
  "name": "vaadin-upload",
525
421
  "description": "`<vaadin-upload>` is a Web Component for uploading multiple files with drag and drop support.\n\nExample:\n\n```html\n<vaadin-upload></vaadin-upload>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n-------------------|-------------------------------------\n`primary-buttons` | Upload container\n`drop-label` | Element wrapping drop label and icon\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`nodrop` | Set when drag and drop is disabled (e.g., on touch devices)\n`dragover` | Set when the file is being dragged over the element\n`dragover-valid` | Set when the dragged file is valid with `maxFiles` and `accept` criteria\n`max-files-reached` | Set when maximum number of files that the user is allowed to add has been reached\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------|\n`--vaadin-upload-background` |\n`--vaadin-upload-border-color` |\n`--vaadin-upload-border-radius` |\n`--vaadin-upload-border-width` |\n`--vaadin-upload-gap` |\n`--vaadin-upload-padding` |\n`--vaadin-upload-drop-label-color` |\n`--vaadin-upload-drop-label-font-size` |\n`--vaadin-upload-drop-label-font-weight` |\n`--vaadin-upload-drop-label-gap` |\n`--vaadin-upload-drop-label-line-height` |\n`--vaadin-upload-file-list-divider-color` |\n`--vaadin-upload-file-list-divider-width` |\n`--vaadin-upload-file-border-radius` |\n`--vaadin-upload-file-button-background` |\n`--vaadin-upload-file-button-border-color` |\n`--vaadin-upload-file-button-border-radius` |\n`--vaadin-upload-file-button-border-width` |\n`--vaadin-upload-file-button-text-color` |\n`--vaadin-upload-file-button-padding` |\n`--vaadin-upload-file-done-color` |\n`--vaadin-upload-file-error-color` |\n`--vaadin-upload-file-error-font-size` |\n`--vaadin-upload-file-error-font-weight` |\n`--vaadin-upload-file-error-line-height` |\n`--vaadin-upload-file-gap` |\n`--vaadin-upload-file-name-color` |\n`--vaadin-upload-file-name-font-size` |\n`--vaadin-upload-file-name-font-weight` |\n`--vaadin-upload-file-name-line-height` |\n`--vaadin-upload-file-padding` |\n`--vaadin-upload-file-status-color` |\n`--vaadin-upload-file-status-font-size` |\n`--vaadin-upload-file-status-font-weight` |\n`--vaadin-upload-file-status-line-height` |\n`--vaadin-upload-file-warning-color` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
@@ -529,9 +425,7 @@
529
425
  "description": "Specifies the types of files that the server accepts.\nSyntax: a comma-separated list of MIME type patterns (wildcards are\nallowed) or file extensions.\nNotice that MIME types are widely supported, while file extensions\nare only implemented in certain browsers, so avoid using it.\nExample: accept=\"video/*,image/tiff\" or accept=\".pdf,audio/mp3\"",
530
426
  "value": {
531
427
  "type": [
532
- "string",
533
- "null",
534
- "undefined"
428
+ "string"
535
429
  ]
536
430
  }
537
431
  },
@@ -540,9 +434,7 @@
540
434
  "description": "Pass-through to input's capture attribute. Allows user to trigger device inputs\nsuch as camera or microphone immediately.",
541
435
  "value": {
542
436
  "type": [
543
- "string",
544
- "null",
545
- "undefined"
437
+ "string"
546
438
  ]
547
439
  }
548
440
  },
@@ -551,9 +443,7 @@
551
443
  "description": "If true, the user cannot interact with this element.",
552
444
  "value": {
553
445
  "type": [
554
- "boolean",
555
- "null",
556
- "undefined"
446
+ "boolean"
557
447
  ]
558
448
  }
559
449
  },
@@ -562,9 +452,7 @@
562
452
  "description": "Specifies the 'name' property at Content-Disposition for multipart uploads.\nThis property is ignored when uploadFormat is 'raw'.",
563
453
  "value": {
564
454
  "type": [
565
- "string",
566
- "null",
567
- "undefined"
455
+ "string"
568
456
  ]
569
457
  }
570
458
  },
@@ -573,9 +461,7 @@
573
461
  "description": "Specifies the maximum number of files that can be uploaded simultaneously.\nThis helps prevent browser performance degradation and XHR limitations when\nuploading large numbers of files. Files exceeding this limit will be queued\nand uploaded as active uploads complete.",
574
462
  "value": {
575
463
  "type": [
576
- "number",
577
- "null",
578
- "undefined"
464
+ "number"
579
465
  ]
580
466
  }
581
467
  },
@@ -584,9 +470,7 @@
584
470
  "description": "Specifies the maximum file size in bytes allowed to upload.\nNotice that it is a client-side constraint, which will be checked before\nsending the request. Obviously you need to do the same validation in\nthe server-side and be sure that they are aligned.",
585
471
  "value": {
586
472
  "type": [
587
- "number",
588
- "null",
589
- "undefined"
473
+ "number"
590
474
  ]
591
475
  }
592
476
  },
@@ -595,9 +479,7 @@
595
479
  "description": "Limit of files to upload, by default it is unlimited. If the value is\nset to one, native file browser will prevent selecting multiple files.",
596
480
  "value": {
597
481
  "type": [
598
- "number",
599
- "null",
600
- "undefined"
482
+ "number"
601
483
  ]
602
484
  }
603
485
  },
@@ -606,9 +488,7 @@
606
488
  "description": "HTTP Method used to send the files. Only POST and PUT are allowed.",
607
489
  "value": {
608
490
  "type": [
609
- "string",
610
- "null",
611
- "undefined"
491
+ "string"
612
492
  ]
613
493
  }
614
494
  },
@@ -617,9 +497,7 @@
617
497
  "description": "Prevents upload(s) from immediately uploading upon adding file(s).\nWhen set, you must manually trigger uploads using the `uploadFiles` method",
618
498
  "value": {
619
499
  "type": [
620
- "boolean",
621
- "null",
622
- "undefined"
500
+ "boolean"
623
501
  ]
624
502
  }
625
503
  },
@@ -628,9 +506,7 @@
628
506
  "description": "Define whether the element supports dropping files on it for uploading.\nBy default it's enabled in desktop and disabled in touch devices\nbecause mobile devices do not support drag events in general. Setting\nit false means that drop is enabled even in touch-devices, and true\ndisables drop in all devices.",
629
507
  "value": {
630
508
  "type": [
631
- "boolean",
632
- "null",
633
- "undefined"
509
+ "boolean"
634
510
  ]
635
511
  }
636
512
  },
@@ -639,9 +515,7 @@
639
515
  "description": "The server URL. The default value is an empty string, which means that\n_window.location_ will be used.",
640
516
  "value": {
641
517
  "type": [
642
- "string",
643
- "null",
644
- "undefined"
518
+ "string"
645
519
  ]
646
520
  }
647
521
  },
@@ -661,9 +535,7 @@
661
535
  "description": "Max time in milliseconds for the entire upload process, if exceeded the\nrequest will be aborted. Zero means that there is no timeout.",
662
536
  "value": {
663
537
  "type": [
664
- "number",
665
- "null",
666
- "undefined"
538
+ "number"
667
539
  ]
668
540
  }
669
541
  },
@@ -672,9 +544,7 @@
672
544
  "description": "Specifies the upload format to use when sending files to the server.\n- 'raw': Send file as raw binary data with the file's MIME type as Content-Type (default)\n- 'multipart': Send file using multipart/form-data encoding",
673
545
  "value": {
674
546
  "type": [
675
- "string",
676
- "null",
677
- "undefined"
547
+ "string"
678
548
  ]
679
549
  }
680
550
  },
@@ -683,9 +553,7 @@
683
553
  "description": "Set the withCredentials flag on the request.",
684
554
  "value": {
685
555
  "type": [
686
- "boolean",
687
- "null",
688
- "undefined"
556
+ "boolean"
689
557
  ]
690
558
  }
691
559
  }
@@ -697,9 +565,7 @@
697
565
  "description": "Specifies the types of files that the server accepts.\nSyntax: a comma-separated list of MIME type patterns (wildcards are\nallowed) or file extensions.\nNotice that MIME types are widely supported, while file extensions\nare only implemented in certain browsers, so avoid using it.\nExample: accept=\"video/*,image/tiff\" or accept=\".pdf,audio/mp3\"",
698
566
  "value": {
699
567
  "type": [
700
- "string",
701
- "null",
702
- "undefined"
568
+ "string"
703
569
  ]
704
570
  }
705
571
  },
@@ -708,9 +574,7 @@
708
574
  "description": "Pass-through to input's capture attribute. Allows user to trigger device inputs\nsuch as camera or microphone immediately.",
709
575
  "value": {
710
576
  "type": [
711
- "string",
712
- "null",
713
- "undefined"
577
+ "string"
714
578
  ]
715
579
  }
716
580
  },
@@ -719,9 +583,7 @@
719
583
  "description": "If true, the user cannot interact with this element.",
720
584
  "value": {
721
585
  "type": [
722
- "boolean",
723
- "null",
724
- "undefined"
586
+ "boolean"
725
587
  ]
726
588
  }
727
589
  },
@@ -730,7 +592,7 @@
730
592
  "description": "The array of files being processed, or already uploaded.\n\nEach element is a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File)\nobject with a number of extra properties to track the upload process:\n- `uploadTarget`: The target URL used to upload this file.\n- `elapsed`: Elapsed time since the upload started.\n- `elapsedStr`: Human-readable elapsed time.\n- `remaining`: Number of seconds remaining for the upload to finish.\n- `remainingStr`: Human-readable remaining time for the upload to finish.\n- `progress`: Percentage of the file already uploaded.\n- `speed`: Upload speed in kB/s.\n- `size`: File size in bytes.\n- `totalStr`: Human-readable total size of the file.\n- `loaded`: Bytes transferred so far.\n- `loadedStr`: Human-readable uploaded size at the moment.\n- `status`: Status of the upload process.\n- `error`: Error message in case the upload failed.\n- `abort`: True if the file was canceled by the user.\n- `complete`: True when the file was transferred to the server.\n- `uploading`: True while transferring data to the server.",
731
593
  "value": {
732
594
  "type": [
733
- "Array.<UploadFile>"
595
+ "Array<UploadFile>"
734
596
  ]
735
597
  }
736
598
  },
@@ -739,9 +601,7 @@
739
601
  "description": "Specifies the 'name' property at Content-Disposition for multipart uploads.\nThis property is ignored when uploadFormat is 'raw'.",
740
602
  "value": {
741
603
  "type": [
742
- "string",
743
- "null",
744
- "undefined"
604
+ "string"
745
605
  ]
746
606
  }
747
607
  },
@@ -757,10 +617,10 @@
757
617
  },
758
618
  {
759
619
  "name": "i18n",
760
- "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n dropFiles: {\n one: 'Drop file here',\n many: 'Drop files here'\n },\n addFiles: {\n one: 'Upload File...',\n many: 'Upload Files...'\n },\n error: {\n tooManyFiles: 'Too Many Files.',\n fileIsTooBig: 'File is Too Big.',\n incorrectFileType: 'Incorrect File Type.'\n },\n uploading: {\n status: {\n connecting: 'Connecting...',\n stalled: 'Stalled',\n processing: 'Processing File...',\n held: 'Queued'\n },\n remainingTime: {\n prefix: 'remaining time: ',\n unknown: 'unknown remaining time'\n },\n error: {\n serverUnavailable: 'Upload failed, please try again later',\n unexpectedServerError: 'Upload failed due to server error',\n forbidden: 'Upload forbidden'\n }\n },\n file: {\n retry: 'Retry',\n start: 'Start',\n remove: 'Remove'\n },\n units: {\n size: ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'],\n sizeBase: 1000\n },\n formatSize: function(bytes) {\n // returns the size followed by the best suitable unit\n },\n formatTime: function(seconds, [secs, mins, hours]) {\n // returns a 'HH:MM:SS' string\n }\n}\n```",
620
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n dropFiles: {\n one: 'Drop file here',\n many: 'Drop files here'\n },\n addFiles: {\n one: 'Upload File...',\n many: 'Upload Files...'\n },\n error: {\n tooManyFiles: 'Too Many Files.',\n fileIsTooBig: 'File is Too Big.',\n incorrectFileType: 'Incorrect File Type.'\n },\n uploading: {\n status: {\n connecting: 'Connecting...',\n stalled: 'Stalled',\n processing: 'Processing File...',\n held: 'Queued'\n },\n remainingTime: {\n prefix: 'remaining time: ',\n unknown: 'unknown remaining time'\n },\n error: {\n serverUnavailable: 'Upload failed, please try again later',\n unexpectedServerError: 'Upload failed due to server error',\n forbidden: 'Upload forbidden',\n fileTooLarge: 'File is too large'\n }\n },\n file: {\n retry: 'Retry',\n start: 'Start',\n remove: 'Remove'\n },\n units: {\n size: ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'],\n sizeBase: 1000\n },\n formatSize: function(bytes) {\n // returns the size followed by the best suitable unit\n },\n formatTime: function(seconds, [secs, mins, hours]) {\n // returns a 'HH:MM:SS' string\n }\n}\n```",
761
621
  "value": {
762
622
  "type": [
763
- "?"
623
+ "Object"
764
624
  ]
765
625
  }
766
626
  },
@@ -769,9 +629,7 @@
769
629
  "description": "Specifies the maximum number of files that can be uploaded simultaneously.\nThis helps prevent browser performance degradation and XHR limitations when\nuploading large numbers of files. Files exceeding this limit will be queued\nand uploaded as active uploads complete.",
770
630
  "value": {
771
631
  "type": [
772
- "number",
773
- "null",
774
- "undefined"
632
+ "number"
775
633
  ]
776
634
  }
777
635
  },
@@ -780,9 +638,7 @@
780
638
  "description": "Limit of files to upload, by default it is unlimited. If the value is\nset to one, native file browser will prevent selecting multiple files.",
781
639
  "value": {
782
640
  "type": [
783
- "number",
784
- "null",
785
- "undefined"
641
+ "number"
786
642
  ]
787
643
  }
788
644
  },
@@ -791,9 +647,7 @@
791
647
  "description": "Specifies the maximum file size in bytes allowed to upload.\nNotice that it is a client-side constraint, which will be checked before\nsending the request. Obviously you need to do the same validation in\nthe server-side and be sure that they are aligned.",
792
648
  "value": {
793
649
  "type": [
794
- "number",
795
- "null",
796
- "undefined"
650
+ "number"
797
651
  ]
798
652
  }
799
653
  },
@@ -802,9 +656,7 @@
802
656
  "description": "HTTP Method used to send the files. Only POST and PUT are allowed.",
803
657
  "value": {
804
658
  "type": [
805
- "string",
806
- "null",
807
- "undefined"
659
+ "string"
808
660
  ]
809
661
  }
810
662
  },
@@ -813,9 +665,7 @@
813
665
  "description": "Prevents upload(s) from immediately uploading upon adding file(s).\nWhen set, you must manually trigger uploads using the `uploadFiles` method",
814
666
  "value": {
815
667
  "type": [
816
- "boolean",
817
- "null",
818
- "undefined"
668
+ "boolean"
819
669
  ]
820
670
  }
821
671
  },
@@ -824,9 +674,7 @@
824
674
  "description": "Define whether the element supports dropping files on it for uploading.\nBy default it's enabled in desktop and disabled in touch devices\nbecause mobile devices do not support drag events in general. Setting\nit false means that drop is enabled even in touch-devices, and true\ndisables drop in all devices.",
825
675
  "value": {
826
676
  "type": [
827
- "boolean",
828
- "null",
829
- "undefined"
677
+ "boolean"
830
678
  ]
831
679
  }
832
680
  },
@@ -835,9 +683,7 @@
835
683
  "description": "The server URL. The default value is an empty string, which means that\n_window.location_ will be used.",
836
684
  "value": {
837
685
  "type": [
838
- "string",
839
- "null",
840
- "undefined"
686
+ "string"
841
687
  ]
842
688
  }
843
689
  },
@@ -846,9 +692,7 @@
846
692
  "description": "Max time in milliseconds for the entire upload process, if exceeded the\nrequest will be aborted. Zero means that there is no timeout.",
847
693
  "value": {
848
694
  "type": [
849
- "number",
850
- "null",
851
- "undefined"
695
+ "number"
852
696
  ]
853
697
  }
854
698
  },
@@ -857,9 +701,7 @@
857
701
  "description": "Specifies the upload format to use when sending files to the server.\n- 'raw': Send file as raw binary data with the file's MIME type as Content-Type (default)\n- 'multipart': Send file using multipart/form-data encoding",
858
702
  "value": {
859
703
  "type": [
860
- "string",
861
- "null",
862
- "undefined"
704
+ "string"
863
705
  ]
864
706
  }
865
707
  },
@@ -868,9 +710,7 @@
868
710
  "description": "Set the withCredentials flag on the request.",
869
711
  "value": {
870
712
  "type": [
871
- "boolean",
872
- "null",
873
- "undefined"
713
+ "boolean"
874
714
  ]
875
715
  }
876
716
  }
@@ -878,7 +718,11 @@
878
718
  "events": [
879
719
  {
880
720
  "name": "file-reject",
881
- "description": "Fired when a file cannot be added to the queue due to a constrain:\n file-size, file-type or maxFiles"
721
+ "description": "Fired when a file cannot be added to the queue due to a constraint: file size, file type, or maxFiles."
722
+ },
723
+ {
724
+ "name": "file-remove",
725
+ "description": "Fired when a file is removed from the list."
882
726
  },
883
727
  {
884
728
  "name": "files-changed",
@@ -890,15 +734,15 @@
890
734
  },
891
735
  {
892
736
  "name": "upload-abort",
893
- "description": "Fired when retry abort is requested. If the default is prevented, then the\nfile upload would not be aborted."
737
+ "description": "Fired when upload abort is requested. If the default is prevented, the upload is not aborted."
894
738
  },
895
739
  {
896
740
  "name": "upload-before",
897
- "description": "Fired before the XHR is opened. Could be used for changing the request\nURL. If the default is prevented, then XHR would not be opened."
741
+ "description": "Fired before the XHR is opened. Useful for changing the request URL. If the default is prevented, the XHR is not opened."
898
742
  },
899
743
  {
900
744
  "name": "upload-error",
901
- "description": "Fired in case the upload process failed."
745
+ "description": "Fired when the upload process fails."
902
746
  },
903
747
  {
904
748
  "name": "upload-progress",
@@ -906,15 +750,15 @@
906
750
  },
907
751
  {
908
752
  "name": "upload-request",
909
- "description": "Fired when the XHR has been opened but not sent yet. Useful for appending\ndata keys to the FormData object, for changing some parameters like\nheaders, etc. If the event is defaultPrevented, `vaadin-upload` will not\nsend the request allowing the user to do something on his own."
753
+ "description": "Fired when the XHR has been opened but not sent yet. Useful for appending data to the FormData or modifying request parameters. If the default is prevented, the request is not sent."
910
754
  },
911
755
  {
912
756
  "name": "upload-response",
913
- "description": "Fired when we have the actual server response, and before the component\nanalyses it. It's useful for developers to make the upload fail depending\non the server response. If the event is defaultPrevented the vaadin-upload\nwill return allowing the user to do something on his own like retry the\nupload, etc. since he has full access to the `xhr` and `file` objects.\nOtherwise, if the event is not prevented default `vaadin-upload` continues\nwith the normal workflow checking the `xhr.status` and `file.error`\nwhich also might be modified by the user to force a customized response."
757
+ "description": "Fired when the server response is received, before the component analyzes it. If the default is prevented, the component returns and the listener can handle `xhr` and `file` directly; otherwise the normal flow checks `xhr.status` and `file.error`, which can be modified to force a custom outcome."
914
758
  },
915
759
  {
916
760
  "name": "upload-retry",
917
- "description": "Fired when retry upload is requested. If the default is prevented, then\nretry would not be performed."
761
+ "description": "Fired when retry upload is requested. If the default is prevented, the retry is not performed."
918
762
  },
919
763
  {
920
764
  "name": "upload-start",
@@ -922,7 +766,7 @@
922
766
  },
923
767
  {
924
768
  "name": "upload-success",
925
- "description": "Fired in case the upload process succeed."
769
+ "description": "Fired when the upload process succeeds."
926
770
  }
927
771
  ]
928
772
  }