Breadcrumb

The Breadcrumb rendering displays a navigational trail showing the current page’s position within the site hierarchy. It automatically generates the trail from the Sitecore content tree path — no datasource item is required. The breadcrumb uses Bootstrap’s breadcrumb component pattern with an ordered list inside a <nav aria-label="breadcrumb"> element.

The rendering is most commonly invoked inline by a Grid section via its ShowBreadcrumb=1 parameter, but it can also be placed as a standalone rendering in any placeholder. It inherits Column parameters (Small, Medium, Large, Offsets, Padding) and AdditionalClasses for layout control.

Examples

Example Description

Below is a live Breadcrumb rendering placed as a standalone component. It automatically generates the trail from this page’s position in the content tree: Home > Components > BSTools5 > Breadcrumb. The breadcrumb is only visible at the lg breakpoint and above (hidden on smaller screens via d-none d-lg-flex).

Usage Notes

Usage Notes

  • The Breadcrumb rendering has no datasource. It reads the current page’s ancestors from the content tree automatically via GetBreadCrumb(), which is populated by middleware/pipeline from the HTTP context features.
  • The most common usage is inline via a Grid section: set ShowBreadcrumb=1 on the Grid rendering parameters and the breadcrumb is rendered inside the grid container automatically (calls @Html.Partial("ion-breadcrumb.cshtml")).
  • The Breadcrumb can also be placed as a standalone rendering in any placeholder when finer control over placement is needed.
  • The breadcrumb list uses d-none d-lg-flex, meaning it is hidden on small and medium screens and only visible at the lg breakpoint (≥992px) and above.
  • The last item in the trail is marked with aria-current="page" and the active class — it renders as plain text (no link).
  • All other items render as clickable links with href and title attributes derived from the content tree.
  • Use AddClass to append custom CSS classes to the outer <nav> wrapper, and Column parameters (Small, Medium, Large) to control width if placed inside a row.

Control Properties

Control Properties

Standard Values / Defaults

The Breadcrumb rendering uses the Column parameters template ({BFBEB573-1751-46B9-8F16-C01C9DCDB105}). The __Standard Values item defines:

PropertyDefault ValueNotes
Small(empty)No column width at small breakpoint by default.
Medium(empty)No column width at medium breakpoint by default.
Large(empty)No column width at large breakpoint by default.
OffsetSmall / OffsetMedium / OffsetLarge(empty)No offsets by default.
PaddingTop / PaddingBottom / PaddingStart / PaddingEnd(empty)No padding by default.
AddClass(empty)No extra CSS classes by default.
All other parameters(empty / not set)The breadcrumb renders full-width inside its container unless column parameters are set.

Rendering Parameters (Column)

PropertyTypeDescription
SmallColumn Width (Droplink)Bootstrap column class at the small breakpoint.
MediumColumn Width (Droplink)Bootstrap column class at the medium breakpoint.
LargeColumn Width (Droplink)Bootstrap column class at the large breakpoint.
OffsetSmallColumn Offset (Droplink)Column offset at the small breakpoint.
OffsetMediumColumn Offset (Droplink)Column offset at the medium breakpoint.
OffsetLargeColumn Offset (Droplink)Column offset at the large breakpoint.
PaddingTopDictionary Phrase (Droplink)Top padding class on the breadcrumb nav wrapper.
PaddingBottomDictionary Phrase (Droplink)Bottom padding class.
PaddingStartDictionary Phrase (Droplink)Start (left/inline-start) padding class.
PaddingEndDictionary Phrase (Droplink)End (right/inline-end) padding class.
AddClassSingle-Line TextAdditional CSS classes appended to the <nav> element.

Grid Section Integration (ShowBreadcrumb)

PropertyTypeDescription
ShowBreadcrumbCheckbox (on Grid section)When checked on a Grid/Section rendering, the breadcrumb is rendered inline inside the grid container via @Html.Partial("ion-breadcrumb.cshtml"). This is the most common way to display the breadcrumb without placing a separate rendering.

Template properties

Control properties