Skip to content

Latest commit

 

History

History
143 lines (102 loc) · 4.29 KB

Readme.md

File metadata and controls

143 lines (102 loc) · 4.29 KB
Raw
  • Browserified version of pdfmake.
  • Can be used effortlessly with e.g. AngularJS.
  • Default font Roboto included, thus zero configuration.
  • Supports custom fonts (find prepared fonts here: Prepared Google Fonts).

Installation

npm install pdfmake-browserified

Node Usage

Default Font: Roboto

var createPdf = require('pdfmake-browserified');
var dd = { content: "This is a sample PDF printed with pdfMake" };
createPdf(dd).open();

Custom Font: Junge

Find prepared fonts for Node here: Prepared Google Fonts.

var createPdf = require('pdfmake-browserified');
var map = require('<path to>/browserified/ofl/junge.map.js'); // font style mapping
var data = require('<path to>/browserified/ofl/junge.js'); // font data

var defaultFont = Object.keys(map)[0];
var dd = {
	content: "This is a sample PDF printed with pdfMake",
	defaultStyle: { font: defaultFont }
};
createPdf(dd, map, data).open();

Browser Usage

Default Font: Roboto

<!doctype html>
 <html lang='en'>
 <head>
 	<meta charset='utf-8'>
 	<title>Google Fonts with regular pdfmake</title>
 	<script src='<your path>/pdfmake-browserified.min.js'></script>
 </head>
 <body>
    <input type="button" onclick="openPdf()" value="Open PDF"></input>
     <script>
        function openPdf() {
            var docDefinition = { content: "This is a sample PDF printed with pdfMake" };
            createPdf(docDefinition).open();
        }
     </script>
 </body>
</html>

Custom Font: Junge

Find prepared fonts for Browser here: Prepared Google Fonts.

<!doctype html>
 <html lang='en'>
 <head>
 	<meta charset='utf-8'>
 	<title>Google Fonts with regular pdfmake</title>
 	<script src='<your path>/pdfmake-browserified.min.js'></script>
 	<script src='<your path>/ofl/junge.js'></script><!-- the font data -->
 	<script src='<your path>/ofl/junge.map.js'></script><!-- the font-style mapping -->
 </head>
 <body>
    <input type="button" onclick="openPdf()" value="Open PDF"></input>
     <script>
        function openPdf() {
            var docDefinition = {
                content: "This is a sample PDF printed with pdfMake",
                defaultStyle: { font: Object.keys(pdfMake.fonts)[0] }
            };
            createPdf(docDefinition, pdfMake.fonts, pdfMake.vfs).open();
        }
     </script>
 </body>
</html>

Motivation

Providing pdfmake as an npm module, which can be required.

Removing boilerplate code, that is required when one uses pdfmake with frameworks line AngularJS.

Tests

A small AngularJS example is provided in the test directory.

The commands below will build the module bundle and open a browser. The page provides buttons to check open and download capabilities manually.

npm install
npm start

Minification for Production

During your production builds, including this module, you want to exclude this module from minification/uglification/compression, as it is already minified. The same is true for custom fonts. Both are pretty big and will slow minification/uglification/compression down.

Comparing pdfmake-browserified and pdfmake

pdfmake-browserified can be used like the original pdfmake via script-tag in an HTML page. With the same method signature: createPdf(docDefinition, fonts, vfs).open();

But: It can be used via require('pdfmake-browserify') in Node applications, too. In Node, the method signature stays the same: createPdf(docDefinition, fonts, vfs).open();

Contributors

xErik

Other Projects

NPM pdfmake-browserified MIT License

GIT pdfmake-browserified MIT License

pdfmake MIT License

Roboto Apache License

Junge OFL License

Note

I did this for fun. Contributions from people with a more solid node background are welcome!

License

MIT