feat(breadcrumb)!: integrate Breadcrumb with v11 (#1956)

This commit is contained in:
Eric Liu 2024-04-21 12:14:51 -07:00 committed by GitHub
commit 1600308614
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 94 additions and 154 deletions

View file

@ -252,50 +252,13 @@
"isRequired": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"isRequired": false,
"constant": false,
"reactive": false
}
],
"moduleExports": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{
"type": "forwarded",
"name": "click",
"element": "BreadcrumbSkeleton"
},
{
"type": "forwarded",
"name": "mouseover",
"element": "BreadcrumbSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "BreadcrumbSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "BreadcrumbSkeleton"
}
],
"events": [],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "BreadcrumbSkeleton" },
"extends": {
"interface": "BreadcrumbSkeletonProps",
"import": "\"./BreadcrumbSkeleton.svelte\""
}
"rest_props": { "type": "Element", "name": "nav" }
},
{
"moduleName": "BreadcrumbItem",
@ -304,7 +267,7 @@
{
"name": "href",
"kind": "let",
"description": "Set the `href` to use an anchor link",
"description": "Set the `href` to use an anchor link.\nThe `Link` component is used if `href` is set.",
"type": "string",
"isFunction": false,
"isFunctionDeclaration": false,
@ -330,14 +293,14 @@
{
"name": "__default__",
"default": true,
"slot_props": "{props?: { [\"aria-current\"]?: string; class: \"bx--link\"; }}"
"slot_props": "{props?: Pick<AriaAttributes, \"aria-current\"> & { class: \"bx--link\"; }}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "li" },
{ "type": "forwarded", "name": "mouseover", "element": "li" },
{ "type": "forwarded", "name": "mouseenter", "element": "li" },
{ "type": "forwarded", "name": "mouseleave", "element": "li" }
{ "type": "forwarded", "name": "click", "element": "Link" },
{ "type": "forwarded", "name": "mouseover", "element": "Link" },
{ "type": "forwarded", "name": "mouseenter", "element": "Link" },
{ "type": "forwarded", "name": "mouseleave", "element": "Link" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
@ -373,12 +336,7 @@
],
"moduleExports": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},

View file

@ -1,11 +1,12 @@
---
components: ["Breadcrumb", "BreadcrumbItem"]
components: ["Breadcrumb", "BreadcrumbItem", "BreadcrumbSkeleton"]
---
<script>
import {
Breadcrumb,
BreadcrumbItem,
BreadcrumbSkeleton,
OverflowMenu,
OverflowMenuItem
} from "carbon-components-svelte";
@ -27,10 +28,23 @@ components: ["Breadcrumb", "BreadcrumbItem"]
<BreadcrumbItem href="/profile" isCurrentPage>Profile</BreadcrumbItem>
</Breadcrumb>
## Overflow menu
## Custom breadcrumb item
By default, if `href` is provided, the breadcrumb item will render a [Link](/components/Link).
Use a slot to render a custom component. Link attributes can be spread via `let:props`.
<Breadcrumb>
<BreadcrumbItem href="/">Home</BreadcrumbItem>
<BreadcrumbItem isCurrentPage let:props>
<a href="/profile" {...props}>Profile</a>
</BreadcrumbItem>
</Breadcrumb>
## Overflow menu
<Breadcrumb>
<BreadcrumbItem href="/" aria-current='page'>Home</BreadcrumbItem>
<BreadcrumbItem href="/api">API documentation</BreadcrumbItem>
<BreadcrumbItem>
<OverflowMenu>
@ -47,4 +61,14 @@ components: ["Breadcrumb", "BreadcrumbItem"]
## Skeleton
<Breadcrumb noTrailingSlash skeleton count={3} />
<BreadcrumbSkeleton />
## Skeleton (custom number of items)
By default, the number of skeleton items is 3.
<BreadcrumbSkeleton count={5} />
## Skeelton (no trailing slash)
<BreadcrumbSkeleton noTrailingSlash />