Breadcrumbs github location npm version

The vf-breadcrumb component is a navigational item that can identify to the site visitor their location on the website. They are a visual representation of the site's heirachy.


Variants


Usage

The vf-breadcrumb component should follow the vf-global-header in the page layout.

It should list no more than three items, including the current page. Each link in the component is separated by a > chevron. The page you are on should display an 'active' state in the breadcrumbs which is bold with no underline.

Related breadcrumbs

The "Related" variant allows you to indicate related items as additional navigation to the page the site visitor is on. They should be placed inside the vf-breadcrumbs <nav> element and be a seperate unordered list.

Nunjucks syntax

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": "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);"
    }
  ]
} %}
                
HTML
<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>
              
Nunjucks syntax

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": "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);"
    }
  ]
} %}
                
HTML
<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>
              
Installation info

This component is distributed with npm. After installing npm, you can install the vf-breadcrumbs with this command.

$ yarn add --dev @visual-framework/vf-breadcrumbs

Sass/CSS

The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-breadcrumbs/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-breadcrumbs

Find an issue on this page? Propose a change or discuss it.