diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 7e2532ca29..abe2152456 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -269,7 +269,6 @@ None. | Prop name | Required | Kind | Reactive | Type | Default value | Description | | :-------------- | :------- | :--------------- | :------- | -------------------- | ------------------ | --------------------------------------------------- | | noTrailingSlash | No | let | No | boolean | false | Set to `true` to hide the breadcrumb trailing slash | -| skeleton | No | let | No | boolean | false | Set to `true` to display skeleton state | ### Slots @@ -279,27 +278,22 @@ None. ### Events -| Event name | Type | Detail | -| :--------- | :-------- | :----- | -| click | forwarded | -- | -| mouseover | forwarded | -- | -| mouseenter | forwarded | -- | -| mouseleave | forwarded | -- | +None. ## `BreadcrumbItem` ### Props -| Prop name | Required | Kind | Reactive | Type | Default value | Description | -| :------------ | :------- | :--------------- | :------- | -------------------- | ---------------------- | ---------------------------------------------------------------- | -| href | No | let | No | string | undefined | Set the `href` to use an anchor link | -| isCurrentPage | No | let | No | boolean | false | Set to `true` if the breadcrumb item represents the current page | +| Prop name | Required | Kind | Reactive | Type | Default value | Description | +| :------------ | :------- | :--------------- | :------- | -------------------- | ---------------------- | ----------------------------------------------------------------------------------------- | +| href | No | let | No | string | undefined | Set the `href` to use an anchor link.
The `Link` component is used if `href` is set. | +| isCurrentPage | No | let | No | boolean | false | Set to `true` if the breadcrumb item represents the current page | ### Slots -| Slot name | Default | Props | Fallback | -| :-------- | :------ | :------------------------------------------------------------------------ | :------- | -| -- | Yes | {props?: { ["aria-current"]?: string; class: "bx--link"; }} | -- | +| Slot name | Default | Props | Fallback | +| :-------- | :------ | :------------------------------------------------------------------------------------ | :------- | +| -- | Yes | {props?: Pick & { class: "bx--link"; }} | -- | ### Events @@ -325,12 +319,7 @@ None. ### Events -| Event name | Type | Detail | -| :--------- | :-------- | :----- | -| click | forwarded | -- | -| mouseover | forwarded | -- | -| mouseenter | forwarded | -- | -| mouseleave | forwarded | -- | +None. ## `Breakpoint` diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index e240b211d9..71fc09ff1e 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -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 & { 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" } }, diff --git a/docs/src/pages/components/Breadcrumb.svx b/docs/src/pages/components/Breadcrumb.svx index 75a01c5afc..866a426024 100644 --- a/docs/src/pages/components/Breadcrumb.svx +++ b/docs/src/pages/components/Breadcrumb.svx @@ -1,11 +1,12 @@ --- -components: ["Breadcrumb", "BreadcrumbItem"] +components: ["Breadcrumb", "BreadcrumbItem", "BreadcrumbSkeleton"] --- - -{#if skeleton} - -{:else} - - -{/if} + + + diff --git a/src/Breadcrumb/BreadcrumbItem.svelte b/src/Breadcrumb/BreadcrumbItem.svelte index 07009a42f3..066a731fea 100644 --- a/src/Breadcrumb/BreadcrumbItem.svelte +++ b/src/Breadcrumb/BreadcrumbItem.svelte @@ -1,10 +1,13 @@ - -
  • {#if href} - + {:else} diff --git a/src/Breadcrumb/BreadcrumbSkeleton.svelte b/src/Breadcrumb/BreadcrumbSkeleton.svelte index b6ec1109c9..b31a81e8b3 100644 --- a/src/Breadcrumb/BreadcrumbSkeleton.svelte +++ b/src/Breadcrumb/BreadcrumbSkeleton.svelte @@ -1,4 +1,6 @@ - -
    - {#each Array.from({ length: count }, (_, i) => i) as item (item)} + {#each Array.from({ length: count }) as item}
     
    diff --git a/tests/Breadcrumb.test.svelte b/tests/Breadcrumb.test.svelte index 3baab96ea3..91d5681e13 100644 --- a/tests/Breadcrumb.test.svelte +++ b/tests/Breadcrumb.test.svelte @@ -1,16 +1,14 @@ Dashboard Annual reports 2019 + + Q1 + - - Home - Profile - - - + diff --git a/types/Breadcrumb/Breadcrumb.svelte.d.ts b/types/Breadcrumb/Breadcrumb.svelte.d.ts index 6b005545ce..167c71fec9 100644 --- a/types/Breadcrumb/Breadcrumb.svelte.d.ts +++ b/types/Breadcrumb/Breadcrumb.svelte.d.ts @@ -1,27 +1,20 @@ import type { SvelteComponentTyped } from "svelte"; -import type { BreadcrumbSkeletonProps } from "./BreadcrumbSkeleton.svelte"; +import type { SvelteHTMLElements } from "svelte/elements"; -export interface BreadcrumbProps extends BreadcrumbSkeletonProps { +type RestProps = SvelteHTMLElements["nav"]; + +export interface BreadcrumbProps extends RestProps { /** * Set to `true` to hide the breadcrumb trailing slash * @default false */ noTrailingSlash?: boolean; - /** - * Set to `true` to display skeleton state - * @default false - */ - skeleton?: boolean; + [key: `data-${string}`]: any; } export default class Breadcrumb extends SvelteComponentTyped< BreadcrumbProps, - { - click: WindowEventMap["click"]; - mouseover: WindowEventMap["mouseover"]; - mouseenter: WindowEventMap["mouseenter"]; - mouseleave: WindowEventMap["mouseleave"]; - }, + Record, { default: {} } > {} diff --git a/types/Breadcrumb/BreadcrumbItem.svelte.d.ts b/types/Breadcrumb/BreadcrumbItem.svelte.d.ts index bdf2aee83d..6233c0a17c 100644 --- a/types/Breadcrumb/BreadcrumbItem.svelte.d.ts +++ b/types/Breadcrumb/BreadcrumbItem.svelte.d.ts @@ -5,7 +5,8 @@ type RestProps = SvelteHTMLElements["li"]; export interface BreadcrumbItemProps extends RestProps { /** - * Set the `href` to use an anchor link + * Set the `href` to use an anchor link. + * The `Link` component is used if `href` is set. * @default undefined */ href?: string; @@ -27,5 +28,9 @@ export default class BreadcrumbItem extends SvelteComponentTyped< mouseenter: WindowEventMap["mouseenter"]; mouseleave: WindowEventMap["mouseleave"]; }, - { default: { props?: { ["aria-current"]?: string; class: "bx--link" } } } + { + default: { + props?: Pick & { class: "bx--link" }; + }; + } > {} diff --git a/types/Breadcrumb/BreadcrumbSkeleton.svelte.d.ts b/types/Breadcrumb/BreadcrumbSkeleton.svelte.d.ts index 85bddbe5ab..6b1d165a34 100644 --- a/types/Breadcrumb/BreadcrumbSkeleton.svelte.d.ts +++ b/types/Breadcrumb/BreadcrumbSkeleton.svelte.d.ts @@ -21,11 +21,6 @@ export interface BreadcrumbSkeletonProps extends RestProps { export default class BreadcrumbSkeleton extends SvelteComponentTyped< BreadcrumbSkeletonProps, - { - click: WindowEventMap["click"]; - mouseover: WindowEventMap["mouseover"]; - mouseenter: WindowEventMap["mouseenter"]; - mouseleave: WindowEventMap["mouseleave"]; - }, + Record, {} > {}