Skip to content

role navigation

Breadcrumb draft v0.1.0

Shows where the current page sits in a hierarchy, with a link to each level above it.

A breadcrumb lists the pages above the current one, from the top of the hierarchy down, each as a link, and ends with the current page, which is not a link. It tells people where they are and lets them go up one or several levels in one activation. It is a navigation landmark of its own, separate from the main navigation.

Guidelines

From apps/docs/content/components/breadcrumb.md

Overview

A breadcrumb lists the pages above the current one, from the top of the hierarchy down, each as a link, and ends with the current page, which is not a link. It tells people where they are and lets them go up one or several levels in one activation. It is a navigation landmark of its own, named Breadcrumb, separate from the main navigation.

This page applies to every platform. Where a platform differs, the difference sits under a sub-heading named after it (Web, iOS, Android, Desktop); everything else holds everywhere.

When to use

  • Sites and products organised as a hierarchy at least three levels deep.
  • Pages people reach from search or links, without passing through the levels above.

When not to use

  • Flat structures of one or two levels: the main navigation says it all.
  • A step indicator in a flow: steps are not pages above the current one.
  • History (where people came from): a breadcrumb shows the structure, not the path taken.

Sizes

Size Use for
Small Above dense content: 12 px text, 16 px separators.
Medium Page headers, the default: 14 px text, 20 px separators.

States

States belong to the items.

State How it happens What changes
Default A link to a level above. Underlined, in the secondary text color.
Hover A pointer rests over a link. Needs a pointing device: there is no hover on touch. The primary text color.
Focus visible Keyboard focus on a link. The shared focus ring appears around it. Pointer focus shows no ring.
Current The last item. Plain text in the primary color, not underlined, exposed as the current page.

Content

  • Each level is the title of its page, as short as the page allows.
  • The first level is the root (Home, Projects), the last the current page. Never truncate the current page.

Accessibility

The Specification tab lists the full accessibility contract, grouped into what holds on every platform and what is specific to one. Each statement there links the source it comes from. This section explains the decisions behind it.

Web

  • Pagination (moving between the pages of a list)