Docs

Breadcrumb

The navigation component at the top of screen

A hook for implementing Breadcrumb in your documentation, it returns the path to a page based on the given page tree.

If present, the index page of a folder will be used as the item

Usage

it exports a useBreadcrumb hook:

import { useBreadcrumb } from 'next-docs-zeta/breadcrumb'
 
const tree: PageTree = ...
const pathname = usePathname()
 
const items = useBreadcrumb(pathname, tree)

Prop	Type	Description
`name`	`string`	Name of item
`url`	`string \| null`	Href link

Last updated on

Components

Safe Link

Breadcrumb

Usage

Breadcrumb Item

On this page