Skip to content

Commit

Permalink
Add Breadcrumbs docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ghsteff committed May 13, 2024
1 parent dcce23d commit 816a1e5
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/components/layout/Breadcrumbs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { Meta, Canvas, ArgTypes } from '@storybook/addon-docs';
import { Breadcrumbs, BreadcrumbList, BreadcrumbItem, BreadcrumbPage, BreadcrumbLink, BreadcrumbSeparator, breadcrumbsTheme } from '../../../src/layout/Breadcrumbs';
import * as BreadcrumbsStories from '../../../src/layout/Breadcrumbs/Breadcrumbs.story';
import ThemeRender from '../../ThemeRender.tsx';

<Meta title="Docs/Components/Layout/Breadcrumbs" />

# Breadcrumbs
Breadcrumbs are a navigation component that shows the user's location within a website or application.

## Example
<Canvas sourceState="shown" of={BreadcrumbsStories.Basic}/>

## Theme
This component uses the following default theme:

<ThemeRender theme={breadcrumbsTheme} />

Learn more about how to customize in the [Theme documentation](?path=/docs/docs-theme-getting-started--docs).

## API

### Breadcrumbs
<ArgTypes of={Breadcrumbs} />

### BreadcrumbList
<ArgTypes of={BreadcrumbList} />

### BreadcrumbLink
<ArgTypes of={BreadcrumbLink} />

### BreadcrumbSeparator
<ArgTypes of={BreadcrumbSeparator} />

0 comments on commit 816a1e5

Please sign in to comment.