'Breadcrumbs' component
- Sergiy Nalyvayko (Unlicensed)
Component type | Atom |
|---|---|
Component possible inclusions | n/a |
Design source (in Figma) | |
Component status |
Introduction
Breadcrumbs are a secondary navigation component used to show a user's location in a hierarchical structure. They communicate the path a user has taken to the current page and offer a quick way to navigate back up the path.
Anatomy
Key Content
Item | Type | Notes |
Navigation name | Text link | This would be automated and set in CMS |
<nav> |
| The methodology of building navigation (manually or automated based on the site map) is yet to be discussed but should only impact the back end. |
Overflow button | image | Hidden from screen readers |
Editorial
Content editors may be given the option to define a ‘short’ version of the page title to be used in some navigational components. If this name has been defined then it should be used instead of the default page title.
Visual Style
Examples
Behavior
General:
The current page is always the last item in the list and breadcrumbs should never display children of the current page unless it’s proximate to the page title (see visibility controls).
Breadcrumbs should never wrap onto a new line. If the width of the breadcrumbs breaks out of the parent container (or max width), breadcrumbs should adopt the overflow behaviour (see overflow).
TDB whether breadcrumbs adopt the max with of their parent container or have a specified max width (similar to max with of content)
Overflow
Without JS:
Breadcrumbs don’t overflow and instead wrap onto the next line.
With JS:
When the number of items in the breadcrumb list exceeds the width of its parent container, or specified max width, or specified number of items, breadcrumbs should truncate displaying only the first and last navigation items and a truncation menu button (…).
The truncation menu displays all options that are no longer visible in the following ways:
Option 1
The truncation menu displays all options that are no longer visible. Leaving ‘root' and 'current page’
Option 2 - If current page is visually hidden (see visibility controls)
The truncation menu displays all options that are no longer visible. Leaving ‘root' and the current page’s 'parent page'
Items are listed with the hierarchy ordered from top (root) to bottom.
Overflows are accessed by clicking the overflow button (…) or appropriate keyboard control (see accessibility)
Overflows are ‘pop-overs'. They site above site content and don’t change/push/interact with any content on the page.
Tabbing
When tabbing though the list of links a user is able to tab into the truncation menu as if it were the next item in the list.
When the user reaches the last item in the list, the next tab will close the list and move focus onto the next item.
Usage
Do’s
Use when the users location in a hierarchical structure is a useful piece of information to communicate.
Don’ts
Don’t use when more appropriate navigation components are available.
Never use breadcrumbs to replace the main navigation on a page.
Related/Similar Components
Table of contents
Sitemap Links