Functions

Functions add functionality to your template.

Documint uses an enhanced version of Handlebars as its templating engine. This means all valid Handlebars syntax is valid Documint syntax. Below is a list of custom functions that can be used in your Documint templates.

Combining Functions

You can combine functions by wrapping the inner function in parenthesis.

Example:

{{$link ($get "path.to.website_url") "Go to website"}}

Here we're using the $get function within the $link function by wrapping it inside of parenthesis.

General

$get

Returns the value of the given path.

Signature

{{$get path [defaultValue] [global=true|false]}}

Arguments

Name	Description	Type	Required
path	The path to value you are trying to display.	String
defaultValue	Value that is displayed if no value is found at the given path.	NumberString
global	If true, the given path will be relative to the global context. If false, the path will be relative to the current context. For example, if you are using the this function within a loop, the context will be the current item in the loop. If global is set to true, then the context will be set to the root of your data.	Boolean

Returns

The value at the given path or, if there is no value at the path and a default value is provided, the default value will be returned.

Example

Template

{{$get "customer.company_name"}}
{{$get "customer.contacts[0].name"}}
{{$get "customer.contacts[1].email"}}
{{$get "customer.address.country" "United States"}}

Data

{
  "order_number": "O-0012",
  "customer": {
    "company_name": "Acme Co.",
    "address":{
      "street":"123 Main St.",
      "city": "New York",
      "state":"New York"
    },
    "contacts":[
      {
        "name":"Wile E. Coyote",
        "email":"[e-mail]"
      },
      {
        "name":"Road Runner",
        "email":"[e-mail]"
      }
    ]
  }
}

Result

Acme Co.

Wile E. Coyote

[e-mail]

United States

To access a specific item in an array/list, add the position of the item in square brackets [] like so: [0]. Indices are zero-based which means the first item in the array/list is at position 0, the second item is at position 1 and so on.

This method always accesses data from its current context. For example, if it's used within a loop, then the context of the path is set to the current item in the loop.

$var

Creates a custom variable in your template which you can access from other parts of your template

Signature

{{$var name value}}

Arguments

Name	Description	Type	Required
name	The name of the variable. This will be used to access it later. Must be a valid JavaScript key	String
value	The value of the variable	Any

Returns

This function does not have a return value.

Example #1 - Basic

Template

{{$var "custom_var" "Custom value"}}
...
{{custom_var}} // Used somewhere else in the template after the above declaration

Result

Custom value

Example #2 - Advanced

Template

Create a custom variable and set the value to the results of the filter function where we filter items that have a quantity of 10 or more.

Repeat the section for each item in the custom variable

Data

{
  "items":[
    {
      "name": "Item #1",
      "qty": 5
    },
    {
      "name": "Item #2",
      "qty": 10
    },
    {
      "name": "Item #3",
      "qty": 15
    },
    {
      "name": "Item #4",
      "qty": 20
    }
  ]
}

Result

Variables can only be accessed after the point where they've been declared.

Content

$iframe

Documentation coming soon!

$link

Creates a link to a given URL

Signature

{{$link url [text]}}

Arguments

Name	Description	Type	Required
url	URL value of the link	String
text	Text to display in document. If no value is provided the URL of the link will be displayed	String

Returns

Link to the given URL.

Example

Template

{{$link company.website}}
{{$link company.website company.name}}

Data

{
    "company":{
        "name":"Acme Co.",
        "website":"https://www.acme.co"
    }
}

Result

https://www.acme.co

Acme Co.

$md

Renders markdown content

Signature

{{$md content}}

Arguments

Name	Description	Type	Required
content	Markdown content	String

Example

Template

{{$md notes}}

Data

{
    "notes":"Before moving forward you need to complete the following items:\n[ ] Checklist item one\n[x] Checklist item two\n[ ] Checklist item three\n"
}

Result

List/Arrays

#each

