@spectrum-web-components/breadcrumbs 0.47.0

package/custom-elements.json

@@ -0,0 +1,480 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "sp-breadcrumb-item.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "sp-breadcrumb-item",
+          "declaration": {
+            "name": "BreadcrumbItem",
+            "module": "/src/BreadcrumbItem.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "sp-breadcrumbs.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "sp-breadcrumbs",
+          "declaration": {
+            "name": "Breadcrumbs",
+            "module": "/src/Breadcrumbs.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/BreadcrumbItem.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "BreadcrumbItem",
+          "members": [
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "public",
+              "default": "undefined",
+              "attribute": "value"
+            },
+            {
+              "kind": "field",
+              "name": "isLastOfType",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "attribute": "isLastOfType"
+            },
+            {
+              "kind": "field",
+              "name": "focusElement",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "privacy": "public",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "announceSelected",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "handleClick",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "optional": true,
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "renderLink",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "renderSeparator",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "value",
+              "type": {
+                "text": "string | undefined"
+              },
+              "default": "undefined",
+              "fieldName": "value"
+            },
+            {
+              "name": "isLastOfType",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "isLastOfType"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "LikeAnchor",
+              "package": "@spectrum-web-components/shared/src/like-anchor.js"
+            }
+          ],
+          "superclass": {
+            "name": "Focusable",
+            "package": "@spectrum-web-components/shared/src/focusable.js"
+          },
+          "tagName": "sp-breadcrumb-item",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "BreadcrumbItem",
+          "declaration": {
+            "name": "BreadcrumbItem",
+            "module": "src/BreadcrumbItem.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/Breadcrumbs.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "Breadcrumbs",
+          "slots": [
+            {
+              "description": "change the default icon of the action menu",
+              "name": "icon"
+            },
+            {
+              "description": "Breadcrumb item to always display",
+              "name": "root"
+            },
+            {
+              "description": "Breadcrumb items",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "maxVisibleItems",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "4",
+              "description": "Override the maximum number of visible items",
+              "attribute": "max-visible-items"
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "''",
+              "description": "Accessible name for the Breadcrumbs component",
+              "attribute": "label"
+            },
+            {
+              "kind": "field",
+              "name": "menuLabel",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "'More items'",
+              "description": "Change the default label of the action menu",
+              "attribute": "menu-label"
+            },
+            {
+              "kind": "field",
+              "name": "compact",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false",
+              "description": "compact option is useful for reducing the height of the breadcrumbs",
+              "attribute": "compact"
+            },
+            {
+              "kind": "field",
+              "name": "breadcrumbsElements",
+              "type": {
+                "text": "BreadcrumbElement[]"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "rootElement",
+              "type": {
+                "text": "BreadcrumbElement[]"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "list",
+              "type": {
+                "text": "HTMLUListElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "items",
+              "type": {
+                "text": "BreadcrumbItem[]"
+              },
+              "privacy": "private",
+              "default": "[]"
+            },
+            {
+              "kind": "field",
+              "name": "visibleItems",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "resizeObserver",
+              "type": {
+                "text": "ResizeObserver | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "firstRender",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "true"
+            },
+            {
+              "kind": "field",
+              "name": "menuRef",
+              "type": {
+                "text": "Ref<ActionMenu>"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "hasMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "calculateBreadcrumbItemsWidth",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "We need to understand how much space (px) each breadcrumb item occupies,\nin order to know if it fits the available horizontal space."
+            },
+            {
+              "kind": "method",
+              "name": "adjustOverflow",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Calculate which breadcrumbs fit in the viewport, and which should be hidden."
+            },
+            {
+              "kind": "method",
+              "name": "announceChange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "handleSelect",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "CustomEvent<BreadcrumbSelectDetail> & { target: BreadcrumbItem }"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "handleMenuChange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "Event & { target: ActionMenu }"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "renderMenu",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              },
+              "description": "The truncation menu when there is not enough space to display all the breadcrumbs.\nIt displays all options within a breadcrumb.\nItems are listed with the hierarchy ordered from top (root) to bottom\nand include the currently selected item."
+            },
+            {
+              "kind": "method",
+              "name": "slotChangeHandler",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "Promise<void>"
+                }
+              },
+              "description": "Breadcrumbs were added / removed, we need to recalculate the width of each item\nand adjust the overflow accordingly."
+            }
+          ],
+          "events": [
+            {
+              "description": "Announces the selected breadcrumb item",
+              "name": "change"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "max-visible-items",
+              "type": {
+                "text": "number"
+              },
+              "default": "4",
+              "description": "Override the maximum number of visible items",
+              "fieldName": "maxVisibleItems"
+            },
+            {
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "Accessible name for the Breadcrumbs component",
+              "fieldName": "label"
+            },
+            {
+              "name": "menu-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'More items'",
+              "description": "Change the default label of the action menu",
+              "fieldName": "menuLabel"
+            },
+            {
+              "name": "compact",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "compact option is useful for reducing the height of the breadcrumbs",
+              "fieldName": "compact"
+            }
+          ],
+          "superclass": {
+            "name": "SpectrumElement",
+            "package": "@spectrum-web-components/base"
+          },
+          "tagName": "sp-breadcrumbs",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "Breadcrumbs",
+          "declaration": {
+            "name": "Breadcrumbs",
+            "module": "src/Breadcrumbs.js"
+          }
+        }
+      ]
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+    "name": "@spectrum-web-components/breadcrumbs",
+    "version": "0.47.0",
+    "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.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.47.0",
+        "@spectrum-web-components/base": "^0.47.0",
+        "@spectrum-web-components/icons-workflow": "^0.47.0",
+        "@spectrum-web-components/link": "^0.47.0",
+        "@spectrum-web-components/menu": "^0.47.0"
+    },
+    "devDependencies": {
+        "@spectrum-css/breadcrumb": "^9.1.3"
+    },
+    "types": "./src/index.d.ts",
+    "customElements": "custom-elements.json",
+    "sideEffects": [
+        "./sp-*.js",
+        "./**/*.dev.js"
+    ],
+    "gitHead": "7121f0bbe175ac3c34f17e51aa41429c2c04bd35"
+}

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,28 @@
+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 renderLink(): TemplateResult;
+    private renderSeparator;
+    protected render(): TemplateResult;
+    protected updated(changes: PropertyValues): void;
+}
+export {};