Shards React
DocumentationThe breadcrumb component is great for indicating the current page's location within a navigational hierarchy.
Breadcrumbs can be composed using both the BreadCrumb
and BreadcrumbItem
components.
import React from "react";
import { Breadcrumb, BreadcrumbItem } from "shards-react";
export default function BadgesExamples() {
return (
<Breadcrumb>
<BreadcrumbItem>
<a href="#">Home</a>
</BreadcrumbItem>
<BreadcrumbItem active>Library</BreadcrumbItem>
</Breadcrumb>
);
}
The following props are available for the Breadcrumb
component.
Prop | Description | Type | Default | Required |
---|---|---|---|---|
listClassName | The breadcrumb list class name. | String | - | No |
className | The class name. | String | - | No |
aria-label | The aria label value. | String | "breadcrumb" | No |
children | The children nodes. | Node | - | No |
tag | The component tag name. | Func String | "nav" | No |
listTag | The breadcrumb list tag. | Func String | "ol" | No |
The following subcomponents are available for the Breadcrumb
component.
Prop | Description | Type | Default | Required |
---|---|---|---|---|
active | Whether it is active, or not. | Bool | - | No |
className | The class name. | String | - | No |
tag | The component tag. | Func String | "li" | No |