npmpackage.info

Gathering detailed insights and metrics for @travelhubx/docxtemplater-image-module-free

@travelhubx/docxtemplater-image-module-free - 1.1.0 | npmpackage.info

@travelhubx/docxtemplater-image-module-free

Open Source Image Module for docxtemplater

1.1.0

NOASSERTION

JavaScript

257.37 kB

Installations

npm install @travelhubx/docxtemplater-image-module-free

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.16.0

NPM Version

9.5.1 Pull Requests

Open

1

Total

1

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

eturiatravel

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

164 Commits

1 Forks

1 Branches

Updated on Jun 28, 2023

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

1.1.0

Package Id

@travelhubx/docxtemplater-image-module-free@1.1.0

Unpacked Size

257.37 kB

Size

65.10 kB

File Count

NPM Version

9.5.1

Node Version

18.16.0

Published on

Jun 28, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

xmldom

Dev Dependencies

babel-cli babel-eslint babel-preset-es2015 browserify chai docxtemplater eslint image-size istanbul jszip mkdirp mocha rimraf uglifyjs

Open Source docxtemplater image module

This repository holds an maintained version of docxtemplater image module.

This package is open source. There is also a paid version maintained by docxtemplater author.

Note this version is compatible with docxtemplater 3.x.

Installation

You first need to install docxtemplater by following its installation guide.

For Node.js install this package:

1npm install docxtemplater-image-module-free

For the browser find builds in build/ directory.

Alternatively, you can create your own build from the sources:

1npm run compile
2npm run browserify
3npm run uglify

Usage

Assuming your docx or pptx template contains only the text {%image}:

1//Node.js example
2var ImageModule = require('open-docxtemplater-image-module');
3
4//Below the options that will be passed to ImageModule instance
5var opts = {}
6opts.centered = false; //Set to true to always center images
7opts.fileType = "docx"; //Or pptx
8
9//Pass your image loader
10opts.getImage = function(tagValue, tagName) {
11    //tagValue is 'examples/image.png'
12    //tagName is 'image'
13    return fs.readFileSync(tagValue);
14}
15
16//Pass the function that return image size
17opts.getSize = function(img, tagValue, tagName) {
18    //img is the image returned by opts.getImage()
19    //tagValue is 'examples/image.png'
20    //tagName is 'image'
21    //tip: you can use node module 'image-size' here
22    return [150, 150];
23}
24
25var imageModule = new ImageModule(opts);
26
27var zip = new JSZip(content);
28var doc = new Docxtemplater()
29    .attachModule(imageModule)
30    .loadZip(zip)
31    .setData({image: 'examples/image.png'})
32    .render();
33
34var buffer = doc
35        .getZip()
36        .generate({type:"nodebuffer"});
37
38fs.writeFile("test.docx",buffer);

Some notes regarding templates:

docx files: the placeholder {%image} must be in a dedicated paragraph.
pptx files: the placeholder {%image} must be in a dedicated text cell.

In the browser, this shows how to get the image asynchronously :

1<html>
2<script src="node_modules/docxtemplater/build/docxtemplater.js"></script>
3<script src="node_modules/jszip/dist/jszip.js"></script>
4<script src="node_modules/jszip/vendor/FileSaver.js"></script>
5<script src="node_modules/jszip-utils/dist/jszip-utils.js"></script>
6<script src="build/imagemodule.js"></script>
7<script>
8  JSZipUtils.getBinaryContent('examples/image-example.docx', function (error, content) {
9    if (error) {
10      console.error(error);
11      return;
12    }
13    var opts = {}
14    opts.centered = false;
15    opts.getImage = function (tagValue, tagName) {
16      return new Promise(function (resolve, reject) {
17        JSZipUtils.getBinaryContent(tagValue, function (error, content) {
18          if (error) {
19            return reject(error);
20          }
21          return resolve(content);
22        });
23      });
24    }
25    opts.getSize = function (img, tagValue, tagName) {
26      // FOR FIXED SIZE IMAGE :
27      return [150, 150];
28
29      // FOR IMAGE COMING FROM A URL (IF TAGVALUE IS AN ADRESS) :
30      // To use this feature, you have to be using docxtemplater async
31      // (if you are calling setData(), you are not using async).
32      return new Promise(function (resolve, reject) {
33        var image = new Image();
34        image.src = url;
35        image.onload = function () {
36          resolve([image.width, image.height]);
37        };
38        image.onerror = function (e) {
39          console.log('img, tagValue, tagName : ', img, tagValue, tagName);
40          alert("An error occured while loading " + tagValue);
41          reject(e);
42        }
43      });
44    }
45
46    var imageModule = new ImageModule(opts);
47
48    var zip = new JSZip(content);
49    var doc = new docxtemplater()
50      .loadZip(zip)
51      .attachModule(imageModule)
52      .compile();
53
54    doc.resolveData({
55      image: 'examples/image.png'
56    }).then(function () {
57      console.log('ready');
58      doc.render();
59      var out = doc.getZip().generate({
60        type: "blob",
61        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
62      });
63      saveAs(out, "generated.docx");
64    })
65  });
66</script>
67
68</html>

