Skip to main content
HomeComponentsBreadcrumb
warning
This is a beta release of the Quantum web libraries
Please be careful when using them in production, as they may contain bugs, unstable breaking changes, and incomplete features.

Breadcrumb

Breadcrumbs are a navigation component that requires a Breadcrumb container and a list of BreadcrumbItem.

Sizes

You can choose between 3 additional sizes with the size property: small, medium and large. By default, breadcrumbs have medium size.

<Breadcrumb size="small">
<BreadcrumbItem>
<a href="#">
<Typography>Home</Typography>
</a>
</BreadcrumbItem>
<BreadcrumbItem>
<a href="#">
<Typography>My cart</Typography>
</a>
</BreadcrumbItem>
<BreadcrumbItem>
<a href="#">
<Typography>Checkout</Typography>
</a>
</BreadcrumbItem>
</Breadcrumb>

Color

By default, breadcrumbs are not emphasized (primary theme). The neutral theme is more appropriate when you need to deprioritize its focus on the screen. Set property color to change color to primary or neutral.

<Breadcrumb color="neutral"> ... </Breadcrumb>

Separator Option

The breadcrumbs have 2 options of separators which are “/” and “>”. By default, breadcrumbs have / separators. You can set the separator property to > if you want to use the > separator from Material Icons.

<Breadcrumb separator=">"> ... </Breadcrumb>

Icon

You can use any of the Material Icons.

<Breadcrumb size="small">
<BreadcrumbItem>
<a href="#">
<Icon icon="home"></Icon>
<Typography>Home</Typography>
</a>
</BreadcrumbItem>
// ...
</Breadcrumb>
// ...

API

The Breadcrumb component accepts all the props a standard <nav> does in React (HTML, ARIA, data attributes, event handlers, and children). Its props are typed as React.HTMLAttributes<HTMLElement>. See more about supported HTML props in React's documentation.

Loading API documentation...

The BreadcrumbItem component accepts all the props a standard <div> does in React (HTML, ARIA, data attributes, event handlers, and children). Its props are typed as React.HTMLAttributes<HTMLDivElement>. See more about supported HTML props in React's documentation.

Loading API documentation...

Spotted a bug, have a question, or want to suggest a new feature?

Submit an issue on GitLab