@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.
- package/custom-elements.json +27 -15
- package/package.json +11 -11
- package/src/styles/vaadin-upload-file-base-styles.js +0 -1
- package/src/vaadin-upload-file-list-mixin.d.ts +37 -0
- package/src/vaadin-upload-file-list-mixin.js +52 -0
- package/src/vaadin-upload-file.d.ts +6 -6
- package/src/vaadin-upload-file.js +3 -30
- package/src/vaadin-upload-helpers.js +1 -1
- package/src/vaadin-upload-manager.js +2 -2
- package/src/vaadin-upload-mixin.d.ts +2 -1
- package/src/vaadin-upload-mixin.js +2 -1
- package/src/vaadin-upload.d.ts +8 -8
- package/src/vaadin-upload.js +8 -114
- package/web-types.json +125 -281
- package/web-types.lit.json +90 -97
package/web-types.lit.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.
|
|
4
|
+
"version": "25.2.0-alpha10",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -19,13 +19,6 @@
|
|
|
19
19
|
"description": "`<vaadin-upload-button>` is a button component for file uploads.\nWhen clicked, it opens a file picker dialog and calls addFiles\non a linked UploadManager.\n\n```html\n<vaadin-upload-button>Upload Files</vaadin-upload-button>\n```\n\nThe button must be linked to an UploadManager by setting the\n`manager` property:\n\n```javascript\nconst button = document.querySelector('vaadin-upload-button');\nbutton.manager = uploadManager;\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------|-------------\n`label` | The label (text) inside the button.\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------|-------------\n`active` | Set when the button is pressed down, either with mouse, touch or the keyboard\n`disabled` | Set when the button is disabled\n`focus-ring` | Set when the button is focused using the keyboard\n`focused` | Set when the button is focused\n`has-tooltip` | Set when the button has a slotted tooltip\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------|\n| `--vaadin-button-background` |\n| `--vaadin-button-border-color` |\n| `--vaadin-button-border-radius` |\n| `--vaadin-button-border-width` |\n| `--vaadin-button-font-size` |\n| `--vaadin-button-font-weight` |\n| `--vaadin-button-gap` |\n| `--vaadin-button-height` |\n| `--vaadin-button-line-height` |\n| `--vaadin-button-margin` |\n| `--vaadin-button-padding` |\n| `--vaadin-button-text-color` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
|
-
{
|
|
23
|
-
"name": "?maxFilesReached",
|
|
24
|
-
"description": "True when max files has been reached on the manager.",
|
|
25
|
-
"value": {
|
|
26
|
-
"kind": "expression"
|
|
27
|
-
}
|
|
28
|
-
},
|
|
29
22
|
{
|
|
30
23
|
"name": ".capture",
|
|
31
24
|
"description": "Capture attribute for mobile file input.",
|
|
@@ -34,7 +27,7 @@
|
|
|
34
27
|
}
|
|
35
28
|
},
|
|
36
29
|
{
|
|
37
|
-
"name": "
|
|
30
|
+
"name": "?disabled",
|
|
38
31
|
"description": "Whether the button is disabled.\nReturns true if either explicitly disabled, manager is disabled, or maxFilesReached is true.",
|
|
39
32
|
"value": {
|
|
40
33
|
"kind": "expression"
|
|
@@ -46,6 +39,13 @@
|
|
|
46
39
|
"value": {
|
|
47
40
|
"kind": "expression"
|
|
48
41
|
}
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "?maxFilesReached",
|
|
45
|
+
"description": "True when max files has been reached on the manager.",
|
|
46
|
+
"value": {
|
|
47
|
+
"kind": "expression"
|
|
48
|
+
}
|
|
49
49
|
}
|
|
50
50
|
]
|
|
51
51
|
},
|
|
@@ -61,13 +61,6 @@
|
|
|
61
61
|
"kind": "expression"
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
|
-
{
|
|
65
|
-
"name": "?maxFilesReached",
|
|
66
|
-
"description": "True when max files has been reached on the manager.",
|
|
67
|
-
"value": {
|
|
68
|
-
"kind": "expression"
|
|
69
|
-
}
|
|
70
|
-
},
|
|
71
64
|
{
|
|
72
65
|
"name": ".manager",
|
|
73
66
|
"description": "Reference to an UploadManager.\nWhen set, dropped files will be automatically added to the manager.",
|
|
@@ -78,41 +71,48 @@
|
|
|
78
71
|
]
|
|
79
72
|
},
|
|
80
73
|
{
|
|
81
|
-
"name": "vaadin-upload-file",
|
|
82
|
-
"description": "`<vaadin-upload-file>`
|
|
74
|
+
"name": "vaadin-upload-file-list",
|
|
75
|
+
"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.",
|
|
83
76
|
"extension": true,
|
|
84
77
|
"attributes": [
|
|
85
78
|
{
|
|
86
|
-
"name": "?
|
|
87
|
-
"description": "
|
|
79
|
+
"name": "?disabled",
|
|
80
|
+
"description": "If true, the user cannot interact with this element.",
|
|
88
81
|
"value": {
|
|
89
82
|
"kind": "expression"
|
|
90
83
|
}
|
|
91
84
|
},
|
|
92
85
|
{
|
|
93
|
-
"name": "
|
|
94
|
-
"description": "
|
|
86
|
+
"name": ".i18n",
|
|
87
|
+
"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```",
|
|
95
88
|
"value": {
|
|
96
89
|
"kind": "expression"
|
|
97
90
|
}
|
|
98
91
|
},
|
|
99
92
|
{
|
|
100
|
-
"name": "
|
|
101
|
-
"description": "
|
|
93
|
+
"name": ".manager",
|
|
94
|
+
"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",
|
|
102
95
|
"value": {
|
|
103
96
|
"kind": "expression"
|
|
104
97
|
}
|
|
105
|
-
}
|
|
98
|
+
}
|
|
99
|
+
]
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "vaadin-upload-file",
|
|
103
|
+
"description": "`<vaadin-upload-file>` element represents a file in the file list of `<vaadin-upload>`.\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n-----------------|-------------\n`thumbnail` | Image thumbnail for image files (used with `thumbnails` theme)\n`loader` | Loading spinner (used with `thumbnails` theme)\n`done-icon` | File done status icon\n`warning-icon` | File warning status icon\n`meta` | Container for file name, status and error messages\n`name` | File name\n`error` | Error message, shown when error happens\n`status` | Status message\n`commands` | Container for file command buttons\n`start-button` | Start file upload button\n`retry-button` | Retry file upload button\n`remove-button` | Remove file button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------------|-------------\n`disabled` | Set when the element is disabled\n`focus-ring` | Set when the element is focused using the keyboard.\n`focused` | Set when the element is focused.\n`error` | An error has happened during uploading.\n`indeterminate` | Uploading is in progress, but the progress value is unknown.\n`uploading` | Uploading is in progress.\n`complete` | Uploading has finished successfully.\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------|\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.",
|
|
104
|
+
"extension": true,
|
|
105
|
+
"attributes": [
|
|
106
106
|
{
|
|
107
|
-
"name": "?
|
|
108
|
-
"description": "True if
|
|
107
|
+
"name": "?complete",
|
|
108
|
+
"description": "True if uploading is completed, false otherwise.",
|
|
109
109
|
"value": {
|
|
110
110
|
"kind": "expression"
|
|
111
111
|
}
|
|
112
112
|
},
|
|
113
113
|
{
|
|
114
|
-
"name": "?
|
|
115
|
-
"description": "
|
|
114
|
+
"name": "?disabled",
|
|
115
|
+
"description": "If true, the user cannot interact with this element.",
|
|
116
116
|
"value": {
|
|
117
117
|
"kind": "expression"
|
|
118
118
|
}
|
|
@@ -139,78 +139,64 @@
|
|
|
139
139
|
}
|
|
140
140
|
},
|
|
141
141
|
{
|
|
142
|
-
"name": "
|
|
143
|
-
"description": "
|
|
142
|
+
"name": "?held",
|
|
143
|
+
"description": "True if uploading is not started, false otherwise.",
|
|
144
144
|
"value": {
|
|
145
145
|
"kind": "expression"
|
|
146
146
|
}
|
|
147
147
|
},
|
|
148
148
|
{
|
|
149
|
-
"name": ".
|
|
150
|
-
"description": "
|
|
149
|
+
"name": ".i18n",
|
|
150
|
+
"description": "The object used to localize this component.",
|
|
151
151
|
"value": {
|
|
152
152
|
"kind": "expression"
|
|
153
153
|
}
|
|
154
154
|
},
|
|
155
155
|
{
|
|
156
|
-
"name": "
|
|
157
|
-
"description": "
|
|
156
|
+
"name": "?indeterminate",
|
|
157
|
+
"description": "True if remaining time is unknown, false otherwise.",
|
|
158
158
|
"value": {
|
|
159
159
|
"kind": "expression"
|
|
160
160
|
}
|
|
161
161
|
},
|
|
162
162
|
{
|
|
163
|
-
"name": "
|
|
164
|
-
"description": "
|
|
163
|
+
"name": ".progress",
|
|
164
|
+
"description": "Number representing the uploading progress.",
|
|
165
165
|
"value": {
|
|
166
166
|
"kind": "expression"
|
|
167
167
|
}
|
|
168
168
|
},
|
|
169
169
|
{
|
|
170
|
-
"name": "
|
|
171
|
-
"description": "
|
|
170
|
+
"name": ".status",
|
|
171
|
+
"description": "Uploading status.",
|
|
172
172
|
"value": {
|
|
173
173
|
"kind": "expression"
|
|
174
174
|
}
|
|
175
175
|
},
|
|
176
176
|
{
|
|
177
|
-
"name": "
|
|
178
|
-
"description": "
|
|
179
|
-
"value": {
|
|
180
|
-
"kind": "expression"
|
|
181
|
-
}
|
|
182
|
-
}
|
|
183
|
-
]
|
|
184
|
-
},
|
|
185
|
-
{
|
|
186
|
-
"name": "vaadin-upload-file-list",
|
|
187
|
-
"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.",
|
|
188
|
-
"extension": true,
|
|
189
|
-
"attributes": [
|
|
190
|
-
{
|
|
191
|
-
"name": "?disabled",
|
|
192
|
-
"description": "If true, the user cannot interact with this element.",
|
|
177
|
+
"name": "?uploading",
|
|
178
|
+
"description": "True if uploading is in progress, false otherwise.",
|
|
193
179
|
"value": {
|
|
194
180
|
"kind": "expression"
|
|
195
181
|
}
|
|
196
182
|
},
|
|
197
183
|
{
|
|
198
|
-
"name": "
|
|
199
|
-
"description": "
|
|
184
|
+
"name": "@file-abort",
|
|
185
|
+
"description": "Fired when the abort button is pressed to request aborting the upload of this file.",
|
|
200
186
|
"value": {
|
|
201
187
|
"kind": "expression"
|
|
202
188
|
}
|
|
203
189
|
},
|
|
204
190
|
{
|
|
205
|
-
"name": "
|
|
206
|
-
"description": "
|
|
191
|
+
"name": "@file-retry",
|
|
192
|
+
"description": "Fired when the retry button is pressed to request retrying the upload of this file.",
|
|
207
193
|
"value": {
|
|
208
194
|
"kind": "expression"
|
|
209
195
|
}
|
|
210
196
|
},
|
|
211
197
|
{
|
|
212
|
-
"name": "
|
|
213
|
-
"description": "
|
|
198
|
+
"name": "@file-start",
|
|
199
|
+
"description": "Fired when the start button is pressed to request starting the upload of this file.",
|
|
214
200
|
"value": {
|
|
215
201
|
"kind": "expression"
|
|
216
202
|
}
|
|
@@ -223,43 +209,22 @@
|
|
|
223
209
|
"extension": true,
|
|
224
210
|
"attributes": [
|
|
225
211
|
{
|
|
226
|
-
"name": "
|
|
227
|
-
"description": "
|
|
228
|
-
"value": {
|
|
229
|
-
"kind": "expression"
|
|
230
|
-
}
|
|
231
|
-
},
|
|
232
|
-
{
|
|
233
|
-
"name": "?noAuto",
|
|
234
|
-
"description": "Prevents upload(s) from immediately uploading upon adding file(s).\nWhen set, you must manually trigger uploads using the `uploadFiles` method",
|
|
235
|
-
"value": {
|
|
236
|
-
"kind": "expression"
|
|
237
|
-
}
|
|
238
|
-
},
|
|
239
|
-
{
|
|
240
|
-
"name": "?nodrop",
|
|
241
|
-
"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.",
|
|
242
|
-
"value": {
|
|
243
|
-
"kind": "expression"
|
|
244
|
-
}
|
|
245
|
-
},
|
|
246
|
-
{
|
|
247
|
-
"name": "?withCredentials",
|
|
248
|
-
"description": "Set the withCredentials flag on the request.",
|
|
212
|
+
"name": ".accept",
|
|
213
|
+
"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\"",
|
|
249
214
|
"value": {
|
|
250
215
|
"kind": "expression"
|
|
251
216
|
}
|
|
252
217
|
},
|
|
253
218
|
{
|
|
254
|
-
"name": ".
|
|
255
|
-
"description": "
|
|
219
|
+
"name": ".capture",
|
|
220
|
+
"description": "Pass-through to input's capture attribute. Allows user to trigger device inputs\nsuch as camera or microphone immediately.",
|
|
256
221
|
"value": {
|
|
257
222
|
"kind": "expression"
|
|
258
223
|
}
|
|
259
224
|
},
|
|
260
225
|
{
|
|
261
|
-
"name": "
|
|
262
|
-
"description": "
|
|
226
|
+
"name": "?disabled",
|
|
227
|
+
"description": "If true, the user cannot interact with this element.",
|
|
263
228
|
"value": {
|
|
264
229
|
"kind": "expression"
|
|
265
230
|
}
|
|
@@ -287,7 +252,7 @@
|
|
|
287
252
|
},
|
|
288
253
|
{
|
|
289
254
|
"name": ".i18n",
|
|
290
|
-
"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```",
|
|
255
|
+
"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```",
|
|
291
256
|
"value": {
|
|
292
257
|
"kind": "expression"
|
|
293
258
|
}
|
|
@@ -320,6 +285,20 @@
|
|
|
320
285
|
"kind": "expression"
|
|
321
286
|
}
|
|
322
287
|
},
|
|
288
|
+
{
|
|
289
|
+
"name": "?noAuto",
|
|
290
|
+
"description": "Prevents upload(s) from immediately uploading upon adding file(s).\nWhen set, you must manually trigger uploads using the `uploadFiles` method",
|
|
291
|
+
"value": {
|
|
292
|
+
"kind": "expression"
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": "?nodrop",
|
|
297
|
+
"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.",
|
|
298
|
+
"value": {
|
|
299
|
+
"kind": "expression"
|
|
300
|
+
}
|
|
301
|
+
},
|
|
323
302
|
{
|
|
324
303
|
"name": ".target",
|
|
325
304
|
"description": "The server URL. The default value is an empty string, which means that\n_window.location_ will be used.",
|
|
@@ -341,9 +320,23 @@
|
|
|
341
320
|
"kind": "expression"
|
|
342
321
|
}
|
|
343
322
|
},
|
|
323
|
+
{
|
|
324
|
+
"name": "?withCredentials",
|
|
325
|
+
"description": "Set the withCredentials flag on the request.",
|
|
326
|
+
"value": {
|
|
327
|
+
"kind": "expression"
|
|
328
|
+
}
|
|
329
|
+
},
|
|
344
330
|
{
|
|
345
331
|
"name": "@file-reject",
|
|
346
|
-
"description": "Fired when a file cannot be added to the queue due to a
|
|
332
|
+
"description": "Fired when a file cannot be added to the queue due to a constraint: file size, file type, or maxFiles.",
|
|
333
|
+
"value": {
|
|
334
|
+
"kind": "expression"
|
|
335
|
+
}
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "@file-remove",
|
|
339
|
+
"description": "Fired when a file is removed from the list.",
|
|
347
340
|
"value": {
|
|
348
341
|
"kind": "expression"
|
|
349
342
|
}
|
|
@@ -364,21 +357,21 @@
|
|
|
364
357
|
},
|
|
365
358
|
{
|
|
366
359
|
"name": "@upload-abort",
|
|
367
|
-
"description": "Fired when
|
|
360
|
+
"description": "Fired when upload abort is requested. If the default is prevented, the upload is not aborted.",
|
|
368
361
|
"value": {
|
|
369
362
|
"kind": "expression"
|
|
370
363
|
}
|
|
371
364
|
},
|
|
372
365
|
{
|
|
373
366
|
"name": "@upload-before",
|
|
374
|
-
"description": "Fired before the XHR is opened.
|
|
367
|
+
"description": "Fired before the XHR is opened. Useful for changing the request URL. If the default is prevented, the XHR is not opened.",
|
|
375
368
|
"value": {
|
|
376
369
|
"kind": "expression"
|
|
377
370
|
}
|
|
378
371
|
},
|
|
379
372
|
{
|
|
380
373
|
"name": "@upload-error",
|
|
381
|
-
"description": "Fired
|
|
374
|
+
"description": "Fired when the upload process fails.",
|
|
382
375
|
"value": {
|
|
383
376
|
"kind": "expression"
|
|
384
377
|
}
|
|
@@ -392,21 +385,21 @@
|
|
|
392
385
|
},
|
|
393
386
|
{
|
|
394
387
|
"name": "@upload-request",
|
|
395
|
-
"description": "Fired when the XHR has been opened but not sent yet. Useful for appending
|
|
388
|
+
"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.",
|
|
396
389
|
"value": {
|
|
397
390
|
"kind": "expression"
|
|
398
391
|
}
|
|
399
392
|
},
|
|
400
393
|
{
|
|
401
394
|
"name": "@upload-response",
|
|
402
|
-
"description": "Fired when
|
|
395
|
+
"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.",
|
|
403
396
|
"value": {
|
|
404
397
|
"kind": "expression"
|
|
405
398
|
}
|
|
406
399
|
},
|
|
407
400
|
{
|
|
408
401
|
"name": "@upload-retry",
|
|
409
|
-
"description": "Fired when retry upload is requested. If the default is prevented,
|
|
402
|
+
"description": "Fired when retry upload is requested. If the default is prevented, the retry is not performed.",
|
|
410
403
|
"value": {
|
|
411
404
|
"kind": "expression"
|
|
412
405
|
}
|
|
@@ -420,7 +413,7 @@
|
|
|
420
413
|
},
|
|
421
414
|
{
|
|
422
415
|
"name": "@upload-success",
|
|
423
|
-
"description": "Fired
|
|
416
|
+
"description": "Fired when the upload process succeeds.",
|
|
424
417
|
"value": {
|
|
425
418
|
"kind": "expression"
|
|
426
419
|
}
|