Jordan Austin
c6fd9c65d6
The goal is to begin making this more understandable for people confused about what FileSaver is and how it can work across all browsers.
78 lines
2.8 KiB
Markdown
78 lines
2.8 KiB
Markdown
FileSaver.js
|
|
============
|
|
|
|
FileSaver.js implements the W3C `saveAs()` [FileSaver][1] interface in browsers that do
|
|
not natively support it. There is a [FileSaver.js demo][2] that demonstrates saving
|
|
various media types.
|
|
|
|
FileSaver.js is the solution to saving files on the client side, and is perfect for
|
|
webapps that need to generate files or for saving sensitive information that shouldn't be
|
|
sent to an external server.
|
|
|
|
|
|
Supported Browsers
|
|
------------------
|
|
|
|
| Browser | Support Type | Filenames | Size | Dependancies |
|
|
| ------------- | ------------- | ------------ | ---------- | ------------ |
|
|
| Firefox 20+ | Blob | Yes | 800MiB/per | None |
|
|
| Firefox ≤19 | dataURL | No | | [Blob.js](https://github.com/eligrey/Blob.js) |
|
|
| Google Chrome | Blob | Yes | 354MiB/per | None |
|
|
| IE 10+ | Blob | Yes | 600MiB/per | None |
|
|
| Opera Next | Blob | Yes | | None |
|
|
| Opera ≤15 | datURL | No | | [Blob.js](https://github.com/eligrey/Blob.js) |
|
|
| Safari ≤6 | dataURL | No | | [Blob.js](https://github.com/eligrey/Blob.js) |
|
|
|
|
Note: Unlisted versions or browsers will probably work too; however only the ones listed above have been tested.
|
|
|
|
Feature detection is possible:
|
|
|
|
try { var isFileSaverSupported = !!new Blob(); } catch(e){}
|
|
|
|
Syntax
|
|
------
|
|
|
|
FileSaver saveAs(in Blob data, in DOMString filename)
|
|
|
|
Examples
|
|
--------
|
|
|
|
### Saving text
|
|
|
|
var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"});
|
|
saveAs(blob, "hello world.txt");
|
|
|
|
The standard W3C File API [`Blob`][3] interface is not available in all browsers.
|
|
[Blob.js][4] is a cross-browser `Blob` implementation that solves this.
|
|
|
|
### Saving a canvas
|
|
|
|
var canvas = document.getElementById("my-canvas"), ctx = canvas.getContext("2d");
|
|
// draw to canvas...
|
|
canvas.toBlob(function(blob) {
|
|
saveAs(blob, "pretty image.png");
|
|
});
|
|
|
|
Note: The standard HTML5 `canvas.toBlob()` method is not available in all browsers.
|
|
[canvas-toBlob.js][5] is a cross-browser `canvas.toBlob()` implementation that solves
|
|
this.
|
|
|
|
### Aborting a save
|
|
|
|
var filesaver = saveAs(blob, "whatever");
|
|
cancel_button.addEventListener("click", function() {
|
|
if (filesaver.abort) {
|
|
filesaver.abort();
|
|
}
|
|
}, false);
|
|
|
|
This isn't that useful unless you're saving very large files (e.g. generated video).
|
|
|
|
|
|
|
|
[1]: http://www.w3.org/TR/file-writer-api/#the-filesaver-interface
|
|
[2]: http://eligrey.com/demos/FileSaver.js/
|
|
[3]: https://developer.mozilla.org/en-US/docs/DOM/Blob
|
|
[4]: https://github.com/eligrey/Blob.js
|
|
[5]: https://github.com/eligrey/canvas-toBlob.js
|