@spectrum-web-components/breadcrumbs 0.0.0-20241209155954

package/README.md

@@ -0,0 +1,130 @@
+## Description
+
+### Usage
+
+[![See it on NPM!](https://img.shields.io/npm/v/@spectrum-web-components/breadcrumbs?style=for-the-badge)](https://www.npmjs.com/package/@spectrum-web-components/breadcrumbs)
+[![How big is this package in your project?](https://img.shields.io/bundlephobia/minzip/@spectrum-web-components/breadcrumbs?style=for-the-badge)](https://bundlephobia.com/result?p=@spectrum-web-components/breadcrumbs)
+[![Try it on webcomponents.dev](https://img.shields.io/badge/Try%20it%20on-webcomponents.dev-green?style=for-the-badge)](https://webcomponents.dev/edit/JsuqWBLZTpGVAkZuHTPA/src/index.ts)
+
+```
+yarn add @spectrum-web-components/breadcrumbs
+```
+
+Import the side effectful registration of `<sp-breadcrumbs>` and `<sp-breadcrumb-item>` via:
+
+```
+import '@spectrum-web-components/breadcrumbs/sp-breadcrumbs.js';
+import '@spectrum-web-components/breadcrumbs/sp-breadcrumb-item.js';
+```
+
+When looking to leverage the `Breadcrumbs` or `BreadcrumbItem` base class as a type and/or for extension purposes, do so via:
+
+```
+import { Breadcrumbs, BreadcrumbItem } from '@spectrum-web-components/breadcrumbs';
+```
+
+## Example
+
+```html
+<sp-breadcrumbs>
+    <sp-breadcrumb-item value="1">Home</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="2">Trend</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="3">March 2019 Assets</sp-breadcrumb-item>
+</sp-breadcrumbs>
+```
+
+## Disabled
+
+`sp-breadcrumb-item` can have a `disabled` state which disables the events from the disabled item.
+
+```html
+<sp-breadcrumbs>
+    <sp-breadcrumb-item disabled value="1">Home</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="2">Trend</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="3">March 2019 Assets</sp-breadcrumb-item>
+</sp-breadcrumbs>
+```
+
+## Compact
+
+When needing to optimize for functional space of `sp-breadcrumbs`, the compact option is useful for reducing the height of the breadcrumbs while still maintaining the proper user context.
+
+```html
+<sp-breadcrumbs compact>
+    <sp-breadcrumb-item value="1">Home</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="2">Trend</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="3">March 2019 Assets</sp-breadcrumb-item>
+</sp-breadcrumbs>
+```
+
+## Links
+
+By default, `sp-breadcrumbs` emits a `change` event when clicking on one of its children.
+However, there may be cases in which these should redirect to another page. This can be achieved by using the `href` attribute instead of `value`.
+Please note that the `change` event will no longer be triggered in this case.
+
+```html
+<sp-breadcrumbs>
+    <sp-breadcrumb-item href="https://opensource.adobe.com/home">
+        Home
+    </sp-breadcrumb-item>
+    <sp-breadcrumb-item href="https://opensource.adobe.com/trend">
+        Trend
+    </sp-breadcrumb-item>
+    <sp-breadcrumb-item href="https://opensource.adobe.com/assets">
+        March 2019 Assets
+    </sp-breadcrumb-item>
+</sp-breadcrumbs>
+```
+
+## Overflowing
+
+When the space is limited or the maximum number of visible items is reached, the component will render the first breadcrumbs inside an action menu. If needed, the last breadcrumb item will be truncated and will render a tooltip with the full text.
+
+As recommended by [Spectrum Design](https://spectrum.adobe.com/page/breadcrumbs/#Don%E2%80%99t-show-too-many-breadcrumbs-at-once), by default the maximum visible breadcrumbs is 4. If you want to override this, you can use the `max-visible-items` attribute.
+
+```html
+<sp-breadcrumbs>
+    <sp-breadcrumb-item value="your_stuff">Your stuff</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="team">Team</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="in_progress">In progress</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="files">Files</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="trend">Trend</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="winter">Winter</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="assets">Assets</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="18x24">18x24</sp-breadcrumb-item>
+</sp-breadcrumbs>
+```
+
+### Show root
+
+Use the "root" slot to always render the first breadcrumb item, even if the breadcrumbs are overflowing.
+
+```html
+<sp-breadcrumbs>
+    <sp-breadcrumb-item slot="root" value="your_stuff">
+        Your stuff
+    </sp-breadcrumb-item>
+    <sp-breadcrumb-item value="team">Files</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="trend">Trend</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="winter">Winter</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="assets">Assets</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="18x24">18x24</sp-breadcrumb-item>
+</sp-breadcrumbs>
+```
+
+## Custom Action Menu
+
+The component offers the possibility to replace the action menu's icon with a custom one using the `icon` slot. Moreover, for accesibility purposes you can provide an internationalized string for the menu label using the `menu-label` attribute.
+
+```html
+<sp-breadcrumbs menu-label="Settings">
+    <sp-icon-settings slot="icon"></sp-icon-settings>
+
+    <sp-breadcrumb-item value="displays">Displays</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="main">Main display</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="brightness">Brightness</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="presets">Presets</sp-breadcrumb-item>
+    <sp-breadcrumb-item value="1">Preset #1</sp-breadcrumb-item>
+</sp-breadcrumbs>
+```

package/package.json

@@ -0,0 +1,85 @@
+{
+    "name": "@spectrum-web-components/breadcrumbs",
+    "version": "0.0.0-20241209155954",
+    "publishConfig": {
+        "access": "public"
+    },
+    "description": "Web component implementation of a Spectrum design Breadcrumbs",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/adobe/spectrum-web-components.git",
+        "directory": "packages/breadcrumbs"
+    },
+    "author": "",
+    "homepage": "https://adobe.github.io/spectrum-web-components/components/breadcrumbs",
+    "bugs": {
+        "url": "https://github.com/adobe/spectrum-web-components/issues"
+    },
+    "main": "src/index.js",
+    "module": "src/index.js",
+    "type": "module",
+    "exports": {
+        ".": {
+            "development": "./src/index.dev.js",
+            "default": "./src/index.js"
+        },
+        "./package.json": "./package.json",
+        "./src/BreadcrumbItem.js": {
+            "development": "./src/BreadcrumbItem.dev.js",
+            "default": "./src/BreadcrumbItem.js"
+        },
+        "./src/Breadcrumbs.js": {
+            "development": "./src/Breadcrumbs.dev.js",
+            "default": "./src/Breadcrumbs.js"
+        },
+        "./src/breadcrumb-item.css.js": "./src/breadcrumb-item.css.js",
+        "./src/breadcrumbs-overrides.css.js": "./src/breadcrumbs-overrides.css.js",
+        "./src/breadcrumbs.css.js": "./src/breadcrumbs.css.js",
+        "./src/index.js": {
+            "development": "./src/index.dev.js",
+            "default": "./src/index.js"
+        },
+        "./sp-breadcrumbs.js": {
+            "development": "./sp-breadcrumbs.dev.js",
+            "default": "./sp-breadcrumbs.js"
+        },
+        "./sp-breadcrumb-item.js": {
+            "development": "./sp-breadcrumb-item.dev.js",
+            "default": "./sp-breadcrumb-item.js"
+        }
+    },
+    "scripts": {
+        "test": "echo \"Error: run tests from mono-repo root.\" && exit 1"
+    },
+    "files": [
+        "**/*.d.ts",
+        "**/*.js",
+        "**/*.js.map",
+        "custom-elements.json",
+        "!stories/",
+        "!test/"
+    ],
+    "keywords": [
+        "spectrum css",
+        "web components",
+        "lit-element",
+        "lit-html"
+    ],
+    "dependencies": {
+        "@spectrum-web-components/action-menu": "0.0.0-20241209155954",
+        "@spectrum-web-components/base": "0.0.0-20241209155954",
+        "@spectrum-web-components/icons-workflow": "0.0.0-20241209155954",
+        "@spectrum-web-components/link": "0.0.0-20241209155954",
+        "@spectrum-web-components/menu": "0.0.0-20241209155954"
+    },
+    "devDependencies": {
+        "@spectrum-css/breadcrumb": "^10.0.0-s2-foundations.15"
+    },
+    "types": "./src/index.d.ts",
+    "customElements": "custom-elements.json",
+    "sideEffects": [
+        "./sp-*.js",
+        "./**/*.dev.js"
+    ]
+}

package/sp-breadcrumb-item.d.ts

@@ -0,0 +1,6 @@
+import { BreadcrumbItem } from './src/BreadcrumbItem.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-breadcrumb-item': BreadcrumbItem;
+    }
+}

package/sp-breadcrumb-item.dev.js

@@ -0,0 +1,4 @@
+"use strict";
+import { BreadcrumbItem } from "./src/BreadcrumbItem.dev.js";
+customElements.define("sp-breadcrumb-item", BreadcrumbItem);
+//# sourceMappingURL=sp-breadcrumb-item.dev.js.map

package/sp-breadcrumb-item.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-breadcrumb-item.ts"],
+  "sourcesContent": ["/*\nCopyright 2024 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { BreadcrumbItem } from './src/BreadcrumbItem.dev.js'\n\ncustomElements.define('sp-breadcrumb-item', BreadcrumbItem);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-breadcrumb-item': BreadcrumbItem;\n    }\n}\n"],
+  "mappings": ";AAYA,SAAS,sBAAsB;AAE/B,eAAe,OAAO,sBAAsB,cAAc;",
+  "names": []
+}

package/sp-breadcrumb-item.js

@@ -0,0 +1,2 @@
+"use strict";import{BreadcrumbItem as e}from"./src/BreadcrumbItem.js";customElements.define("sp-breadcrumb-item",e);
+//# sourceMappingURL=sp-breadcrumb-item.js.map

package/sp-breadcrumb-item.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-breadcrumb-item.ts"],
+  "sourcesContent": ["/*\nCopyright 2024 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { BreadcrumbItem } from './src/BreadcrumbItem.js';\n\ncustomElements.define('sp-breadcrumb-item', BreadcrumbItem);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-breadcrumb-item': BreadcrumbItem;\n    }\n}\n"],
+  "mappings": "aAYA,OAAS,kBAAAA,MAAsB,0BAE/B,eAAe,OAAO,qBAAsBA,CAAc",
+  "names": ["BreadcrumbItem"]
+}

package/sp-breadcrumbs.d.ts

@@ -0,0 +1,6 @@
+import { Breadcrumbs } from './src/Breadcrumbs.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-breadcrumbs': Breadcrumbs;
+    }
+}

