Skip to main content Skip to docs navigation

Breadcrumb

Navigation components that display the current page location within the site hierarchy, enabling users to understand their position and navigate to parent pages.

This documentation is a work in progress and may contain incomplete or outdated information. If you have any feedback or suggestions, please open an issue on GitHub.

Props

Configurable properties that control the appearance, behavior, and functionality of breadcrumb components for hierarchical navigation and way-finding interfaces.

Large Breadcrumb

Properties that define the visual state and navigation structure of breadcrumb elements optimized for desktop and tablet environments with expanded screen real estate.

Breadcrumb example image Breadcrumb example image

type variant

Controls the visual presentation method and separator styling of the breadcrumb navigation, determining whether text-based or icon-based separators are used for path hierarchy.

  • text-separator
  • icon-separator

flush variant

Controls the spacing configuration of the breadcrumb navigation, determining whether standard or minimal padding is applied for different layout density requirements.

  • false
  • true

separator-text text

type:
text-separator

Specifies the text content used as separators between navigation elements when using text-based separator presentation for hierarchical path display.

separator-icon instance-swap

type:
icon-separator

Specifies which icon component to display as separators between navigation elements when using icon-based separator presentation for enhanced visual hierarchy.

  • Icon Placeholder

has-home-icon boolean

Controls the visibility of a home icon element that provides quick access to the root navigation level and serves as the starting point for breadcrumb navigation.

  • true
  • false

has-level-1 boolean

Controls the visibility of the first hierarchical level in the breadcrumb path, representing the primary navigation category or section within the site structure.

  • true
  • false

has-level-2 boolean

Controls the visibility of the second hierarchical level in the breadcrumb path, representing the secondary navigation category or subsection within the site structure.

  • true
  • false

has-level-3 boolean

Controls the visibility of the third hierarchical level in the breadcrumb path, representing the tertiary navigation category or deeper subsection within the site structure.

  • true
  • false

has-level-4 boolean

Controls the visibility of the fourth hierarchical level in the breadcrumb path, representing the quaternary navigation category or deepest subsection within the site structure.

  • true
  • false

Small Breadcrumb

Properties that define the visual state and navigation structure of breadcrumb elements optimized for mobile devices and space-constrained environments with simplified interaction patterns.

Breadcrumb example image Breadcrumb example image

type variant

Controls the interaction pattern and navigation approach of the mobile breadcrumb, determining whether simplified text display, icon-based navigation, or parent-focused back button functionality is used.

  • text-separator
  • icon-separator
  • parent-button

flush variant

Controls the spacing configuration of the mobile breadcrumb navigation, determining whether standard or minimal padding is applied for different mobile layout requirements.

  • false
  • true

separator-text text

type:
text-separator

Specifies the text content used as separators between navigation elements when using text-based presentation for mobile hierarchical path display.

separator-icon instance-swap

type:
icon-separator

Specifies which icon component to display as separators between navigation elements when using icon-based presentation for mobile navigation hierarchy.

  • Icon Placeholder

has-levels boolean

type:
text-separator, icon-separator

Controls the visibility of an ellipsis icon that indicates additional navigation levels are available, providing visual cue for expandable path information in space-constrained mobile interfaces.

  • true
  • false