Open source docxtemplater image module
This repository holds an updated 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:
npm install open-docxtemplater-image-module
For the browser find builds in build/
directory.
Alternatively, you can create your own build from the sources:
npm run compile
npm run browserify
npm run uglify
Usage
Assuming your docx or pptx template contains only the text {%image}
:
var ImageModule = require('open-docxtemplater-image-module');
var opts = {}
opts.centered = false;
opts.fileType = "docx";
opts.getImage = function(tagValue, tagName) {
return fs.readFileSync(tagValue);
}
opts.getSize = function(img, tagValue, tagName) {
return [150, 150];
}
var imageModule = new ImageModule(opts);
var zip = new JSZip(content);
var doc = new Docxtemplater()
.attachModule(imageModule)
.loadZip(zip)
.setData({image: 'examples/image.png'})
.render();
var buffer = doc
.getZip()
.generate({type:"nodebuffer"});
fs.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.
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.