Centering images

You can center all images by setting the global switch to true opts.centered = true.

If you would like to choose which images should be centered one by one:

Set the global switch to false opts.centered = false.
Use {%image} for images that shouldn't be centered.
Use {%%image} for images that you would like to see centered.

In pptx generated documents, images are centered vertically and horizontally relative to the parent cell.

Async support

It is possible to get images asynchronously by returning a Promise in the getImage function and use the docxtemplater async api : http://docxtemplater.readthedocs.io/en/latest/async.html

You can also return a promise in the getSize function if you want to resolve the size asynchronously (like in the browser example above).

Here is an example in node that allows you to retrieve values from an URL and use a fixed width, and keep the aspect ratio.

1const fs = require("fs");
2const DocxTemplater = require("docxtemplater");
3const https = require("https");
4const Stream = require("stream").Transform;
5
6const ImageModule = require("./es6");
7const JSZip = require("jszip");
8
9const content = fs.readFileSync("demo_template.docx");
10
11const data = {
12  image: "https://docxtemplater.com/xt-pro.png"
13};
14
15const opts = {};
16opts.getImage = function (tagValue, tagName) {
17  console.log(tagValue, tagName);
18  // tagValue is "https://docxtemplater.com/xt-pro-white.png" and tagName is "image"
19  return new Promise(function (resolve, reject) {
20    getHttpData(tagValue, function (err, data) {
21      if (err) {
22        return reject(err);
23      }
24      resolve(data);
25    });
26  });
27};
28
29opts.getSize = function (img, tagValue, tagName) {
30  console.log(tagValue, tagName);
31  // img is the value that was returned by getImage
32  // This is to force the width to 600px, but keep the same aspect ration
33  const sizeOf = require("image-size");
34  const sizeObj = sizeOf(img);
35  console.log(sizeObj);
36  const forceWidth = 600;
37  const ratio = forceWidth / sizeObj.width;
38  return [
39    forceWidth,
40    // calculate height taking into account aspect ratio
41    Math.round(sizeObj.height * ratio),
42  ];
43};
44
45const imageModule = new ImageModule(opts);
46
47const zip = new JSZip(content);
48const doc = new DocxTemplater()
49  .loadZip(zip)
50  .attachModule(imageModule)
51  .compile();
52
53doc
54  .resolveData(data)
55  .then(function () {
56    console.log("data resolved");
57    doc.render();
58    const buffer = doc
59      .getZip()
60      .generate({
61        type: "nodebuffer",
62        compression: "DEFLATE"
63      });
64
65    fs.writeFileSync("test.docx", buffer);
66    console.log("rendered");
67  })
68  .catch(function (error) {
69    console.log("An error occured", error);
70  });
71
72function getHttpData(url, callback) {
73  https
74    .request(url, function (response) {
75      if (response.statusCode !== 200) {
76        return callback(
77          new Error(
78            `Request to ${url} failed, status code: ${response.statusCode}`
79          )
80        );
81      }
82
83      const data = new Stream();
84      response.on("data", function (chunk) {
85        data.push(chunk);
86      });
87      response.on("end", function () {
88        callback(null, data.read());
89      });
90      response.on("error", function (e) {
91        callback(e);
92      });
93    })
94    .end();
95}

Size and path based on placeholder

You can have customizable image loader using the template's placeholder name.

opts.getImage = function (tagValue, tagName) {
    if(tagName === 'logo')
        return fs.readFileSync(__dirname + '/logos/' + tagValue);

    return fs.readFileSync(__dirname + '/images/' + tagValue);
};

The same thing can be used to customize image size.

opts.getSize = function (img, tagValue, tagName) {
    if(tagName === 'logo')
        return [100, 100];

    return [300, 300];
};

Base64 include

You can use base64 images with the following code:

1function base64DataURLToArrayBuffer(dataURL) {
2  const base64Regex = /^data:image\/(png|jpg|svg|svg\+xml);base64,/;
3  if (!base64Regex.test(dataURL)) {
4    return false;
5  }
6  const stringBase64 = dataURL.replace(base64Regex, "");
7  let binaryString;
8  if (typeof window !== "undefined") {
9    binaryString = window.atob(stringBase64);
10  } else {
11    binaryString = new Buffer(stringBase64, "base64").toString("binary");
12  }
13  const len = binaryString.length;
14  const bytes = new Uint8Array(len);
15  for (let i = 0; i < len; i++) {
16    const ascii = binaryString.charCodeAt(i);
17    bytes[i] = ascii;
18  }
19  return bytes.buffer;
20}
21const imageOpts = {
22  getImage(tag) {
23    return base64DataURLToArrayBuffer(tag);
24  },
25  getSize() {
26    return [100, 100];
27  },
28};
29doc.attachModule(new ImageModule(imageOpts));

No vulnerabilities found.

No security vulnerabilities found.