Breadcrumbs

HomeProductsProduct 1

Breadcrumbs is a secondary navigation element that shows a user's current location and a hierarchy among levels. It allows the user to move up to higher levels in the hierarchy or to a previous step.

On websites that have a lot of different pages, breadcrumb navigation can greatly enhance how users find their way around. In terms of usability, it reduces the number of actions a website visitor needs to take in order to get to a higher-level page.

It is also an effective visual aid that indicates the location of the user within the website's hierarchy, making it a great source of contextual information for landing pages.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Breadcrumbs is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

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 params or properties:

Name	Type	Slottable	Description
crumbs	Object[]	✅	The links in the breadcrumbs
home	boolean		Whether to show the home icon for the first link in the breadcrumbs
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-breadcrumbs custom='{"fill":"#06e7a3"}' />
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-breadcrumbs custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-breadcrumbs z-theme="dark" />

From Figma to code

You can check the Figma implementation here. This are the available properties:

• Style select
• Items select

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS Variable	Type	Description
--z-breadcrumbs--color--active	color	The color of the active breadcrumb

Accessibility

...

Related components