ssured / docxtemplater-image-module

A module to insert images with docxtemplater

First module for docxtemplater.

Installation:

You will need docxtemplater v1: npm install docxtemplater

install this module: npm install docxtemplater-image-module

Usage

Your docx should contain the text: {%image}

ImageModule=require(‘docxtemplater-image-module’)

imageModule=new ImageModule({centered:false})

docx=new DocxGen()
    .attachModule(imageModule)
    .load(content)
    .setData({image:'examples/image.png'})
    .render()

buffer= docx
        .getZip()
        .generate({type:"nodebuffer"})

fs.writeFile("test.docx",buffer);

Options

You can center the images using new ImageModule({centered:true}) instead

Size

You can set the size of the image to what ever you want in pixel. By default it will be 150x150. One of the most useful cases of this is to set the images to be the size of that image.

For this, you will need to install the npm package ‘image-size’ then, write:

imageModule=new ImageModule({centered:false})
imageModule.getSizeFromData=function(imgData) {
   sizeOf=require('image-size');
   sizeObj=sizeOf(imgData);
   console.log(sizeObj);
   return [sizeObj.width,sizeObj.height];
}

Notice

For the imagereplacer to work, the image tag: {%image} need to be in its own <w:p>, so that means that you have to put a new line after and before the tag.

Building

You can build the coffee into js by running gulp (this will watch the directory for changes)

Testing

You can test that everything works fine using the command mocha. This will also create 3 docx files under the root directory that you can open to check if the docx are correct