mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-14 18:01:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(breadcrumb): improve docs

Browse source
This commit is contained in:
Eric Liu 2025-04-20 14:48:57 -07:00
commit fa7096bd78
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/src/pages/components/Breadcrumb.svx
View file

@ -14,6 +14,8 @@ components: ["Breadcrumb", "BreadcrumbItem"]
## Default ## Default
Display a hierarchical navigation trail with slashes between items. Mark the current page with `isCurrentPage`.
<Breadcrumb> <Breadcrumb>
<BreadcrumbItem href="/">Dashboard</BreadcrumbItem> <BreadcrumbItem href="/">Dashboard</BreadcrumbItem>
<BreadcrumbItem href="/reports">Annual reports</BreadcrumbItem> <BreadcrumbItem href="/reports">Annual reports</BreadcrumbItem>
@ -22,6 +24,8 @@ components: ["Breadcrumb", "BreadcrumbItem"]
## No trailing slash ## No trailing slash
Remove the trailing slash from the last breadcrumb item using `noTrailingSlash`.
<Breadcrumb noTrailingSlash> <Breadcrumb noTrailingSlash>
<BreadcrumbItem href="/">Home</BreadcrumbItem> <BreadcrumbItem href="/">Home</BreadcrumbItem>
<BreadcrumbItem href="/profile" isCurrentPage>Profile</BreadcrumbItem> <BreadcrumbItem href="/profile" isCurrentPage>Profile</BreadcrumbItem>
@ -29,6 +33,8 @@ components: ["Breadcrumb", "BreadcrumbItem"]
## Overflow menu ## Overflow menu
Add an `OverflowMenu` to handle long breadcrumb trails. Use `OverflowMenuItem` components for menu options.
<Breadcrumb> <Breadcrumb>
<BreadcrumbItem href="/">Home</BreadcrumbItem> <BreadcrumbItem href="/">Home</BreadcrumbItem>
<BreadcrumbItem href="/api">API documentation</BreadcrumbItem> <BreadcrumbItem href="/api">API documentation</BreadcrumbItem>
@ -47,4 +53,6 @@ components: ["Breadcrumb", "BreadcrumbItem"]
## Skeleton ## Skeleton
Display a loading state with `skeleton` prop. Use `count` to specify the number of items.
<Breadcrumb noTrailingSlash skeleton count={3} /> <Breadcrumb noTrailingSlash skeleton count={3} />