Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/common/components/Breadcrumbs/Breadcrumbs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,40 @@ export interface BreadcrumbsProps extends BaseComponentProps, PropsWithChildren
/**
* The `Breadcrumbs` component renders a heirarchy of links as a path to the
* current route.
*
* **Example:**
* ```
<Breadcrumbs>
<Breadcrumbs.List>
<Breadcrumbs.Item>
<Breadcrumbs.Link to="/">Home</Breadcrumbs.Link>
</Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item>
<DropdownMenu>
<DropdownMenu.Trigger>
<Breadcrumbs.Ellipsis />
</DropdownMenu.Trigger>
<DropdownMenu.Content className="left-0">
<DropdownMenu.Item>Components</DropdownMenu.Item>
<DropdownMenu.Item>Settings</DropdownMenu.Item>
<DropdownMenu.Item>Tasks</DropdownMenu.Item>
</DropdownMenu.Content>
</DropdownMenu>
</Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item>
<Breadcrumbs.Link to="/app/tasks/97">
dolorum laboriosam eos qui iure aliquam
</Breadcrumbs.Link>
</Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item>
<Breadcrumbs.Page>Edit</Breadcrumbs.Page>
</Breadcrumbs.Item>
</Breadcrumbs.List>
</Breadcrumbs>
* ```
*/
const Breadcrumbs = ({
children,
Expand Down