@blueprintjs/core
Version:
Core styles & components
48 lines (28 loc) • 1.37 kB
Markdown
@# Breadcrumbs
**Breadcrumbs** represent the path to the current resource within an application's hierarchical structure.
@## Import
```ts
import { Breadcrumbs } from "@blueprintjs/core";
```
@## Usage
The **Breadcrumbs** component accepts an `items` array of
[breadcrumb props](#core/components/breadcrumbs.breadcrumb) and renders them as an ordered list.
BreadcrumbsBasicExample
@## Overflow
**Breadcrumbs** uses an [**OverflowList**](#core/components/overflow-list)
to collapse breadcrumbs that exceed the available space.
BreadcrumbsOverflowExample
@## Customizing breadcrumbs
The **Breadcrumbs** component supports customization through the `breadcrumbRenderer`
and `currentBreadcrumbRenderer` props, which allow custom rendering of individual breadcrumbs.
BreadcrumbsRendererExample
@## Interactive Playground
BreadcrumbsPlaygroundExample
@## Props interface
BreadcrumbsProps
@## Breadcrumb
The **Breadcrumb** component renders an `a.-breadcrumb` if an `href` or `onClick`
is provided; otherwise, it renders a `span.-breadcrumb`. Typically, breadcrumbs
are supplied as an array of `BreadcrumbProps` to the `items` prop of **Breadcrumbs**,
but the component can also be used directly when implementing a custom `breadcrumbRenderer`.
BreadcrumbProps