2.21.0

Breadcrumb

A navigational aid to keep track and maintain awareness of current location within a website.

Published

History
View changes
Install
yarn add @bolt/components-breadcrumb
Source code
View on Github
Dependencies
@bolt/core-v3.x

Overview

Breadcrumb is part of the collection of components, visual styles, and build tools that power the the Bolt Design System.

Install via NPM
npm install @bolt/components-breadcrumb
Overview Usage Schema Edit this page Testing Steps

Usage

{% include "@bolt-components-breadcrumb/breadcrumb.twig" with { contentItems: [ include("@bolt-components-link/link.twig", { text: "Home", url: "#!" }), include("@bolt-components-link/link.twig", { text: "Landing Page", url: "#!" }), include("@bolt-components-link/link.twig", { text: "Sub Page", url: "#!" }), include("@bolt-components-link/link.twig", { text: "Current Page", url: "#!", attributes: { "aria-current": "page", }, }), ] } only %}

Schema

Note: when assigning component props as HTML attributes on a web component, make sure to use kebab-case.

Prop Name Description Type Default Value Option(s)
attributes

A Drupal-style attributes object with extra attributes to append to this component.

 object —
  • —
contentItems

Breadcrumb pieces.

 array —
  • [items]:
    • Type: string, object, array

      Renderable content (i.e. a string, render array, or included pattern) for a single breadcrumb
Debug Panel