Configuration

You can configure docxtemplater with an options object by using the v4 constructor with two arguments.

var doc = new Docxtemplater(zip, options);

Custom Parser

The name of this option is parser (function).

With a custom parser you can parse the tags to for example add operators like ‘+’, ‘-’, or even create a Domain Specific Language to specify your tag values.

To enable those features, you need to specify a custom parser.

Introduction

To understand this option better, it is good to first know how docxtemplater manages the scope.

Whenever docxtemplater needs to render any tag, for example {name}, docxtemplater will use a scopemanager to retrieve the value for a given tag.

The scopemanager does the following:

  • it compiles the tag, by calling parser(‘name’) where ‘name’ is the string representing what is inside the docxtemplater tag. For loop tags, if the tag is {#condition}, the passed string is only condition (it does not contain the #).

    The compilation of that tag should return an object containing a function at the get property.

  • whenever the tag needs to be rendered, docxtemplater calls parser(‘name’).get({name: ‘John’}), if {name: ‘John’} is the current scope.

When inside a loop, for example: {#users}{name}{/users}, there are several “scopes” in which it is possible to evaluate the {name} property. The “deepest” scope is always evaluated first, so if the data is: {users: [{name: “John”}], name: “Mary”}, the parser calls the function parser(‘name’).get({name:”John”}). Now if the returned value from the .get method is null or undefined, docxtemplater will call the same parser one level up, until it reaches the end of the scope.

If the root scope also returns null or undefined for the .get call, then the value from the nullGetter is used.

As a second argument to the parser() call, you receive additional meta data about the tag of the document (and you can for example test if it is a loop tag for example).

As a second argument to the get() call, you receive more meta data about the scope, including the full scopeList.

Lets take an example, If your template is:

Hello {user}

And you call doc.render({user: “John”})

Then you will have the following:

const options = {
    // This is how docxtemplater is configured by default
    parser: function(tag) {
      // tag is the string "user", or whatever you have put inside the
      // brackets, eg if your tag was {a==b}, then the value of tag would be
      // "a==b"
      return {
        get: function(scope) {
          // scope will be {user: "John"}
          if (tag === '.') {
            return scope;
          }
          else {
            // Here we return the property "user" of the object {user: "John"}
            return scope[tag];
          }
        }
      };
    },
};
const doc = new Docxtemplater(zip, options);

Angular Parser

A very useful parser is the angular-expressions parser, which has implemented useful features.

See angular parser for comprehensive documentation

Deep Dive on the parser

The parser get function is given two arguments,

For the template

Hello {#users}{.}{/}

Using following data:

{users: ['Mary', 'John']}

And with this parser

const options = {
    // This is how docxtemplater is configured by default
    parser: function(tag) {
      return {
         get: function parser(scope, context) [
            console.log(scope);
            console.log(context);
            return scope[tag];
         }
     }
};
const doc = new Docxtemplater(zip, options);

For the tag . in the first iteration, the arguments will be:

scope = { "name": "Jane" }
context = {
  "num": 1, // This corresponds to the level of the nesting,
            // the {#users} tag is level 0, the {.} is level 1
  "scopeList": [
    {
      "users": [
        {
          "name": "Jane"
        },
        {
          "name": "Mary"
        }
      ]
    },
    {
      "name": "Jane"
    }
  ],
  "scopePath": [
    "users"
  ],
  "scopePathItem": [
    0
  ]
  // Together, scopePath and scopePathItem describe where we
  // are in the data, in this case, we are in the tag users[0]
  // (the first user)
}

Simple Parser example for [lower] and [upper]

Here’s an example parser that allows you to lowercase or uppercase the data if writing your tag as: {user[lower]} or {user[upper]}:

options = {
    parser: function(tag) {
      // tag can be "user[lower]", "user", or "user[upper]"
      const lowerRegex = /\[lower\]$/;
      const upperRegex = /\[upper\]$/;
      let changeCase = "";
      if(lowerRegex.test(tag)) {
        changeCase = "lower";
        // transform tag from "user[lower]" to "user"
        tag = tag.replace(lowerRegex, "")
      }
      if(upperRegex.test(tag)) {
        changeCase = "upper";
        // transform tag from "user[upper]" to "user"
        tag = tag.replace(upperRegex, "")
      }
      return {
        get: function(scope) {
          let result = null;
          // scope will be {user: "John"}
          if (tag === '.') {
            result = scope;
          }
          else {
            // Here we use the property "user" of the object {user: "John"}
            result = scope[tag];
          }

          if (typeof result === "string") {
            if(changeCase === "upper") {
              return result.toUpperCase();
            }
            else if(changeCase === "lower") {
              return result.toLowerCase();
            }
          }
          return result;
        }
      };
    },
    paragraphLoop: true,
    linebreaks: true,
};
new Docxtemplater(zip, options);

Simple Parser example for {$index} and {$isLast} inside loops

As an other example, it is possible to use the {$index} tag inside a loop by using following parser:

function parser(tag) {
    return {
        get(scope, context) {
            if (tag === "$index") {
                const indexes = context.scopePathItem;
                return indexes[indexes.length - 1];
            }
            if (tag === "$isLast") {
                const totalLength =
                    context.scopePathLength[context.scopePathLength.length - 1];
                const index =
                    context.scopePathItem[context.scopePathItem.length - 1];
                return index === totalLength - 1;
            }
            if (tag === "$isFirst") {
                const index =
                    context.scopePathItem[context.scopePathItem.length - 1];
                return index === 0;
            }
            return scope[tag];
        },
    };
}

Parser example to avoid using the parent scope if a value is null on the main scope

When using following template:

{#products}
{name}, {price} €
{/products}

With following data:

doc.render({
    name: 'Santa Katerina',
    products: [
      {
        price: '$3.99'
      }
    ]
});

The {name} tag will use the “root scope”, since it is not present in the products array.

If you explicitly don’t want this behavior because you want the nullGetter to handle the tag in this case, you could use the following parser:

function parser(tag) {
    return {
        get(scope, context) {
            if (context.num < context.scopePath.length) {
                return null;
            }
            // You can customize your parser here instead of scope[tag] of course
            return scope[tag];
        },
    };
},

The context.num value contains the scope level for this particular evaluation.

When evaluating the {name} tag in the example above, there are two evaluations:

// For the first evaluation, when evaluating in the {#users} scope
context.num = 1;
context.scopePath = ["users"];
// This evaluation returns null because the
// first product doesn't have a name property

// For the second evaluation, when evaluating in the root scope
context.num = 0;
context.scopePath = ["users"];
// This evaluation returns null because of the extra added condition

Note that you could even make this behavior dependent on a given prefix, for example, if you want to by default, use the mechanism of scope traversal, but for some tags, allow only to evaluate on the deepest scope, you could add the following condition:

function parser(tag) {
    return {
        get(scope, context) {
            const onlyDeepestScope = tag[0] === '!';
            if (onlyDeepestScope) {
                if (context.num < context.scopePath.length) {
                    return null;
                }
                else {
                    // Remove the leading "!", ie: "!name" => "name"
                    tag = tag.substr(1);
                }
            }
            // You can customize the rest of your parser here instead of
            // scope[tag], by using the angular-parser for example.
            return scope[tag];
        },
    };
},

Parser example to always use the root scope

Let’s say that at the root of your data, you have some property called “company”.

You need to access it within a loop, but the company is also part of the element that is looped upon.

With following data:

doc.render({
    company: 'ACME Company',
    contractors: [
        { company: "The other Company" },
        { company: "Foobar Company" },
    ]
});

If you want to access the company at the root level, it is not possible with the default parser.

You could implement it this way, when writing {$company}:

const options = {
    parser: function(tag) {
        return {
            get(scope, context) {
                const onlyRootScope = tag[0] === '$';
                if (onlyRootScope) {
                    if (context.num !== 0) {
                        return null;
                    }
                    else {
                        // Remove the leading "$", ie: "$company" => "company"
                        tag = tag.substr(1);
                    }
                }
                // You can customize the rest of your parser here instead of
                // scope[tag], by using the angular-parser for example.
                return scope[tag];
            },
        };
    },
};
const doc = new Docxtemplater(zip, options);

Custom delimiters

You can set up your custom delimiters:

new Docxtemplater(zip, { delimiters: { start:'[[', end:']]' } });

paragraphLoop

The paragraphLoop option has been added in version 3.2.0. Since it breaks backwards-compatibility, it is turned off by default.

It is recommended to turn that option on, since it makes the rendering a little bit easier to reason about.

new Docxtemplater(zip, {paragraphLoop:true});

It allows to loop around paragraphs without having additional spacing.

When you write the following template

The users list is:
{#users}
{name}
{/users}
End of users list

Most users of the library would expect to have no spaces between the different names.

The output without the option is as follows:

The users list is:

John

Jane

Mary

End of users list

With the paragraphLoop option turned on, the output becomes:

The users list is:
John
Jane
Mary
End of users list

The rule is quite simple:

If the opening loop ({#users}) and the closing loop ({/users}) are both on separate paragraphs (and there is no other content on those paragraphs), treat the loop as a paragraph loop (eg create one new paragraph for each loop) where you remove the first and last paragraphs (the ones containing the loop open and loop close tags).

nullGetter

You can customize the value that is shown whenever the parser (documented above) returns ‘null’ or undefined. By default the nullGetter is the following function

nullGetter(part, scopeManager) {
    if (!part.module) {
        return "undefined";
    }
    if (part.module === "rawxml") {
        return "";
    }
    return "";
},

This means that the default value for simple tags is to show “undefined”. The default for rawTags ({@rawTag}) is to drop the paragraph completely (you could enter any xml here).

The scopeManager variable contains some meta information about the tag, for example, if the template is: {#users}{name}{/users} and the tag {name} is undefined, scopeManager.scopePath === [“users”, “name”]

linebreaks

You can enable linebreaks, if your data contains newlines, those will be shown as linebreaks in the document

const doc = new Docxtemplater(zip, {linebreaks:true});
doc.render({text: "My text,\nmultiline"});