@k8ordo/ui

Breadcrumb

A breadcrumb trail showing the path to the current page.

Import

ts
import { Breadcrumb } from '@k8ordo/ui';

Usage

tsx
<Breadcrumb.List>
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/">Home</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/components">Components</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/components/breadcrumb">
      Breadcrumb
    </Breadcrumb.Link>
  </Breadcrumb.Item>
</Breadcrumb.List>

Current page

tsx
<Breadcrumb.List>
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/">Home</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/components">Components</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link current href="/components/breadcrumb">
      Breadcrumb
    </Breadcrumb.Link>
  </Breadcrumb.Item>
</Breadcrumb.List>

Sizes

tsx
<Breadcrumb.List size="sm">
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/">Home</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link current href="/docs">Docs</Breadcrumb.Link>
  </Breadcrumb.Item>
</Breadcrumb.List>

<Breadcrumb.List size="md">
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/">Home</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link current href="/docs">Docs</Breadcrumb.Link>
  </Breadcrumb.Item>
</Breadcrumb.List>

<Breadcrumb.List size="lg">
  <Breadcrumb.Item>
    <Breadcrumb.Link href="/">Home</Breadcrumb.Link>
  </Breadcrumb.Item>
  <Breadcrumb.Separator />
  <Breadcrumb.Item>
    <Breadcrumb.Link current href="/docs">Docs</Breadcrumb.Link>
  </Breadcrumb.Item>
</Breadcrumb.List>

Props

Breadcrumb.List

children?
Type: ReactNode
Default: -
size?
Type: 'sm'|'md'|'lg'
Default: 'md'
PropTypeDefault
children?ReactNode-
size?'sm'|'md'|'lg''md'

Breadcrumb.Item

children?
Type: ReactNode
Default: -
PropTypeDefault
children?ReactNode-

Breadcrumb.Separator

PropTypeDefault

Breadcrumb.Link

href
Type: T
Default: -
children?
Type: ReactNode
Default: -
current?
Type: boolean
Default: false
renderAnchor?
Type: (props: RenderBreadcrumbAnchorProps<T>) => ReactNode
Default: defaultRenderBreadcrumbAnchor
PropTypeDefault
hrefT-
children?ReactNode-
current?booleanfalse
renderAnchor?(props: RenderBreadcrumbAnchorProps<T>) => ReactNodedefaultRenderBreadcrumbAnchor
k8ordo

React libraries that use Baseline features without holding back.