package/sp-breadcrumbs.dev.js

@@ -0,0 +1,4 @@
+"use strict";
+import { Breadcrumbs } from "./src/Breadcrumbs.dev.js";
+customElements.define("sp-breadcrumbs", Breadcrumbs);
+//# sourceMappingURL=sp-breadcrumbs.dev.js.map

package/sp-breadcrumbs.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-breadcrumbs.ts"],
+  "sourcesContent": ["/*\nCopyright 2024 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { Breadcrumbs } from './src/Breadcrumbs.dev.js'\n\ncustomElements.define('sp-breadcrumbs', Breadcrumbs);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-breadcrumbs': Breadcrumbs;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,mBAAmB;AAE5B,eAAe,OAAO,kBAAkB,WAAW;",
+  "names": []
+}

package/sp-breadcrumbs.js

@@ -0,0 +1,2 @@
+"use strict";import{Breadcrumbs as e}from"./src/Breadcrumbs.js";customElements.define("sp-breadcrumbs",e);
+//# sourceMappingURL=sp-breadcrumbs.js.map

package/sp-breadcrumbs.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-breadcrumbs.ts"],
+  "sourcesContent": ["/*\nCopyright 2024 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { Breadcrumbs } from './src/Breadcrumbs.js';\n\ncustomElements.define('sp-breadcrumbs', Breadcrumbs);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-breadcrumbs': Breadcrumbs;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,eAAAA,MAAmB,uBAE5B,eAAe,OAAO,iBAAkBA,CAAW",
+  "names": ["Breadcrumbs"]
+}

