Angular File Saver

Angular File Saver is an AngularJS service that leverages FileSaver.js and Blob.js to implement the HTML5 W3C saveAs() interface in browsers that do not natively support it

Dependencies

• Angular
• FileSaver.js
• Blob.js

File dist/angular-file-saver.bundle.js contains all required dependencies and grants access to both Blob.js and FileSaver.js polyfills via Blob and SaveAs services.

Installation

1# Using bower:
2$ bower install angular-file-saver
3
4# Using npm:
5$ npm install angular-file-saver

Basic usage

• Include the ngFileSaver module into your project;
• Pass both FileSaver and Blob services as dependencies;
• Create a Blob object passing an array with data as a first argument and an object with set of options as the second one: new Blob(['text'], { type: 'text/plain;charset=utf-8' });
• Invoke FileSaver.saveAs with the following arguments:
  • data Blob: a Blob instance;
  • filename String: Custom filename (extension is optional);
  • disableAutoBOM Boolean: (optional) Disable automatically provided Unicode text encoding hints;

Demo

API

FileSaver

#saveAs(data, filename[, disableAutoBOM])

Immediately starts saving a file

Parameters

• Blob data: a Blob instance;
• String filename: Custom filename (extension is optional);
• Boolean disableAutoBOM : (optional) Disable automatically provided Unicode text encoding hints;

Blob(blobParts[, options]))

An Angular factory that returns a Blob instance. Blob API on MDN

SaveAs(data, filename[, disableAutoBOM])

An Angular factory that returns a FileSaver.js saveAs polyfill. FileSaver.js documentation

Example

JS

1function ExampleCtrl(FileSaver, Blob) {
2  var vm = this;
3
4  vm.val = {
5    text: 'Hey ho lets go!'
6  };
7
8  vm.download = function(text) {
9    var data = new Blob([text], { type: 'text/plain;charset=utf-8' });
10    FileSaver.saveAs(data, 'text.txt');
11  };
12}
13
14angular
15  .module('fileSaverExample', ['ngFileSaver'])
16  .controller('ExampleCtrl', ['FileSaver', 'Blob', ExampleCtrl]);

HTML

1<div class="wrapper" ng-controller="ExampleCtrl as vm">
2  <textarea
3    ng-model="vm.val.text"
4    name="textarea" rows="5" cols="20">
5      Hey ho let's go!
6  </textarea>
7  <a href="" class="btn btn-dark btn-small" ng-click="vm.download(vm.val.text)">
8    Download
9  </a>
10</div>

License

MIT © Philipp Alferov