Badge

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",
  "text": "alpha",
  "theme": "primary"
}
 %}
{% include "../path_to/vf-badge/vf-badge.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-badge', {
  "component-type": "element",
  "text": "alpha",
  "theme": "primary"
} %}
                

 <span class="vf-badge vf-badge--primary">alpha</span>
              

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",
  "text": "alpha",
  "theme": "secondary"
}
 %}
{% include "../path_to/vf-badge/vf-badge.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-badge', {
  "component-type": "element",
  "text": "alpha",
  "theme": "secondary"
} %}
                

 <span class="vf-badge vf-badge--secondary">alpha</span>
              

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",
  "text": "alpha",
  "theme": "tertiary"
}
 %}
{% include "../path_to/vf-badge/vf-badge.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-badge', {
  "component-type": "element",
  "text": "alpha",
  "theme": "tertiary"
} %}
                

 <span class="vf-badge vf-badge--tertiary">alpha</span>
              

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",
  "badge_href": "JavaScript:Void(0);",
  "theme": "primary",
  "text": "beta"
}
 %}
{% include "../path_to/vf-badge/vf-badge.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-badge', {
  "component-type": "element",
  "badge_href": "JavaScript:Void(0);",
  "theme": "primary",
  "text": "beta"
} %}
                

 <a href="JavaScript:Void(0);" class="vf-badge vf-badge--primary">beta</a>