package/src/BreadcrumbItem.d.ts

@@ -0,0 +1,29 @@
+import { CSSResultArray, PropertyValues, TemplateResult } from '@spectrum-web-components/base';
+import { Focusable } from '@spectrum-web-components/shared/src/focusable.js';
+import '@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js';
+export interface BreadcrumbSelectDetail {
+    value: string;
+}
+declare const BreadcrumbItem_base: typeof Focusable & {
+    new (...args: any[]): import("@spectrum-web-components/shared/src/like-anchor.js").LikeAnchorInterface;
+    prototype: import("@spectrum-web-components/shared/src/like-anchor.js").LikeAnchorInterface;
+};
+export declare class BreadcrumbItem extends BreadcrumbItem_base {
+    static get styles(): CSSResultArray;
+    value: string | undefined;
+    /**
+     * @private
+     * Marks this breadcrumb item as the current route.
+     */
+    isLastOfType: boolean;
+    get focusElement(): HTMLElement;
+    connectedCallback(): void;
+    private announceSelected;
+    protected handleClick(event?: Event): void;
+    protected handleKeyDown(event: KeyboardEvent): void;
+    protected renderLink(): TemplateResult;
+    private renderSeparator;
+    protected render(): TemplateResult;
+    protected updated(changes: PropertyValues): void;
+}
+export {};

package/src/BreadcrumbItem.dev.js

