Breadcrumb
Examples
Breadcrumb Props
The Breadcrumb component accepts the following props.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| children | node | null | Children nodes be rendered to the BreadCrumb. Should be of type BreadCrumbItem. | |
| className | string | '' | Additional classes added to the breadcrumb nav. | |
| aria-label | string | 'breadcrumb' | Aria-label added to the breadcrumb nav. |
BreadcrumbItem Props
The BreadcrumbItem component accepts the following props.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| children | node | null | Content rendered inside the breadcrumb item. | |
| className | string | '' | Additional classes added to the breadcrumb item. | |
| to | string | null | HREF for breadcrumb link. | |
| isActive | bool | false | Flag indicating whether the item is active. | |
| target | string | null | Target for breadcrumb link. | |
| component | custom | 'a' | Sets the base component to render. Defaults to <a> |
BreadcrumbHeading Props
The BreadcrumbHeading component accepts the following props.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| children | node | null | Content rendered inside the breadcrumb title. | |
| className | string | '' | Additional classes added to the breadcrumb item. | |
| to | string | null | HREF for breadcrumb link. | |
| target | string | null | Target for breadcrumb link. | |
| component | custom | 'a' | Sets the base component to render. Defaults to <a> |