Shards React
Shards React

Shards React

Documentation

Breadcrumb

The breadcrumb component is great for indicating the current page's location within a navigational hierarchy.

Basic Example

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>
  );
}

Props

The following props are available for the Breadcrumb component.

PropDescriptionTypeDefaultRequired
listClassNameThe breadcrumb list class name.String-No
classNameThe class name.String-No
aria-labelThe aria label value.String"breadcrumb"No
childrenThe children nodes.Node-No
tagThe component tag name.FuncString"nav"No
listTagThe breadcrumb list tag.FuncString"ol"No

Subcomponents

The following subcomponents are available for the Breadcrumb component.

<BreadcrumbItem/>

PropDescriptionTypeDefaultRequired
activeWhether it is active, or not.Bool-No
classNameThe class name.String-No
tagThe component tag.FuncString"li"No