html5-filesaver.js

FileSaver.js
============

FileSaver.js implements the HTML5 W3C saveAs() FileSaver interface in browsers that do
not natively support it. There is a [FileSaver.js demo][1] 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.

Bower Installation
------------------

``bash
bower install FileSaver.js --save-dev
`

Looking for canvas.toBlob() for saving canvases? Check out
[canvas-toBlob.js][2] for a cross-browser implementation.

Supported browsers
------------------

| Browser | Constructs as | Filenames | Max Blob Size | Dependencies |
| -------------- | ------------- | ------------ | ------------- | ------------ |
| Firefox 20+ | Blob | Yes | 800 MiB | None |
| Firefox < 20 | data: URI | No | n/a | [Blob.js][5] |
| Chrome | Blob | Yes | [500 MiB][3] | None |
| Chrome for Android | Blob | Yes | [500 MiB][3] | None |
| IE 10+ | Blob | Yes | 600 MiB | None |
| Opera 15+ | Blob | Yes | 500 MiB | None |
| Opera < 15 | data: URI | No | n/a | [Blob.js][5] |
| Safari 6.1+* | Blob | No | ? | None |
| Safari < 6 | data: URI | No | n/a | [Blob.js][5] |

Feature detection is possible:

`js
try {
var isFileSaverSupported = !!new Blob;
} catch (e) {}
`

$3

It is possible to save text files in IE < 10 without Flash-based polyfills.
See ChenWenBrian and koffsyrup's saveTextAs() for more details.

$3

Blobs may be opened instead of saved sometimes—you may have to direct your Safari users to manually
press ⌘+S to save the file after it is opened. Using the application/octet-stream MIME type
to force downloads can cause issues in Safari.

$3

saveAs must be run within a user interaction event such as onTouchDown or onClick; setTimeout will prevent saveAs from triggering.
Due to restrictions in iOS saveAs opens in a new window instead of downloading, if you want this fixed please
tell Apple how this bug is affecting you.

Syntax
------

`js
FileSaver saveAs(in Blob data, in DOMString filename)
`

Examples
--------

$3

`js
var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"});
saveAs(blob, "hello world.txt");
`

The standard W3C File API [Blob][4] interface is not available in all browsers.
[Blob.js][5] is a cross-browser Blob implementation that solves this.

$3

`js
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][6] is a cross-browser canvas.toBlob() that polyfills this.


!Tracking image


Contributing
------------

The FileSaver.js is the development code, and are not minified.
The FileSaver.min.js is the production code, and are minified using uglifyjs.

You need to install [NodeJs][7] and [Grunt][8].

Installing Dependencies:
`bash
npm install
`

Please make sure you run grunt build` before submitting a pull request.

[1]: http://eligrey.com/demos/FileSaver.js/
[2]: https://github.com/eligrey/canvas-toBlob.js
[3]: https://code.google.com/p/chromium/issues/detail?id=375297
[4]: https://developer.mozilla.org/en-US/docs/DOM/Blob
[5]: https://github.com/eligrey/Blob.js
[6]: https://github.com/eligrey/canvas-toBlob.js
[7]: https://nodejs.org/download/
[8]: http://gruntjs.com/getting-started