Skip to content

Commit

Permalink
rc.2
Browse files Browse the repository at this point in the history
Dispatch event instead of using a.click()
closes #465

added a changelog
closes #466

Made third argument as a object instead for easier transition to v2
  • Loading branch information
jimmywarting committed Sep 26, 2018
1 parent f3b45ae commit 70c261d
Show file tree
Hide file tree
Showing 8 changed files with 106 additions and 37 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ import { saveAs } from 'file-saver/FileSaver';
```

```js
FileSaver saveAs(Blob/File/Url, optional DOMString filename, optional Boolean autoBOM)
FileSaver saveAs(Blob/File/Url, optional DOMString filename, optional Object { autoBOM })
```

Pass `true` for `autoBOM` if you want FileSaver.js to automatically provide Unicode text encoding hints (see: [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark)).
Pass `{ autoBOM: true }` if you want FileSaver.js to automatically provide Unicode text encoding hints (see: [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark)).

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "file-saver",
"main": "dist/FileSaver.min.js",
"version": "2.0.0-rc.1",
"version": "2.0.0-rc.2",
"homepage": "/~https://github.com/eligrey/FileSaver.js",
"authors": [
"Eli Grey <me@eligrey.com>"
Expand Down
30 changes: 30 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0-rc.2] - 2018-09-26

- Added a changelog.md
- Reverted `a.click()` to use dispatch with a try-catch (#382)
- Made third argument to an object where you have to pass `{ autoBom: true }`
- boolean are depricated but still works

## [2.0.0-rc.1] - 2018-09-26

- saveAs don't return anything
- The object that dispatched `writestart progress write writeend` are gone
- detecting such features was never possible and nobody seems to use it.
- Removed the demo folder
- Removed date/version from top of the file
- Dosen't crash in web workers (#449)
- Support saving urls (#260 with workarounds for cross origin)
- Uses babel universal module pattern (UMD) to export the package
- Provides source map now as well.
- use a[download] before msSaveAs (#193, #294)
- removed dist from .gitignore (npm uses it if it don't find a .npmignore)
- autoBom is now reversed so you have to tell when you want to use autoBom (#432)
- `a.click()` since there are new and depricated event constructors that works differently (#382)
- opens up a new popup (tab) directly for the fallback method since the FileReader is async
- removed the explicitly MSIE [1-9] check
52 changes: 37 additions & 15 deletions dist/FileSaver.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,18 @@
}
}();

function bom(blob, autoBom) {
if (!autoBom) return blob; // prepend BOM for UTF-8 XML and text/* types (including HTML)
function bom(blob, opts) {
if (typeof opts === 'undefined') opts = {
autoBom: false
};else if (typeof opts !== 'object') {
console.warn('Depricated: Expected third argument to be a object');
opts = {
autoBom: !opts
};
} // prepend BOM for UTF-8 XML and text/* types (including HTML)
// note: your browser will automatically convert UTF-16 U+FEFF to EF BB BF

if (/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(blob.type)) {
if (opts.autoBom && /^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(blob.type)) {
return new Blob([String.fromCharCode(0xFEFF), blob], {
type: blob.type
});
Expand All @@ -53,13 +60,13 @@
return blob;
}

function download(url, name, autoBom) {
function download(url, name, opts) {
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.responseType = 'blob';

xhr.onload = function () {
saveAs(xhr.response, name, autoBom);
saveAs(xhr.response, name, opts);
};

xhr.onerror = function () {
Expand All @@ -75,13 +82,24 @@
xhr.open('HEAD', url, false);
xhr.send();
return xhr.status >= 200 && xhr.status <= 299;
} // `a.click()` don't work for all browsers (#465)


function click(node) {
try {
node.dispatchEvent(new MouseEvent('click'));
} catch (e) {
var evt = document.createEvent('MouseEvents');
evt.initMouseEvent('click', true, true, window, 0, 0, 0, 80, 20, false, false, false, false, 0, null);
node.dispatchEvent(evt);
}
}

var saveAs = _global.saveAs || // probably in some web worker
typeof window !== 'object' || window !== _global ? function saveAs() {}
/* noop */
// Use download attribute first if possible (#193 Lumia mobile)
: 'download' in HTMLAnchorElement.prototype ? function saveAs(blob, name, autoBom) {
: 'download' in HTMLAnchorElement.prototype ? function saveAs(blob, name, opts) {
var URL = _global.URL || _global.webkitURL;
var a = document.createElement('a');
name = name || blob.name || 'download';
Expand All @@ -95,9 +113,9 @@
a.href = blob;

if (a.origin !== location.origin) {
corsEnabled(a.href) ? download(blob, name, autoBom) : a.click(a.target = '_blank');
corsEnabled(a.href) ? download(blob, name, opts) : click(a, a.target = '_blank');
} else {
a.click();
click(a);
}
} else {
// Support blobs
Expand All @@ -106,26 +124,30 @@
URL.revokeObjectURL(a.href);
}, 4E4); // 40s

setTimeout(a.click.bind(a), 0);
setTimeout(function () {
click(a);
}, 0);
}
} // Use msSaveOrOpenBlob as a second approch
: 'msSaveOrOpenBlob' in navigator ? function saveAs(blob, name, autoBom) {
: 'msSaveOrOpenBlob' in navigator ? function saveAs(blob, name, opts) {
name = name || blob.name || 'download';

if (typeof blob === 'string') {
if (corsEnabled(blob)) {
download(blob, name, autoBom);
download(blob, name, opts);
} else {
var a = document.createElement('a');
a.href = blob;
a.target = '_blank';
setTimeout(a.click.bind(a));
setTimeout(function () {
clikc(a);
});
}
} else {
navigator.msSaveOrOpenBlob(bom(blob, autoBom), name);
navigator.msSaveOrOpenBlob(bom(blob, opts), name);
}
} // Fallback to using FileReader and a popup
: function saveAs(blob, name, autoBom, popup) {
: function saveAs(blob, name, opts, popup) {
// Open a popup immediately do go around popup blocker
// Mostly only avalible on user interaction and the fileReader is async so...
popup = popup || open('', '_blank');
Expand All @@ -134,7 +156,7 @@
popup.document.title = popup.document.body.innerText = 'downloading...';
}

if (typeof blob === 'string') return download(blob, name, autoBom);
if (typeof blob === 'string') return download(blob, name, opts);
var force = blob.type === 'application/octet-stream';

var isSafari = /constructor/i.test(_global.HTMLElement) || _global.safari;
Expand Down
2 changes: 1 addition & 1 deletion dist/FileSaver.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 70c261d

Please sign in to comment.