Breadcrumbs

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 (exampe), 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": "block",
  "breadcrumbs": [
    {
      "text": "Explore",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Topics",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Centre",
      "currentPage": true
    }
  ],
  "related": [
    {
      "text": "Biscuits",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Fruits For Cheese",
      "breadcrumb_href": "JavaScript:Void(0);"
    }
  ]
}
 %}
{% include "../path_to/vf-breadcrumbs/vf-breadcrumbs.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-breadcrumbs', {
  "component-type": "block",
  "breadcrumbs": [
    {
      "text": "Explore",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Topics",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Centre",
      "currentPage": true
    }
  ],
  "related": [
    {
      "text": "Biscuits",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Fruits For Cheese",
      "breadcrumb_href": "JavaScript:Void(0);"
    }
  ]
} %}
                

<nav class="vf-breadcrumbs" aria-label="Breadcrumb">
  <ul class="vf-breadcrumbs__list | vf-list vf-list--inline">
    <li class="vf-breadcrumbs__item">
      <a href="JavaScript:Void(0);" class="vf-breadcrumbs__link">Explore</a>
    </li>
    <li class="vf-breadcrumbs__item">
      <a href="JavaScript:Void(0);" class="vf-breadcrumbs__link">Topics</a>
    </li>
    <li class="vf-breadcrumbs__item" aria-current="location">
      Centre
    </li>
  </ul>
</nav>
              

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 (exampe), 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": "block",
  "breadcrumbs": [
    {
      "text": "Explore",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Topics",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Centre",
      "currentPage": true
    }
  ],
  "related": [
    {
      "text": "Biscuits",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Fruits For Cheese",
      "breadcrumb_href": "JavaScript:Void(0);"
    }
  ]
}
 %}
{% include "../path_to/vf-breadcrumbs/vf-breadcrumbs.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-breadcrumbs', {
  "component-type": "block",
  "breadcrumbs": [
    {
      "text": "Explore",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Topics",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Centre",
      "currentPage": true
    }
  ],
  "related": [
    {
      "text": "Biscuits",
      "breadcrumb_href": "JavaScript:Void(0);"
    },
    {
      "text": "Fruits For Cheese",
      "breadcrumb_href": "JavaScript:Void(0);"
    }
  ]
} %}
                

<nav class="vf-breadcrumbs" aria-label="Breadcrumb">

  <ul class="vf-breadcrumbs__list | vf-list vf-list--inline">
    <li class="vf-breadcrumbs__item">
      <a href="JavaScript:Void(0);" class="vf-breadcrumbs__link">Explore</a>


    </li>

    <li class="vf-breadcrumbs__item">
      <a href="JavaScript:Void(0);" class="vf-breadcrumbs__link">Topics</a>


    </li>

    <li class="vf-breadcrumbs__item" aria-current="location">
      Centre

    </li>


  </ul>

  <span class="vf-breadcrumbs__heading">Related:</span>
  <ul class="vf-breadcrumbs__list vf-breadcrumbs__list--related | vf-list vf-list--inline">
    <li class="vf-breadcrumbs__item">
      <a href="JavaScript:Void(0);" class="vf-breadcrumbs__link">Biscuits</a>
    </li>
    <li class="vf-breadcrumbs__item">
      <a href="JavaScript:Void(0);" class="vf-breadcrumbs__link">Fruits For Cheese</a>
    </li>
  </ul>

</nav>