Breadcrumb

A breadcrumb navigation component that helps users understand their location within a website hierarchy.

Installation

npm install fuyukaki-ui

Usage

import {
  Breadcrumb,
  BreadcrumbList,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from 'fuyukaki-ui'

function App() {
  return (
    <Breadcrumb>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink href="/">Home</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbLink href="/docs">Docs</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  )
}

Basic Example

Custom Separator

You can customize the separator by passing a custom element to the separator prop or BreadcrumbSeparator children.

With ChevronRight:

With Slash:

With Ellipsis

Use BreadcrumbEllipsis to show collapsed items when the path is too long.

Props

ComponentPropType
BreadcrumbseparatorReactNode
BreadcrumbLinkasChildboolean
BreadcrumbLinkhrefstring