@synergy-design-system/components 2.10.0 → 2.10.1

package/dist/vscode.html-custom-data.json

@@ -29,29 +29,6 @@
         }
       ]
     },
-    {
-      "name": "syn-badge",
-      "description": "Badges are used to draw attention and display statuses or counts.\n---\n\n\n### **Slots:**\n - _default_ - The badge's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
-      "attributes": [
-        {
-          "name": "variant",
-          "description": "The badge's theme variant.",
-          "values": [
-            { "name": "primary" },
-            { "name": "success" },
-            { "name": "neutral" },
-            { "name": "warning" },
-            { "name": "danger" }
-          ]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://synergy.style/components/badge"
-        }
-      ]
-    },
     {
       "name": "syn-alert",
       "description": "Alerts are used to display important messages inline or as toast notifications.\n---\n\n\n### **Events:**\n - **syn-show** - Emitted when the alert opens.\n- **syn-after-show** - Emitted after the alert opens and all animations are complete.\n- **syn-hide** - Emitted when the alert closes.\n- **syn-after-hide** - Emitted after the alert closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the alert.\n- **hide()** - Hides the alert\n- **toast()** - Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.\n\n### **Slots:**\n - _default_ - The alert's main content.\n- **icon** - An icon to show in the alert. Works best with `<syn-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the optional icon.\n- **message** - The container that wraps the alert's main content.\n- **close-button** - The close button, an `<syn-icon-button>`.\n- **close-button__base** - The close button's exported `base` part.",
@@ -90,6 +67,29 @@
         }
       ]
     },
+    {
+      "name": "syn-badge",
+      "description": "Badges are used to draw attention and display statuses or counts.\n---\n\n\n### **Slots:**\n - _default_ - The badge's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "attributes": [
+        {
+          "name": "variant",
+          "description": "The badge's theme variant.",
+          "values": [
+            { "name": "primary" },
+            { "name": "success" },
+            { "name": "neutral" },
+            { "name": "warning" },
+            { "name": "danger" }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://synergy.style/components/badge"
+        }
+      ]
+    },
     {
       "name": "syn-breadcrumb",
       "description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n---\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<syn-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",

package/package.json

@@ -4,7 +4,7 @@
     "url": "https://www.sick.com"
   },
   "name": "@synergy-design-system/components",