@@ -0,0 +1,115 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+import {
+  html
+} from "@spectrum-web-components/base";
+import { ifDefined } from "@spectrum-web-components/base/src/directives.js";
+import { property } from "@spectrum-web-components/base/src/decorators.js";
+import { Focusable } from "@spectrum-web-components/shared/src/focusable.js";
+import { LikeAnchor } from "@spectrum-web-components/shared/src/like-anchor.js";
+import chevronStyles from "@spectrum-web-components/icon/src/spectrum-icon-chevron.css.js";
+import "@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js";
+import chevronIconOverrides from "@spectrum-web-components/icon/src/icon-chevron-overrides.css.js";
+import styles from "./breadcrumb-item.css.js";
+export class BreadcrumbItem extends LikeAnchor(Focusable) {
+  constructor() {
+    super(...arguments);
+    this.value = void 0;
+    this.isLastOfType = false;
+  }
+  static get styles() {
+    return [styles, chevronStyles, chevronIconOverrides];
+  }
+  get focusElement() {
+    return this.shadowRoot.querySelector("#item-link");
+  }
+  connectedCallback() {
+    super.connectedCallback();
+    if (!this.hasAttribute("role")) {
+      this.setAttribute("role", "listitem");
+    }
+  }
+  announceSelected(value) {
+    const selectDetail = {
+      value
+    };
+    const selectionEvent = new CustomEvent("breadcrumb-select", {
+      bubbles: true,
+      composed: true,
+      detail: selectDetail
+    });
+    this.dispatchEvent(selectionEvent);
+  }
+  handleClick(event) {
+    if (!this.href && event) {
+      event.preventDefault();
+    }
+    if (!this.href || (event == null ? void 0 : event.defaultPrevented)) {
+      if (this.value && !this.isLastOfType) {
+        this.announceSelected(this.value);
+      }
+    }
+  }
+  handleKeyDown(event) {
+    if (event.key === "Enter" || event.keyCode === 13) {
+      this.handleClick(event);
+    }
+  }
+  renderLink() {
+    return html`
+            <a
+                id="item-link"
+                href=${ifDefined(!this.isLastOfType ? this.href : void 0)}
+                tabindex=${0}
+                aria-current=${ifDefined(
+      this.isLastOfType ? "page" : void 0
+    )}
+                @keydown=${this.handleKeyDown}
+                @click=${this.handleClick}
+            >
+                <slot></slot>
+            </a>
+        `;
+  }
+  renderSeparator() {
+    return html`
+            <sp-icon-chevron100
+                id="separator"
+                size="xs"
+                class="spectrum-UIIcon-ChevronRight100"
+            ></sp-icon-chevron100>
+        `;
+  }
+  render() {
+    return html`
+            ${this.renderLink()}
+            <slot name="menu"></slot>
+            ${this.renderSeparator()}
+        `;
+  }
+  updated(changes) {
+    if (changes.has("disabled")) {
+      if (this.disabled) {
+        this.setAttribute("aria-disabled", "true");
+      } else {
+        this.removeAttribute("aria-disabled");
+      }
+    }
+  }
+}
+__decorateClass([
+  property()
+], BreadcrumbItem.prototype, "value", 2);
+__decorateClass([
+  property({ type: Boolean })
+], BreadcrumbItem.prototype, "isLastOfType", 2);
+//# sourceMappingURL=BreadcrumbItem.dev.js.map