Loops over an array (list) of items. This is different than the other functions because it has an opening ({{#each}}) and closing ({{/each}}) tag and uses an # instead of a $ to prefix the function name. The content within the opening and closing tags is set to the context of the current item in the loop. This means that any variables used within the opening and closing tags are relative to the current item in the loop. If the list of items being looped over is a list of objects, then variable names will represent properties on that object. See example below.

Signature

{{#each array }}{{this}}{{/each}}

Arguments

Name	Description	Type	Required
array	List of items to repeat/loop over	String ArrayNumber ArrayBoolean ArrayObject ArrayArray Array

Returns

Content within the opening and closing tags, for each item in the given array/list.

Example - Array of Objects

In this example we're looping over an array/list of Objects. We can access the properties of the current object in the loop simply by using the name of the property. In the case below, we're displaying the name property of each object using the {{name}} token. This works because the within the opening and closing tags of the #each function, the context is set to the current item in the loop.

Template

{{#each characters}}{{name}}, {{/each}}

Data

{
    "characters": [
        { "name": "Wile E. Coyote", "email":"[e-mail]" },
        { "name": "Road Runer",     "email":"[e-mail]" }
    ]
}

Result

Wile E. Coyote, Road Runner

Example - Array of Strings

In this example, we're looping over an array/list of Strings. We use the this keyword to reference the current item in the loop. this always represents the current item in the loop, even when looping over data types other than Strings.

Template

{{#each characters}}{{this}}, {{/each}}

Data

{
    "characters": [ "Wile E. Coyote", "Road Runer" ]
}

Result

Wile E. Coyote, Road Runner

$filter

Filters an array/list of items.

Signature

{{$filter array pathoperator [value]}}

Arguments

Name	Description	Type	Required
array	Accepts either an array of data or a relative path, as a String, to an array.	StringString ArrayNumber ArrayObject Array
path	Path to property if looping over an array/list of Objects. Note: If looping over a list of Strings, Numbers or Booleans then this should be the operator.	String
operator	The operator used to evaluate each item in the array/list. Note: If looping over an array/list of Strings, Numbers or Booleans then this should be the value to check against.	String
value	The value to compare variable's value to. Required when using an operator that requries two arguments.	StringNumberBoolean

Example - Array of Objects

Template

{{$filter products "category" "isIn" "Disguise,Explosive"}}

Data

{
  "products": [
    { "name":"Batman Costume", "category":"Disguise" }, 
    { "name":"TNT", "category":"Explosive" },
    { "name":"Jet-Propelled Unicycle", "category":"Transportation" }
  ]
}

Result

[
  { "name":"Batman Costume", "category":"Disguise" }, 
  { "name":"TNT", "category":"Explosive" }
]

$group

Documentation coming soon.

$join

Concatenates an array (list) of items into a string.

Signature

{{$join array [path] [separator] [final] }}

Arguments

Name	Description	Type	Required
array	Accepts either an array of data or a relative path, as a String, to an array.	StringString ArrayNumber ArrayObject Array
path	If the array is a collection (an array of objects) then use this path to specify which property in the object should be concatenated. Default value: ", "	String
separator	String that separates each item in the array.	String
final	The string that's used to separate the last two items.	String

Example #1 - Array of strings

Template

{{$join categories ", " " & "}}

Data

{
  "categories": ["Disguise", "Explosive", "Transportation"]
}

Result

Disguise, Maintenance & Transportation

Example #2- Collection (array of objects)

Template

{{$join items "name" ", " " & "}}

Data

{
  "items": [
    { "name": "Glue V1", "price": 9.99 },
    { "name": "Artificial Rock", "price": 26.99 },
    { "name": "Bat-Man's Outfit", "price": 159.99 }
  ]
}

Result

Glue V1, Artificial Rock & Bat-Man's Outfit

Example #3 - Path to array

Template

{{$join "company.employees" "name" ", " " & "}}

Data

{
  "company": {
    "name": "Acme Co.",
    "employees": [
      {
        "name": "Bernadine Burton",
        "role": "Decoy"
      },
      {
        "name": "Good Battle",
        "role": "Field Agent"
      },
      {
        "name": "Dennis Miles",
        "role": "Field Agent"
      }
    ]
  }
}

Result

Bernadine Burton, Good Battle & Dennis Miles

Helpers

$extname

Returns the extension name of a filename.

Signature

{{$extname filename }}

Arguments

Name	Description	Type	Required
filename	The name of the file that you're trying to get the extension name of.	String

Example

Template

{{$extname filename}}

Data

{
  "filename": "https://acmec.co/assets/image.jpg"
}

Result

jpg

$inspect

Documentation coming soon..