-  "version": "2.10.0",
+  "version": "2.10.1",
   "description": "",
   "repository": {
     "type": "git",
@@ -95,8 +95,8 @@
     "vendorism": "^5.0.0",
     "vue-tsc": "^2.0.29",
     "@synergy-design-system/eslint-config-syn": "0.1.0",
-    "@synergy-design-system/tokens": "2.12.0",
-    "@synergy-design-system/stylelint-config-syn": "0.1.0"
+    "@synergy-design-system/stylelint-config-syn": "0.1.0",
+    "@synergy-design-system/tokens": "2.12.0"
   },
   "release": {
     "branches": [

package/dist/chunks/chunk.HTDUG42Y.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/components/prio-nav/prio-nav.component.ts"],
-  "sourcesContent": ["/* eslint-disable no-param-reassign */\nimport type { CSSResultGroup } from 'lit';\nimport { classMap } from 'lit/directives/class-map.js';\nimport { html } from 'lit/static-html.js';\nimport { query, state } from 'lit/decorators.js';\nimport componentStyles from '../../styles/component.styles.js';\nimport SynergyElement from '../../internal/synergy-element.js';\nimport styles from './prio-nav.styles.js';\nimport SynDropdown from '../dropdown/dropdown.component.js';\nimport SynIcon from '../icon/icon.component.js';\nimport SynMenu from '../menu/menu.component.js';\nimport SynNavItem from '../nav-item/nav-item.component.js';\nimport { LocalizeController } from '../../utilities/localize.js';\nimport {\n  filterOnlyNavItems,\n  getAssignedElementsForSlot,\n} from './utils.js';\n\n/**\n * @summary The `<syn-prio-nav />` element provides a generic navigation bar\n * that can be used to group multiple navigation items  (usually horizontal `<syn-nav-item />`s)\n * together. It will automatically group all items not visible in the viewport into a custom\n * priority menu.\n *\n * @example\n * <syn-prio-nav>\n *  <syn-nav-item current horizontal>Item 1</syn-nav-item>\n *  <button role=\"menuitem\">Item 2 (custom)</button>\n *  <syn-nav-item horizontal>Item 3</syn-nav-item>\n * </syn-prio-nav>\n *\n * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-prio-nav--docs\n * @status stable\n * @since 1.14.0\n *\n * @dependency syn-dropdown\n * @dependency syn-icon\n * @dependency syn-menu\n * @dependency syn-nav-item\n *\n * @slot - The given navigation items. Must be horizontal `<syn-nav-item>`s\n *    or have a role of \"menuitem\"\n *\n * @csspart base - The component's base wrapper.\n * @csspart priority-menu - The wrapper around the priority menu\n * @csspart priority-menu-nav-item - The navigation item for the priority menu\n * @csspart priority-menu-label - The label for the priority menu\n * @csspart priority-menu-icon - The icon for the priority menu\n * @csspart priority-menu-container - The container for the shifted navigation items,\n *    if there is not enough space.\n *\n */\nexport default class SynPrioNav extends SynergyElement {\n  static styles: CSSResultGroup = [componentStyles, styles];\n\n  static dependencies = {\n    'syn-dropdown': SynDropdown,\n    'syn-icon': SynIcon,\n    'syn-menu': SynMenu,\n    'syn-nav-item': SynNavItem,\n  };\n\n  /**\n   * Internal resize observer\n   */\n  private resizeObserver: ResizeObserver;\n\n  private readonly localize = new LocalizeController(this);\n\n  /**\n   * Reference to the rendered children slot\n   */\n  @query('slot:not([name])') private defaultSlot: HTMLSlotElement;\n\n  /**\n   * Reference to the slot where priority menu items are placed\n   */\n  @query('slot[name=menu]') private menuSlot: HTMLSlotElement;\n\n  /**\n   * The wrapper that holds the horizontal navigation items\n   */\n  @query('.horizontal-nav') private horizontalNav: HTMLDivElement;\n\n  /**\n   * The priority menu dropdown\n   */\n  @query('.priority-menu') private priorityMenu: SynDropdown;\n\n  /**\n   * Internal state reflecting if the item positions have been cached\n   */\n  @state() private itemPositionsCached = false;\n\n  /**\n   * The amount of nav items that are currently slotted\n   */\n  @state() private amountOfNavItems = 0;\n\n  /**\n   * The amount of items that are currently visible\n   */\n  @state() private amountOfVisibleItems = 0;\n\n  /**\n   * Internal state reflecting if there are items in the priority menu\n   */\n  @state() private hasItemsInDropdown = false;\n\n  /**\n   * Get a list of all slotted `<syn-nav-item />` elements\n   * that are either in the main slot or the priority menu slot\n   */\n  private getSlottedNavItems() {\n    const navItemsInDefaultSlot = filterOnlyNavItems(getAssignedElementsForSlot(this.defaultSlot));\n    const navItemsInMenuSlot = filterOnlyNavItems(getAssignedElementsForSlot(this.menuSlot));\n    return navItemsInDefaultSlot.concat(navItemsInMenuSlot);\n  }\n\n  /**\n   * Cache the items right offset position to make faster checks placement into priority menu\n   * @param items The items to cache the position for\n   */\n  private cacheItemPositions(items: SynNavItem[]) {\n    items.forEach(item => {\n      // We have to measure while the items are in the primary slot,\n      // else we will just get the placement in the priority menu\n      item.removeAttribute('slot');\n      const { right } = item.getBoundingClientRect();\n      item.dataset.right = right.toString();\n    });\n\n    this.itemPositionsCached = true;\n  }\n\n  /**\n   * Determines which items should be shown or hidden, depending on the current width\n   */\n  private handlePriorityMenu() {\n    const navItems = this.getSlottedNavItems();\n\n    if (!this.itemPositionsCached) {\n      this.cacheItemPositions(navItems);\n    }\n\n    // Get the widths of the horizontal nav and the priority menu\n    // We subtract the width of the priority menu to get the final width\n    const { width } = this.horizontalNav.getBoundingClientRect();\n    const { clientWidth } = this.priorityMenu;\n    const finalWidth = width - clientWidth;\n\n    // Cache the first item\n    let firstHiddenItemRightPos: number | undefined;\n\n    let visibleItems = 0;\n\n    // Save the position of all the elements in a cache\n    navItems.forEach(item => {\n      // Make sure to use the cache obtained in createGhostItems\n      const isHidden = firstHiddenItemRightPos || parseFloat(item.dataset.right!) >= finalWidth;\n\n      if (isHidden) {\n        item.removeAttribute('horizontal');\n        item.setAttribute('slot', 'menu');\n\n        // Makes sure the item is focusable in a syn-dropdown\n        item.setAttribute('role', 'menuitem');\n\n        // Get the position of the first item\n        // Will get used to position the priority menu\n        if (!firstHiddenItemRightPos) {\n          firstHiddenItemRightPos = parseFloat(item.dataset.right!);\n        }\n      } else {\n        visibleItems += 1;\n        item.setAttribute('horizontal', 'true');\n        item.removeAttribute('slot');\n        item.removeAttribute('tabindex');\n\n        // Reset the role to the original value\n        if (item.dataset.originalRole) {\n          item.setAttribute('role', item.dataset.originalRole);\n        } else {\n          item.removeAttribute('role');\n        }\n      }\n    });\n\n    // Tell the render call that we have items in the priority menu\n    // and toggle the visibility of the priority menu label\n    this.hasItemsInDropdown = visibleItems !== navItems.length;\n    this.amountOfVisibleItems = visibleItems;\n  }\n\n  private renderPriorityMenu() {\n    return html`\n      <syn-dropdown\n        class=${classMap({\n          'priority-menu': true,\n          'priority-menu--has-visible-items': this.amountOfVisibleItems !== 0,\n          'priority-menu--hidden': !this.hasItemsInDropdown,\n        })}\n        part=\"priority-menu\"\n        placement=\"bottom-end\"\n      >\n        <syn-nav-item class=\"priority-menu__nav-item\" slot=\"trigger\" horizontal part=\"priority-menu-nav-item\">\n          <syn-icon \n            class=\"priority-menu__icon\"\n            label=\"More\"\n            library=\"system\"\n            name=\"more\"\n            part=\"priority-menu-icon\"\n            slot=\"prefix\"\n          >\n          </syn-icon>\n          <span\n            class=${classMap({\n              'priority-menu__label': true,\n              'priority-menu__label--visible': this.amountOfVisibleItems === 0,\n            })}\n            part=\"priority-menu-label\"\n          >\n            ${this.localize.term('menu')}\n          </span>\n        </syn-nav-item>\n\n        <syn-menu part=\"priority-menu-container\">\n          <slot name=\"menu\"></slot>\n        </syn-menu>\n\n      </syn-dropdown>\n    `;\n  }\n\n  private slotChange() {\n    const slottedItems = this.getSlottedNavItems();\n\n    // Make sure to trigger a recalculation of the item positions if we a new list of slotted items\n    if (slottedItems.length !== this.amountOfNavItems) {\n      this.cacheItemPositions(slottedItems);\n      this.handlePriorityMenu();\n      this.amountOfNavItems = slottedItems.length;\n    }\n  }\n\n  protected firstUpdated() {\n    // Cache the original role of the items so we can reset it if needed.\n    this.getSlottedNavItems().forEach(item => {\n      item.dataset.originalRole = item.getAttribute('role') ?? '';\n    });\n  }\n\n  connectedCallback() {\n    super.connectedCallback();\n    this.resizeObserver = new ResizeObserver(() => this.handlePriorityMenu());\n    this.resizeObserver.observe(this);\n  }\n\n  disconnectedCallback() {\n    super.disconnectedCallback();\n    this.resizeObserver.unobserve(this);\n  }\n\n  render() {\n    /* eslint-disable @typescript-eslint/unbound-method */\n    return html`\n      <nav class=\"horizontal-nav\" part=\"base\">\n        <slot @slotchange=${this.slotChange}></slot>\n        ${this.renderPriorityMenu()}\n      </nav>\n    `;\n    /* eslint-enable @typescript-eslint/unbound-method */\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,SAAS,gBAAgB;AACzB,SAAS,YAAY;AACrB,SAAS,OAAO,aAAa;AAgD7B,IAAqB,aAArB,cAAwC,eAAe;AAAA,EAAvD;AAAA;AAeE,SAAiB,WAAW,IAAI,mBAAmB,IAAI;AAyB9C,SAAQ,sBAAsB;AAK9B,SAAQ,mBAAmB;AAK3B,SAAQ,uBAAuB;AAK/B,SAAQ,qBAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,qBAAqB;AAC3B,UAAM,wBAAwB,mBAAmB,2BAA2B,KAAK,WAAW,CAAC;AAC7F,UAAM,qBAAqB,mBAAmB,2BAA2B,KAAK,QAAQ,CAAC;AACvF,WAAO,sBAAsB,OAAO,kBAAkB;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,mBAAmB,OAAqB;AAC9C,UAAM,QAAQ,UAAQ;AAGpB,WAAK,gBAAgB,MAAM;AAC3B,YAAM,EAAE,MAAM,IAAI,KAAK,sBAAsB;AAC7C,WAAK,QAAQ,QAAQ,MAAM,SAAS;AAAA,IACtC,CAAC;AAED,SAAK,sBAAsB;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA,EAKQ,qBAAqB;AAC3B,UAAM,WAAW,KAAK,mBAAmB;AAEzC,QAAI,CAAC,KAAK,qBAAqB;AAC7B,WAAK,mBAAmB,QAAQ;AAAA,IAClC;AAIA,UAAM,EAAE,MAAM,IAAI,KAAK,cAAc,sBAAsB;AAC3D,UAAM,EAAE,YAAY,IAAI,KAAK;AAC7B,UAAM,aAAa,QAAQ;AAG3B,QAAI;AAEJ,QAAI,eAAe;AAGnB,aAAS,QAAQ,UAAQ;AAEvB,YAAM,WAAW,2BAA2B,WAAW,KAAK,QAAQ,KAAM,KAAK;AAE/E,UAAI,UAAU;AACZ,aAAK,gBAAgB,YAAY;AACjC,aAAK,aAAa,QAAQ,MAAM;AAGhC,aAAK,aAAa,QAAQ,UAAU;AAIpC,YAAI,CAAC,yBAAyB;AAC5B,oCAA0B,WAAW,KAAK,QAAQ,KAAM;AAAA,QAC1D;AAAA,MACF,OAAO;AACL,wBAAgB;AAChB,aAAK,aAAa,cAAc,MAAM;AACtC,aAAK,gBAAgB,MAAM;AAC3B,aAAK,gBAAgB,UAAU;AAG/B,YAAI,KAAK,QAAQ,cAAc;AAC7B,eAAK,aAAa,QAAQ,KAAK,QAAQ,YAAY;AAAA,QACrD,OAAO;AACL,eAAK,gBAAgB,MAAM;AAAA,QAC7B;AAAA,MACF;AAAA,IACF,CAAC;AAID,SAAK,qBAAqB,iBAAiB,SAAS;AACpD,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEQ,qBAAqB;AAC3B,WAAO;AAAA;AAAA,gBAEK,SAAS;AAAA,MACf,iBAAiB;AAAA,MACjB,oCAAoC,KAAK,yBAAyB;AAAA,MAClE,yBAAyB,CAAC,KAAK;AAAA,IACjC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAeU,SAAS;AAAA,MACf,wBAAwB;AAAA,MACxB,iCAAiC,KAAK,yBAAyB;AAAA,IACjE,CAAC,CAAC;AAAA;AAAA;AAAA,cAGA,KAAK,SAAS,KAAK,MAAM,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUtC;AAAA,EAEQ,aAAa;AACnB,UAAM,eAAe,KAAK,mBAAmB;AAG7C,QAAI,aAAa,WAAW,KAAK,kBAAkB;AACjD,WAAK,mBAAmB,YAAY;AACpC,WAAK,mBAAmB;AACxB,WAAK,mBAAmB,aAAa;AAAA,IACvC;AAAA,EACF;AAAA,EAEU,eAAe;AAEvB,SAAK,mBAAmB,EAAE,QAAQ,UAAQ;AAvP9C;AAwPM,WAAK,QAAQ,gBAAe,UAAK,aAAa,MAAM,MAAxB,YAA6B;AAAA,IAC3D,CAAC;AAAA,EACH;AAAA,EAEA,oBAAoB;AAClB,UAAM,kBAAkB;AACxB,SAAK,iBAAiB,IAAI,eAAe,MAAM,KAAK,mBAAmB,CAAC;AACxE,SAAK,eAAe,QAAQ,IAAI;AAAA,EAClC;AAAA,EAEA,uBAAuB;AACrB,UAAM,qBAAqB;AAC3B,SAAK,eAAe,UAAU,IAAI;AAAA,EACpC;AAAA,EAEA,SAAS;AAEP,WAAO;AAAA;AAAA,4BAEiB,KAAK,UAAU;AAAA,UACjC,KAAK,mBAAmB,CAAC;AAAA;AAAA;AAAA,EAIjC;AACF;AA7NqB,WACZ,SAAyB,CAAC,0BAAiB,uBAAM;AADrC,WAGZ,eAAe;AAAA,EACpB,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,gBAAgB;AAClB;AAYmC;AAAA,EAAlC,MAAM,kBAAkB;AAAA,GApBN,WAoBgB;AAKD;AAAA,EAAjC,MAAM,iBAAiB;AAAA,GAzBL,WAyBe;AAKA;AAAA,EAAjC,MAAM,iBAAiB;AAAA,GA9BL,WA8Be;AAKD;AAAA,EAAhC,MAAM,gBAAgB;AAAA,GAnCJ,WAmCc;AAKhB;AAAA,EAAhB,MAAM;AAAA,GAxCY,WAwCF;AAKA;AAAA,EAAhB,MAAM;AAAA,GA7CY,WA6CF;AAKA;AAAA,EAAhB,MAAM;AAAA,GAlDY,WAkDF;AAKA;AAAA,EAAhB,MAAM;AAAA,GAvDY,WAuDF;",
-  "names": []
-}