package/src/BreadcrumbItem.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["BreadcrumbItem.ts"],
+  "sourcesContent": ["/*\nCopyright 2024 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport {\n    CSSResultArray,\n    html,\n    PropertyValues,\n    TemplateResult,\n} from '@spectrum-web-components/base';\nimport { ifDefined } from '@spectrum-web-components/base/src/directives.js';\nimport { property } from '@spectrum-web-components/base/src/decorators.js';\nimport { Focusable } from '@spectrum-web-components/shared/src/focusable.js';\nimport { LikeAnchor } from '@spectrum-web-components/shared/src/like-anchor.js';\nimport chevronStyles from '@spectrum-web-components/icon/src/spectrum-icon-chevron.css.js';\nimport '@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js';\nimport chevronIconOverrides from '@spectrum-web-components/icon/src/icon-chevron-overrides.css.js';\n\nimport styles from './breadcrumb-item.css.js';\n\nexport interface BreadcrumbSelectDetail {\n    value: string;\n}\n\nexport class BreadcrumbItem extends LikeAnchor(Focusable) {\n    public static override get styles(): CSSResultArray {\n        return [styles, chevronStyles, chevronIconOverrides];\n    }\n\n    @property()\n    public value: string | undefined = undefined;\n\n    /**\n     * @private\n     * Marks this breadcrumb item as the current route.\n     */\n    @property({ type: Boolean })\n    public isLastOfType = false;\n\n    public override get focusElement(): HTMLElement {\n        return this.shadowRoot.querySelector('#item-link') as HTMLElement;\n    }\n\n    override connectedCallback(): void {\n        super.connectedCallback();\n\n        if (!this.hasAttribute('role')) {\n            this.setAttribute('role', 'listitem');\n        }\n    }\n\n    private announceSelected(value: string): void {\n        const selectDetail: BreadcrumbSelectDetail = {\n            value,\n        };\n\n        const selectionEvent = new CustomEvent('breadcrumb-select', {\n            bubbles: true,\n            composed: true,\n            detail: selectDetail,\n        });\n\n        this.dispatchEvent(selectionEvent);\n    }\n\n    protected handleClick(event?: Event): void {\n        if (!this.href && event) {\n            event.preventDefault();\n        }\n\n        if (!this.href || event?.defaultPrevented) {\n            if (this.value && !this.isLastOfType) {\n                this.announceSelected(this.value);\n            }\n        }\n    }\n\n    protected handleKeyDown(event: KeyboardEvent): void {\n        if (event.key === 'Enter' || event.keyCode === 13) {\n            this.handleClick(event);\n        }\n    }\n\n    protected renderLink(): TemplateResult {\n        return html`\n            <a\n                id=\"item-link\"\n                href=${ifDefined(!this.isLastOfType ? this.href : undefined)}\n                tabindex=${0}\n                aria-current=${ifDefined(\n                    this.isLastOfType ? 'page' : undefined\n                )}\n                @keydown=${this.handleKeyDown}\n                @click=${this.handleClick}\n            >\n                <slot></slot>\n            </a>\n        `;\n    }\n\n    private renderSeparator(): TemplateResult {\n        return html`\n            <sp-icon-chevron100\n                id=\"separator\"\n                size=\"xs\"\n                class=\"spectrum-UIIcon-ChevronRight100\"\n            ></sp-icon-chevron100>\n        `;\n    }\n\n    protected override render(): TemplateResult {\n        return html`\n            ${this.renderLink()}\n            <slot name=\"menu\"></slot>\n            ${this.renderSeparator()}\n        `;\n    }\n\n    protected override updated(changes: PropertyValues): void {\n        if (changes.has('disabled')) {\n            if (this.disabled) {\n                this.setAttribute('aria-disabled', 'true');\n            } else {\n                this.removeAttribute('aria-disabled');\n            }\n        }\n    }\n}\n"],
+  "mappings": ";;;;;;;;;;;AAYA;AAAA,EAEI;AAAA,OAGG;AACP,SAAS,iBAAiB;AAC1B,SAAS,gBAAgB;AACzB,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAC3B,OAAO,mBAAmB;AAC1B,OAAO;AACP,OAAO,0BAA0B;AAEjC,OAAO,YAAY;AAMZ,aAAM,uBAAuB,WAAW,SAAS,EAAE;AAAA,EAAnD;AAAA;AAMH,SAAO,QAA4B;AAOnC,SAAO,eAAe;AAAA;AAAA,EAZtB,WAA2B,SAAyB;AAChD,WAAO,CAAC,QAAQ,eAAe,oBAAoB;AAAA,EACvD;AAAA,EAYA,IAAoB,eAA4B;AAC5C,WAAO,KAAK,WAAW,cAAc,YAAY;AAAA,EACrD;AAAA,EAES,oBAA0B;AAC/B,UAAM,kBAAkB;AAExB,QAAI,CAAC,KAAK,aAAa,MAAM,GAAG;AAC5B,WAAK,aAAa,QAAQ,UAAU;AAAA,IACxC;AAAA,EACJ;AAAA,EAEQ,iBAAiB,OAAqB;AAC1C,UAAM,eAAuC;AAAA,MACzC;AAAA,IACJ;AAEA,UAAM,iBAAiB,IAAI,YAAY,qBAAqB;AAAA,MACxD,SAAS;AAAA,MACT,UAAU;AAAA,MACV,QAAQ;AAAA,IACZ,CAAC;AAED,SAAK,cAAc,cAAc;AAAA,EACrC;AAAA,EAEU,YAAY,OAAqB;AACvC,QAAI,CAAC,KAAK,QAAQ,OAAO;AACrB,YAAM,eAAe;AAAA,IACzB;AAEA,QAAI,CAAC,KAAK,SAAQ,+BAAO,mBAAkB;AACvC,UAAI,KAAK,SAAS,CAAC,KAAK,cAAc;AAClC,aAAK,iBAAiB,KAAK,KAAK;AAAA,MACpC;AAAA,IACJ;AAAA,EACJ;AAAA,EAEU,cAAc,OAA4B;AAChD,QAAI,MAAM,QAAQ,WAAW,MAAM,YAAY,IAAI;AAC/C,WAAK,YAAY,KAAK;AAAA,IAC1B;AAAA,EACJ;AAAA,EAEU,aAA6B;AACnC,WAAO;AAAA;AAAA;AAAA,uBAGQ,UAAU,CAAC,KAAK,eAAe,KAAK,OAAO,MAAS,CAAC;AAAA,2BACjD,CAAC;AAAA,+BACG;AAAA,MACX,KAAK,eAAe,SAAS;AAAA,IACjC,CAAC;AAAA,2BACU,KAAK,aAAa;AAAA,yBACpB,KAAK,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA,EAKrC;AAAA,EAEQ,kBAAkC;AACtC,WAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOX;AAAA,EAEmB,SAAyB;AACxC,WAAO;AAAA,cACD,KAAK,WAAW,CAAC;AAAA;AAAA,cAEjB,KAAK,gBAAgB,CAAC;AAAA;AAAA,EAEhC;AAAA,EAEmB,QAAQ,SAA+B;AACtD,QAAI,QAAQ,IAAI,UAAU,GAAG;AACzB,UAAI,KAAK,UAAU;AACf,aAAK,aAAa,iBAAiB,MAAM;AAAA,MAC7C,OAAO;AACH,aAAK,gBAAgB,eAAe;AAAA,MACxC;AAAA,IACJ;AAAA,EACJ;AACJ;AAjGW;AAAA,EADN,SAAS;AAAA,GALD,eAMF;AAOA;AAAA,EADN,SAAS,EAAE,MAAM,QAAQ,CAAC;AAAA,GAZlB,eAaF;",
+  "names": []
+}

