Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.

{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "type": 1,
  "heading": "This heading size is extra large and inverted",
  "style": "invert",
  "tags": "h1"
}
 %}
{% include "../path_to/vf-heading/vf-heading.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-heading', {
  "component-type": "element",
  "type": 1,
  "heading": "This heading size is extra large and inverted",
  "style": "invert",
  "tags": "h1"
} %}
                

 <h1 class="vf-text vf-text-heading--1 vf-text--invert">This heading size is extra large and inverted</h1>
              

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.

{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "type": 2,
  "heading": "This heading size is extra large",
  "tags": "h1"
}
 %}
{% include "../path_to/vf-heading/vf-heading.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-heading', {
  "component-type": "element",
  "type": 2,
  "heading": "This heading size is extra large",
  "tags": "h1"
} %}
                

 <h1 class="vf-text vf-text-heading--2">This heading size is extra large</h1>
              

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.

{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "type": 3,
  "heading": "This heading size is large",
  "tags": "h2"
}
 %}
{% include "../path_to/vf-heading/vf-heading.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-heading', {
  "component-type": "element",
  "type": 3,
  "heading": "This heading size is large",
  "tags": "h2"
} %}
                

 <h2 class="vf-text vf-text-heading--3">This heading size is large</h2>
              

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.

{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "type": 4,
  "heading": "This heading size is regular",
  "tags": "h3"
}
 %}
{% include "../path_to/vf-heading/vf-heading.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-heading', {
  "component-type": "element",
  "type": 4,
  "heading": "This heading size is regular",
  "tags": "h3"
} %}
                

 <h3 class="vf-text vf-text-heading--4">This heading size is regular</h3>
              

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.

{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "type": 5,
  "heading": "This heading size is small",
  "tags": "h4"
}
 %}
{% include "../path_to/vf-heading/vf-heading.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-heading', {
  "component-type": "element",
  "type": 5,
  "heading": "This heading size is small",
  "tags": "h4"
} %}
                

 <h4 class="vf-text vf-text-heading--5">This heading size is small</h4>