Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document XMLHttpRequestUpload (#25671)
* Document XMLHttpRequestUpload * Fixes * Fixes * Fixes typos * Fixes typos * Add example * Document XMLHttpRequestUpload * Fixes * Fixes * Fixes typos * Update files/en-us/web/api/xmlhttprequestupload/index.md Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com> * Minor fixes * Fix flaws * Simplify examples * Fix sidebar * Fix typo * Fix flaws * Update files/en-us/web/api/xmlhttprequestupload/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> * Update files/en-us/web/api/xmlhttprequestupload/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> * Update files/en-us/web/api/xmlhttprequestupload/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> * Update files/en-us/web/api/xmlhttprequestupload/load_event/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> * Update files/en-us/web/api/xmlhttprequestupload/loadend_event/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> * Update files/en-us/web/api/xmlhttprequestupload/loadstart_event/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> * Update files/en-us/web/api/xmlhttprequestupload/timeout_event/index.md Co-authored-by: Florian Scholz <fs@florianscholz.com> --------- Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com> Co-authored-by: Florian Scholz <fs@florianscholz.com>
- Loading branch information
1 parent
ab97df6
commit 74cf7a1
Showing
11 changed files
with
680 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 66 additions & 0 deletions
66
files/en-us/web/api/xmlhttprequestupload/abort_event/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
--- | ||
title: "XMLHttpRequestUpload: abort event" | ||
slug: Web/API/XMLHttpRequestUpload/abort_event | ||
page-type: web-api-event | ||
browser-compat: api.XMLHttpRequestUpload.abort_event | ||
--- | ||
|
||
{{APIRef}} | ||
|
||
The `abort` event is fired at {{domxref("XMLHttpRequestUpload")}} when a request has been aborted, for example because the program called {{domxref("XMLHttpRequest.abort()")}}. | ||
|
||
## Syntax | ||
|
||
Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property. | ||
|
||
```js | ||
addEventListener('abort', (event) => { }) | ||
|
||
onabort = (event) => { } | ||
``` | ||
|
||
## Event type | ||
|
||
A {{domxref("ProgressEvent")}}. Inherits from {{domxref("Event")}}. | ||
|
||
{{InheritanceDiagram("ProgressEvent")}} | ||
|
||
## Event properties | ||
|
||
_In addition to the properties listed below, properties from the parent interface, {{domxref("Event")}}, are available._ | ||
|
||
- {{domxref("ProgressEvent.lengthComputable", "lengthComputable")}} {{ReadOnlyInline}} | ||
- : A boolean flag indicating if the total work to be done, and the amount of work already done, by the underlying process is calculable. In other words, it tells if the progress is measurable or not. | ||
- {{domxref("ProgressEvent.loaded", "loaded")}} {{ReadOnlyInline}} | ||
- : A 64-bit unsigned integer value indicating the amount of work already performed by the underlying process. The ratio of work done can be calculated by dividing `total` by the value of this property. When downloading a resource using HTTP, this only counts the body of the HTTP message, and doesn't include headers and other overhead. | ||
- {{domxref("ProgressEvent.total", "total")}} {{ReadOnlyInline}} | ||
- : A 64-bit unsigned integer representing the total amount of work that the underlying process is in the progress of performing. When downloading a resource using HTTP, this is the `Content-Length` (the size of the body of the message), and doesn't include the headers and other overhead. | ||
|
||
## Examples | ||
|
||
### Using the `abort` event | ||
|
||
You can use the `abort` event to stop the upload before it finishes. For a complete code example that uploads a file and displays a progress bar, see the main {{domxref("XMLHttpRequestUpload")}} page. | ||
|
||
```js | ||
// In case of an abort we hide the progress bar | ||
// Note that this event can be listened to on the xhr object too | ||
function errorAction(event) { | ||
progressBar.classList.remove("visible"); | ||
log.textContent = `Upload failed: ${event.type}`; | ||
} | ||
xhr.upload.addEventListener("abort", errorAction); | ||
``` | ||
|
||
## Specifications | ||
|
||
{{Specifications}} | ||
|
||
## Browser compatibility | ||
|
||
{{Compat}} | ||
|
||
## See also | ||
|
||
- Related events: {{domxref("XMLHttpRequestUpload/loadstart_event", "loadstart")}}, {{domxref("XMLHttpRequestUpload/load_event", "load")}}, {{domxref("XMLHttpRequestUpload/progress_event", "progress")}}, {{domxref("XMLHttpRequestUpload/error_event", "error")}}, {{domxref("XMLHttpRequestUpload/loadend_event", "loadend")}}, {{domxref("XMLHttpRequestUpload/timeout_event", "timeout")}} | ||
- {{domxref("XMLHttpRequestUpload")}} |
66 changes: 66 additions & 0 deletions
66
files/en-us/web/api/xmlhttprequestupload/error_event/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
--- | ||
title: "XMLHttpRequestUpload: error event" | ||
slug: Web/API/XMLHttpRequestUpload/error_event | ||
page-type: web-api-event | ||
browser-compat: api.XMLHttpRequestUpload.error_event | ||
--- | ||
|
||
{{APIRef}} | ||
|
||
The `error` event is fired when the request encountered an error. | ||
|
||
## Syntax | ||
|
||
Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property. | ||
|
||
```js | ||
addEventListener('error', (event) => { }) | ||
|
||
onerror = (event) => { } | ||
``` | ||
|
||
## Event type | ||
|
||
A {{domxref("ProgressEvent")}}. Inherits from {{domxref("Event")}}. | ||
|
||
{{InheritanceDiagram("ProgressEvent")}} | ||
|
||
## Event properties | ||
|
||
_In addition to the properties listed below, properties from the parent interface, {{domxref("Event")}}, are available._ | ||
|
||
- {{domxref("ProgressEvent.lengthComputable", "lengthComputable")}} {{ReadOnlyInline}} | ||
- : A boolean flag indicating if the total work to be done, and the amount of work already done, by the underlying process is calculable. In other words, it tells if the progress is measurable or not. | ||
- {{domxref("ProgressEvent.loaded", "loaded")}} {{ReadOnlyInline}} | ||
- : A 64-bit unsigned integer value indicating the amount of work already performed by the underlying process. The ratio of work done can be calculated by dividing `total` by the value of this property. When downloading a resource using HTTP, this only counts the body of the HTTP message, and doesn't include headers and other overhead. | ||
- {{domxref("ProgressEvent.total", "total")}} {{ReadOnlyInline}} | ||
- : A 64-bit unsigned integer representing the total amount of work that the underlying process is in the progress of performing. When downloading a resource using HTTP, this is the `Content-Length` (the size of the body of the message), and doesn't include the headers and other overhead. | ||
|
||
## Examples | ||
|
||
### Using the `error` event | ||
|
||
You can use the `error` event to detect a problem with the upload. For a complete code example that uploads a file and displays a progress bar, see the main {{domxref("XMLHttpRequestUpload")}} page. | ||
|
||
```js | ||
// In case of an error we hide the progress bar | ||
// Note that this event can be listened to on the xhr object too | ||
function errorAction(event) { | ||
progressBar.classList.remove("visible"); | ||
log.textContent = `Upload failed: ${event.type}`; | ||
} | ||
xhr.upload.addEventListener("error", errorAction); | ||
``` | ||
|
||
## Specifications | ||
|
||
{{Specifications}} | ||
|
||
## Browser compatibility | ||
|
||
{{Compat}} | ||
|
||
## See also | ||
|
||
- Related events: {{domxref("XMLHttpRequestUpload/loadstart_event", "loadstart")}}, {{domxref("XMLHttpRequestUpload/load_event", "load")}}, {{domxref("XMLHttpRequestUpload/progress_event", "progress")}}, {{domxref("XMLHttpRequestUpload/abort_event", "abort")}}, {{domxref("XMLHttpRequestUpload/loadend_event", "loadend")}}, {{domxref("XMLHttpRequestUpload/timeout_event", "timeout")}} | ||
- {{domxref("XMLHttpRequestUpload")}} |
Oops, something went wrong.