package/src/BreadcrumbItem.js

@@ -0,0 +1,23 @@
+"use strict";var u=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var a=(s,i,e,r)=>{for(var t=r>1?void 0:r?p(i,e):i,o=s.length-1,l;o>=0;o--)(l=s[o])&&(t=(r?l(i,e,t):l(t))||t);return r&&t&&u(i,e,t),t};import{html as n}from"@spectrum-web-components/base";import{ifDefined as d}from"@spectrum-web-components/base/src/directives.js";import{property as c}from"@spectrum-web-components/base/src/decorators.js";import{Focusable as h}from"@spectrum-web-components/shared/src/focusable.js";import{LikeAnchor as m}from"@spectrum-web-components/shared/src/like-anchor.js";import f from"@spectrum-web-components/icon/src/spectrum-icon-chevron.css.js";import"@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js";import b from"@spectrum-web-components/icon/src/icon-chevron-overrides.css.js";import v from"./breadcrumb-item.css.js";export class BreadcrumbItem extends m(h){constructor(){super(...arguments);this.value=void 0;this.isLastOfType=!1}static get styles(){return[v,f,b]}get focusElement(){return this.shadowRoot.querySelector("#item-link")}connectedCallback(){super.connectedCallback(),this.hasAttribute("role")||this.setAttribute("role","listitem")}announceSelected(e){const r={value:e},t=new CustomEvent("breadcrumb-select",{bubbles:!0,composed:!0,detail:r});this.dispatchEvent(t)}handleClick(e){!this.href&&e&&e.preventDefault(),(!this.href||e!=null&&e.defaultPrevented)&&this.value&&!this.isLastOfType&&this.announceSelected(this.value)}handleKeyDown(e){(e.key==="Enter"||e.keyCode===13)&&this.handleClick(e)}renderLink(){return n`
+            <a
+                id="item-link"
+                href=${d(this.isLastOfType?void 0:this.href)}
+                tabindex=${0}
+                aria-current=${d(this.isLastOfType?"page":void 0)}
+                @keydown=${this.handleKeyDown}
+                @click=${this.handleClick}
+            >
+                <slot></slot>
+            </a>
+        `}renderSeparator(){return n`
+            <sp-icon-chevron100
+                id="separator"
+                size="xs"
+                class="spectrum-UIIcon-ChevronRight100"
+            ></sp-icon-chevron100>
+        `}render(){return n`
+            ${this.renderLink()}
+            <slot name="menu"></slot>
+            ${this.renderSeparator()}
+        `}updated(e){e.has("disabled")&&(this.disabled?this.setAttribute("aria-disabled","true"):this.removeAttribute("aria-disabled"))}}a([c()],BreadcrumbItem.prototype,"value",2),a([c({type:Boolean})],BreadcrumbItem.prototype,"isLastOfType",2);
+//# sourceMappingURL=BreadcrumbItem.js.map

