Visual Framework
Visual Framework
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 hierarchy.
The vf-breadcrumb component should follow the vf-global-header in the page layout.
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.
Ensure that the complete navigational path is displayed in the breadcrumbs on the desktop, exceptions can be made in the case where the related items component is used with the breadcrumbs, in this case it should list no more than three items, including the current page.
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.
Use the breadcrumb when users would need to understand their current location in a website’s navigation structure
Breadcrumbs should not be used for websites that have a single level of hierarchy. The breadcrumb nodes should not include parent categories which do not have separate pages. The only inactive link should be the current page’s node.
On smaller screens it is recommended that the paths of the breadcrumbs shown should be shortened. Configure the breadcrumbs to show only the direct parent node in the information architecture. This allows the user to see and navigate one step above in the website's hierarchy. The breaking point for the responsive breadcrumb is implemented at width below 768px.
This component targets WCAG 2.1 AA accessibility.
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.
includeYou'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 = {
"exampleMultiColumns" : "false",
"component-type" : "block",
"breadcrumbs" : [object Object],[object Object],[object Object],
"related" : [object Object],[object Object],
}
%}
{% include "../path_to/vf-breadcrumbs/vf-breadcrumbs.njk" %}
renderThis 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', {
"exampleMultiColumns" : "false",
"component-type" : "block",
"breadcrumbs" : [object Object],[object Object],[object Object],
"related" : [object Object],[object Object],}
%}
<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.
includeYou'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 = {
"exampleMultiColumns" : "false",
"component-type" : "block",
"breadcrumbs" : [object Object],[object Object],[object Object],
"related" : [object Object],[object Object],
}
%}
{% include "../path_to/vf-breadcrumbs/vf-breadcrumbs.njk" %}
renderThis 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', {
"exampleMultiColumns" : "false",
"component-type" : "block",
"breadcrumbs" : [object Object],[object Object],[object Object],
"related" : [object Object],[object Object],}
%}
<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>
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
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
vf-breadcrumb accessibility by increasing target area Tracking issueset- style functions to cleaner version> from related crumbsaria-current="location" to be used for the last item in vf-breadcrumbsaria-current="location" and not :last-of-type.aria-current="location" to show text a little bolder.
File system location: components/vf-breadcrumbs
Find an issue on this page? Propose a change or discuss it.