Skip to content

Components

Breadcrumb

Shows where the current page sits in the hierarchy.

Usage

Basic

HTML
<bs:bsui-breadcrumb>
  <bs:bsui-breadcrumb-item label="Docs" href="/docs/" />
  <bs:bsui-breadcrumb-item label="Components" href="/ui/" />
  <bs:bsui-breadcrumb-page label="Button" />
</bs:bsui-breadcrumb>

Two levels

The shortest useful trail is one link and the page you are on.

HTML
<bs:bsui-breadcrumb>
  <bs:bsui-breadcrumb-item label="Account" href="/account/" />
  <bs:bsui-breadcrumb-page label="Billing" />
</bs:bsui-breadcrumb>

Deep trail

Every level of a documentation tree, current page last.

HTML
<bs:bsui-breadcrumb>
  <bs:bsui-breadcrumb-item label="Docs" href="/docs/" />
  <bs:bsui-breadcrumb-item label="Blocks" href="/docs/blocks/registration/" />
  <bs:bsui-breadcrumb-item label="Fields" href="/docs/blocks/attributes/field-types/" />
  <bs:bsui-breadcrumb-page label="Repeater" />
</bs:bsui-breadcrumb>

Anatomy

Breadcrumb is composed of the blocks below. Each one is a separate block that only renders inside its parent.

  • bsui/breadcrumb
  • bsui/breadcrumb-ellipsis
  • bsui/breadcrumb-item
  • bsui/breadcrumb-page

Attributes

This block takes no attributes.

bsui/breadcrumb-ellipsis

This block takes no attributes.

bsui/breadcrumb-item

AttributeTypeDefault
label richtext —
href text #

bsui/breadcrumb-page

AttributeTypeDefault
label richtext —