package/src/BreadcrumbItem.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["BreadcrumbItem.ts"],
+  "sourcesContent": ["/*\nCopyright 2024 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport {\n    CSSResultArray,\n    html,\n    PropertyValues,\n    TemplateResult,\n} from '@spectrum-web-components/base';\nimport { ifDefined } from '@spectrum-web-components/base/src/directives.js';\nimport { property } from '@spectrum-web-components/base/src/decorators.js';\nimport { Focusable } from '@spectrum-web-components/shared/src/focusable.js';\nimport { LikeAnchor } from '@spectrum-web-components/shared/src/like-anchor.js';\nimport chevronStyles from '@spectrum-web-components/icon/src/spectrum-icon-chevron.css.js';\nimport '@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js';\nimport chevronIconOverrides from '@spectrum-web-components/icon/src/icon-chevron-overrides.css.js';\n\nimport styles from './breadcrumb-item.css.js';\n\nexport interface BreadcrumbSelectDetail {\n    value: string;\n}\n\nexport class BreadcrumbItem extends LikeAnchor(Focusable) {\n    public static override get styles(): CSSResultArray {\n        return [styles, chevronStyles, chevronIconOverrides];\n    }\n\n    @property()\n    public value: string | undefined = undefined;\n\n    /**\n     * @private\n     * Marks this breadcrumb item as the current route.\n     */\n    @property({ type: Boolean })\n    public isLastOfType = false;\n\n    public override get focusElement(): HTMLElement {\n        return this.shadowRoot.querySelector('#item-link') as HTMLElement;\n    }\n\n    override connectedCallback(): void {\n        super.connectedCallback();\n\n        if (!this.hasAttribute('role')) {\n            this.setAttribute('role', 'listitem');\n        }\n    }\n\n    private announceSelected(value: string): void {\n        const selectDetail: BreadcrumbSelectDetail = {\n            value,\n        };\n\n        const selectionEvent = new CustomEvent('breadcrumb-select', {\n            bubbles: true,\n            composed: true,\n            detail: selectDetail,\n        });\n\n        this.dispatchEvent(selectionEvent);\n    }\n\n    protected handleClick(event?: Event): void {\n        if (!this.href && event) {\n            event.preventDefault();\n        }\n\n        if (!this.href || event?.defaultPrevented) {\n            if (this.value && !this.isLastOfType) {\n                this.announceSelected(this.value);\n            }\n        }\n    }\n\n    protected handleKeyDown(event: KeyboardEvent): void {\n        if (event.key === 'Enter' || event.keyCode === 13) {\n            this.handleClick(event);\n        }\n    }\n\n    protected renderLink(): TemplateResult {\n        return html`\n            <a\n                id=\"item-link\"\n                href=${ifDefined(!this.isLastOfType ? this.href : undefined)}\n                tabindex=${0}\n                aria-current=${ifDefined(\n                    this.isLastOfType ? 'page' : undefined\n                )}\n                @keydown=${this.handleKeyDown}\n                @click=${this.handleClick}\n            >\n                <slot></slot>\n            </a>\n        `;\n    }\n\n    private renderSeparator(): TemplateResult {\n        return html`\n            <sp-icon-chevron100\n                id=\"separator\"\n                size=\"xs\"\n                class=\"spectrum-UIIcon-ChevronRight100\"\n            ></sp-icon-chevron100>\n        `;\n    }\n\n    protected override render(): TemplateResult {\n        return html`\n            ${this.renderLink()}\n            <slot name=\"menu\"></slot>\n            ${this.renderSeparator()}\n        `;\n    }\n\n    protected override updated(changes: PropertyValues): void {\n        if (changes.has('disabled')) {\n            if (this.disabled) {\n                this.setAttribute('aria-disabled', 'true');\n            } else {\n                this.removeAttribute('aria-disabled');\n            }\n        }\n    }\n}\n"],
+  "mappings": "qNAYA,OAEI,QAAAA,MAGG,gCACP,OAAS,aAAAC,MAAiB,kDAC1B,OAAS,YAAAC,MAAgB,kDACzB,OAAS,aAAAC,MAAiB,mDAC1B,OAAS,cAAAC,MAAkB,qDAC3B,OAAOC,MAAmB,iEAC1B,MAAO,gEACP,OAAOC,MAA0B,kEAEjC,OAAOC,MAAY,2BAMZ,aAAM,uBAAuBH,EAAWD,CAAS,CAAE,CAAnD,kCAMH,KAAO,MAA4B,OAOnC,KAAO,aAAe,GAZtB,WAA2B,QAAyB,CAChD,MAAO,CAACI,EAAQF,EAAeC,CAAoB,CACvD,CAYA,IAAoB,cAA4B,CAC5C,OAAO,KAAK,WAAW,cAAc,YAAY,CACrD,CAES,mBAA0B,CAC/B,MAAM,kBAAkB,EAEnB,KAAK,aAAa,MAAM,GACzB,KAAK,aAAa,OAAQ,UAAU,CAE5C,CAEQ,iBAAiBE,EAAqB,CAC1C,MAAMC,EAAuC,CACzC,MAAAD,CACJ,EAEME,EAAiB,IAAI,YAAY,oBAAqB,CACxD,QAAS,GACT,SAAU,GACV,OAAQD,CACZ,CAAC,EAED,KAAK,cAAcC,CAAc,CACrC,CAEU,YAAYC,EAAqB,CACnC,CAAC,KAAK,MAAQA,GACdA,EAAM,eAAe,GAGrB,CAAC,KAAK,MAAQA,GAAA,MAAAA,EAAO,mBACjB,KAAK,OAAS,CAAC,KAAK,cACpB,KAAK,iBAAiB,KAAK,KAAK,CAG5C,CAEU,cAAcA,EAA4B,EAC5CA,EAAM,MAAQ,SAAWA,EAAM,UAAY,KAC3C,KAAK,YAAYA,CAAK,CAE9B,CAEU,YAA6B,CACnC,OAAOX;AAAA;AAAA;AAAA,uBAGQC,EAAW,KAAK,aAA2B,OAAZ,KAAK,IAAgB,CAAC;AAAA,2BACjD,CAAC;AAAA,+BACGA,EACX,KAAK,aAAe,OAAS,MACjC,CAAC;AAAA,2BACU,KAAK,aAAa;AAAA,yBACpB,KAAK,WAAW;AAAA;AAAA;AAAA;AAAA,SAKrC,CAEQ,iBAAkC,CACtC,OAAOD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAOX,CAEmB,QAAyB,CACxC,OAAOA;AAAA,cACD,KAAK,WAAW,CAAC;AAAA;AAAA,cAEjB,KAAK,gBAAgB,CAAC;AAAA,SAEhC,CAEmB,QAAQY,EAA+B,CAClDA,EAAQ,IAAI,UAAU,IAClB,KAAK,SACL,KAAK,aAAa,gBAAiB,MAAM,EAEzC,KAAK,gBAAgB,eAAe,EAGhD,CACJ,CAjGWC,EAAA,CADNX,EAAS,GALD,eAMF,qBAOAW,EAAA,CADNX,EAAS,CAAE,KAAM,OAAQ,CAAC,GAZlB,eAaF",
+  "names": ["html", "ifDefined", "property", "Focusable", "LikeAnchor", "chevronStyles", "chevronIconOverrides", "styles", "value", "selectDetail", "selectionEvent", "event", "changes", "__decorateClass"]
+}

