Skip to content

Breadcrumbs - Web Component

The Breadcrumbs component can be used imported from:

Playground

Parameters

The Web component uses the <z-breadcrumbs> tag:

By default, all the parameters are optional or can be set in different, except for the ones marked as required

The parametrization of the component can be done with the following custom HTML params:

NameTypeDescriptionSlotA11y
crumbsObject[]The links in the breadcrumbsdefault
homebooleanWhether to show the home icon for the first link in the breadcrumbs

Events

This component has events. Check the documentation about how to use the events.

NamePayloadDescription

Slots

This component has slots. Check the documentation about how to use the slots.

NameTagsDescription
defaultz-linkThe links in the breadcrumbs

Parameters use

crumbs

The crumbs parameter is an array of objects with the following properties:

  • text: The text to be displayed for the crumb.
  • to: the URL to navigate to when the crumb is clicked.

We can use <z-link> tags to define the values of crumbs

HomeMoleculesBreadcrumbs

home

The home parameter is a boolean that determines if the first crumb should be replaced with a home icon.

HomeMoleculesBreadcrumbs

Browser support

Detected engine:  

  • Chromium

  • Webkit

  • Gecko

HTML Examples

CodeSandbox example