Helper form

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": "form",
  "helper_text": "Form helper text"
}
 %}
{% include "../path_to/vf-form__helper/vf-form__helper.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-form__helper', {
  "component-type": "form",
  "helper_text": "Form helper text"
} %}
                

<p class="vf-form__helper">Form helper text</p>
              

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": "form",
  "helper_text": "You have done something wrong.",
  "error": true
}
 %}
{% include "../path_to/vf-form__helper/vf-form__helper.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-form__helper', {
  "component-type": "form",
  "helper_text": "You have done something wrong.",
  "error": true
} %}
                

<p class="vf-form__helper vf-form__helper--error">You have done something wrong.</p>