package/src/Breadcrumbs.d.ts

@@ -0,0 +1,69 @@
+import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
+import '@spectrum-web-components/breadcrumbs/sp-breadcrumb-item.js';
+import '@spectrum-web-components/icons-workflow/icons/sp-icon-folder-open.js';
+import '@spectrum-web-components/action-menu/sp-action-menu.js';
+import '@spectrum-web-components/menu/sp-menu-item.js';
+/**
+ * @element sp-breadcrumbs
+ *
+ * @slot icon - change the default icon of the action menu
+ * @slot root - Breadcrumb item to always display
+ * @slot - Breadcrumb items
+ * @fires change - Announces the selected breadcrumb item
+ */
+export declare class Breadcrumbs extends SpectrumElement {
+    static get styles(): CSSResultArray;
+    /**
+     * Override the maximum number of visible items
+     */
+    maxVisibleItems: number;
+    /**
+     * Accessible name for the Breadcrumbs component
+     */
+    label: string;
+    /**
+     * Change the default label of the action menu
+     */
+    menuLabel: string;
+    /**
+     *  compact option is useful for reducing the height of the breadcrumbs
+     */
+    compact: boolean;
+    private breadcrumbsElements;
+    private rootElement;
+    private list;
+    private items;
+    private visibleItems;
+    private resizeObserver;
+    private firstRender;
+    private menuRef;
+    private get hasMenu();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    updated(changes: PropertyValues): void;
+    /**
+     * We need to understand how much space (px) each breadcrumb item occupies,
+     * in order to know if it fits the available horizontal space.
+     */
+    private calculateBreadcrumbItemsWidth;
+    /**
+     * Calculate which breadcrumbs fit in the viewport, and which should be hidden.
+     */
+    private adjustOverflow;
+    private announceChange;
+    private handleSelect;
+    private handleMenuChange;
+    /**
+     * The truncation menu when there is not enough space to display all the breadcrumbs.
+     * It displays all options within a breadcrumb.
+     * Items are listed with the hierarchy ordered from top (root) to bottom
+     * and include the currently selected item.
+     */
+    protected renderMenu(): TemplateResult;
+    /**
+     * Breadcrumbs were added / removed, we need to recalculate the width of each item
+     * and adjust the overflow accordingly.
+     */
+    private slotChangeHandler;
+    protected render(): TemplateResult;
+}