@synergy-design-system/metadata 1.0.0 → 3.0.1

package/data/layers/interface/component/component:syn-popup.json

@@ -0,0 +1,360 @@
+{
+  "attributes": [
+    {
+      "default": "false",
+      "description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
+      "fieldName": "active",
+      "name": "active",
+      "reflects": true,
+      "type": "boolean"
+    },
+    {
+      "description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
+      "fieldName": "anchor",
+      "name": "anchor",
+      "reflects": false,
+      "type": "Element | string | VirtualElement"
+    },
+    {
+      "default": "false",
+      "description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
+      "fieldName": "arrow",
+      "name": "arrow",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "10",
+      "description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
+      "fieldName": "arrowPadding",
+      "name": "arrow-padding",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "default": "'anchor'",
+      "description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
+      "fieldName": "arrowPlacement",
+      "name": "arrow-placement",
+      "reflects": false,
+      "type": "'start' | 'end' | 'center' | 'anchor'"
+    },
+    {
+      "description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
+      "fieldName": "autoSize",
+      "name": "auto-size",
+      "reflects": false,
+      "type": "'horizontal' | 'vertical' | 'both'"
+    },
+    {
+      "default": "0",
+      "description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
+      "fieldName": "autoSizePadding",
+      "name": "auto-size-padding",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
+      "fieldName": "autoSizeBoundary",
+      "name": "autoSizeBoundary",
+      "reflects": false,
+      "type": "Element | Element[]"
+    },
+    {
+      "default": "0",
+      "description": "The distance in pixels from which to offset the panel away from its anchor.",
+      "fieldName": "distance",
+      "name": "distance",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "default": "false",
+      "description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
+      "fieldName": "flip",
+      "name": "flip",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "''",
+      "description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
+      "fieldName": "flipFallbackPlacements",
+      "name": "flip-fallback-placements",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "default": "'best-fit'",
+      "description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
+      "fieldName": "flipFallbackStrategy",
+      "name": "flip-fallback-strategy",
+      "reflects": false,
+      "type": "'best-fit' | 'initial'"
+    },
+    {
+      "default": "0",
+      "description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
+      "fieldName": "flipPadding",
+      "name": "flip-padding",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
+      "fieldName": "flipBoundary",
+      "name": "flipBoundary",
+      "reflects": false,
+      "type": "Element | Element[]"
+    },
+    {
+      "default": "false",
+      "description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
+      "fieldName": "hoverBridge",
+      "name": "hover-bridge",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "'top'",
+      "description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
+      "fieldName": "placement",
+      "name": "placement",
+      "reflects": true,
+      "type": "| 'top'\n    | 'top-start'\n    | 'top-end'\n    | 'bottom'\n    | 'bottom-start'\n    | 'bottom-end'\n    | 'right'\n    | 'right-start'\n    | 'right-end'\n    | 'left'\n    | 'left-start'\n    | 'left-end'"
+    },
+    {
+      "default": "false",
+      "description": "Moves the popup along the axis to keep it in view when clipped.",
+      "fieldName": "shift",
+      "name": "shift",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "0",
+      "description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
+      "fieldName": "shiftPadding",
+      "name": "shift-padding",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
+      "fieldName": "shiftBoundary",
+      "name": "shiftBoundary",
+      "reflects": false,
+      "type": "Element | Element[]"
+    },
+    {
+      "default": "0",
+      "description": "The distance in pixels from which to offset the panel along its anchor.",
+      "fieldName": "skidding",
+      "name": "skidding",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "description": "Syncs the popup's width or height to that of the anchor element.",
+      "fieldName": "sync",
+      "name": "sync",
+      "reflects": false,
+      "type": "'width' | 'height' | 'both'"
+    }
+  ],
+  "cssParts": [
+    {
+      "description": "The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.",
+      "name": "arrow"
+    },
+    {
+      "description": "The hover bridge element. Only available when the `hover-bridge` option is enabled.",
+      "name": "hover-bridge"
+    },
+    {
+      "description": "The popup's container. Useful for setting a background color, box shadow, etc.",
+      "name": "popup"
+    }
+  ],
+  "dependencies": [],
+  "documentation": "https://synergy-design-system.github.io/?path=/docs/components-syn-popup--docs",
+  "events": [
+    {
+      "description": "Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it.",
+      "name": "syn-reposition",
+      "type": "SynRepositionEvent"
+    }
+  ],
+  "methods": [
+    {
+      "description": "Forces the popup to recalculate and reposition itself.",
+      "name": "reposition",
+      "parameters": []
+    }
+  ],
+  "properties": [
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
+      "name": "active",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
+      "name": "anchor",
+      "type": "Element | string | VirtualElement"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
+      "name": "arrow",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "10",
+      "description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
+      "name": "arrowPadding",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "'anchor'",
+      "description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
+      "name": "arrowPlacement",
+      "type": "'start' | 'end' | 'center' | 'anchor'"
+    },
+    {
+      "access": "public",
+      "description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
+      "name": "autoSize",
+      "type": "'horizontal' | 'vertical' | 'both'"
+    },
+    {
+      "access": "public",
+      "description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
+      "name": "autoSizeBoundary",
+      "type": "Element | Element[]"
+    },
+    {
+      "access": "public",
+      "default": "0",
+      "description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
+      "name": "autoSizePadding",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "0",
+      "description": "The distance in pixels from which to offset the panel away from its anchor.",
+      "name": "distance",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
+      "name": "flip",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
+      "name": "flipBoundary",
+      "type": "Element | Element[]"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
+      "name": "flipFallbackPlacements",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "'best-fit'",
+      "description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
+      "name": "flipFallbackStrategy",
+      "type": "'best-fit' | 'initial'"
+    },
+    {
+      "access": "public",
+      "default": "0",
+      "description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
+      "name": "flipPadding",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
+      "name": "hoverBridge",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "'top'",
+      "description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
+      "name": "placement",
+      "type": "| 'top'\n    | 'top-start'\n    | 'top-end'\n    | 'bottom'\n    | 'bottom-start'\n    | 'bottom-end'\n    | 'right'\n    | 'right-start'\n    | 'right-end'\n    | 'left'\n    | 'left-start'\n    | 'left-end'"
+    },
+    {
+      "access": "public",
+      "description": "A reference to the internal popup container. Useful for animating and styling the popup with JavaScript.",
+      "name": "popup",
+      "type": "HTMLElement"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Moves the popup along the axis to keep it in view when clipped.",
+      "name": "shift",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
+      "name": "shiftBoundary",
+      "type": "Element | Element[]"
+    },
+    {
+      "access": "public",
+      "default": "0",
+      "description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
+      "name": "shiftPadding",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "0",
+      "description": "The distance in pixels from which to offset the panel along its anchor.",
+      "name": "skidding",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "description": "Syncs the popup's width or height to that of the anchor element.",
+      "name": "sync",
+      "type": "'width' | 'height' | 'both'"
+    }
+  ],
+  "since": "2.0",
+  "slots": [
+    {
+      "description": "The popup's content.",
+      "name": ""
+    },
+    {
+      "description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead.",
+      "name": "anchor"
+    }
+  ],
+  "sourceModulePath": "components/popup/popup.js",
+  "status": "stable",
+  "summary": "Popup is a utility that lets you declaratively anchor \"popup\" containers to another element.",
+  "tagName": "syn-popup"
+}

package/data/layers/interface/component/component:syn-popup.md

@@ -0,0 +1,258 @@
+# syn-popup
+
+## Summary
+
+Popup is a utility that lets you declaratively anchor "popup" containers to another element.
+
+## Documentation
+
+- [Component Documentation](https://synergy-design-system.github.io/?path=/docs/components-syn-popup--docs)
+
+## Class Information
+
+- **Tag Name:** `syn-popup`
+- **Import Example:** `import SynPopup from '@synergy-design-system/components/components/popup/popup.js';`
+
+## Usage Information
+
+- **Status:** stable
+- **Since:** 2.0
+
+## Available Slots
+
+- `(default)`: The popup's content.
+- `anchor`: The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead.
+
+## Available Properties
+
+### active
+
+attribute: `active`
+reflects: yes
+type: `boolean`
+default: `false`
+
+Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn down and the popup will be hidden.
+
+### anchor
+
+attribute: `anchor`
+reflects: no
+type: `Element | string | VirtualElement`
+default: none
+
+The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor element `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the `anchor` slot instead.
+
+### arrow
+
+attribute: `arrow`
+reflects: no
+type: `boolean`
+default: `false`
+
+Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and `--arrow-color` custom properties. For additional customizations, you can also target the arrow using `::part(arrow)` in your stylesheet.
+
+### arrowPadding
+
+attribute: `arrow-padding`
+reflects: no
+type: `number`
+default: `10`
+
+The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example, this will prevent it from overflowing the corners.
+
+### arrowPlacement
+
+attribute: `arrow-placement`
+reflects: no
+type: `'start' | 'end' | 'center' | 'anchor'`
+default: `'anchor'`
+
+The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the anchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will align the arrow to the start, end, or center of the popover instead.
+
+### autoSize
+
+attribute: `auto-size`
+reflects: no
+type: `'horizontal' | 'vertical' | 'both'`
+default: none
+
+When set, this will cause the popup to automatically resize itself to prevent it from overflowing.
+
+### autoSizeBoundary
+
+attribute: `autoSizeBoundary`
+reflects: no
+type: `Element | Element[]`
+default: none
+
+The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By default, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can change the boundary by passing a reference to one or more elements to this property.
+
+### autoSizePadding
+
+attribute: `auto-size-padding`
+reflects: no
+type: `number`
+default: `0`
+
+The amount of padding, in pixels, to exceed before the auto-size behavior will occur.
+
+### distance
+
+attribute: `distance`
+reflects: no
+type: `number`
+default: `0`
+
+The distance in pixels from which to offset the panel away from its anchor.
+
+### flip
+
+attribute: `flip`
+reflects: no
+type: `boolean`
+default: `false`
+
+When set, placement of the popup will flip to the opposite site to keep it in view. You can use `flipFallbackPlacements` to further configure how the fallback placement is determined.
+
+### flipBoundary
+
+attribute: `flipBoundary`
+reflects: no
+type: `Element | Element[]`
+default: none
+
+The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By default, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can change the boundary by passing a reference to one or more elements to this property.
+
+### flipFallbackPlacements
+
+attribute: `flip-fallback-placements`
+reflects: no
+type: `string`
+default: `''`
+
+If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a string of any number of placements separated by a space, e.g. "top bottom left". If no placement fits, the flip fallback strategy will be used instead.
+
+### flipFallbackStrategy
+
+attribute: `flip-fallback-strategy`
+reflects: no
+type: `'best-fit' | 'initial'`
+default: `'best-fit'`
+
+When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether the popup should be positioned using the best available fit based on available space or as it was initially preferred.
+
+### flipPadding
+
+attribute: `flip-padding`
+reflects: no
+type: `number`
+default: `0`
+
+The amount of padding, in pixels, to exceed before the flip behavior will occur.
+
+### hoverBridge
+
+attribute: `hover-bridge`
+reflects: no
+type: `boolean`
+default: `false`
+
+When a gap exists between the anchor and the popup element, this option will add a "hover bridge" that fills the gap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane because the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is active.
+
+### placement
+
+attribute: `placement`
+reflects: yes
+type: `| 'top'
+    | 'top-start'
+    | 'top-end'
+    | 'bottom'
+    | 'bottom-start'
+    | 'bottom-end'
+    | 'right'
+    | 'right-start'
+    | 'right-end'
+    | 'left'
+    | 'left-start'
+    | 'left-end'`
+default: `'top'`
+
+The preferred placement of the popup. Note that the actual placement will vary as configured to keep the panel inside of the viewport.
+
+### popup
+
+attribute: -
+reflects: -
+type: `HTMLElement`
+default: none
+
+A reference to the internal popup container. Useful for animating and styling the popup with JavaScript.
+
+### shift
+
+attribute: `shift`
+reflects: no
+type: `boolean`
+default: `false`
+
+Moves the popup along the axis to keep it in view when clipped.
+
+### shiftBoundary
+
+attribute: `shiftBoundary`
+reflects: no
+type: `Element | Element[]`
+default: none
+
+The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By default, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can change the boundary by passing a reference to one or more elements to this property.
+
+### shiftPadding
+
+attribute: `shift-padding`
+reflects: no
+type: `number`
+default: `0`
+
+The amount of padding, in pixels, to exceed before the shift behavior will occur.
+
+### skidding
+
+attribute: `skidding`
+reflects: no
+type: `number`
+default: `0`
+
+The distance in pixels from which to offset the panel along its anchor.
+
+### sync
+
+attribute: `sync`
+reflects: no
+type: `'width' | 'height' | 'both'`
+default: none
+
+Syncs the popup's width or height to that of the anchor element.
+
+## Available Methods
+
+### reposition()
+
+parameters: -
+returns: `void`
+
+Forces the popup to recalculate and reposition itself.
+
+## Available CSS Parts
+
+- `arrow`: The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.
+- `hover-bridge`: The hover bridge element. Only available when the `hover-bridge` option is enabled.
+- `popup`: The popup's container. Useful for setting a background color, box shadow, etc.
+
+## Available Events
+
+### syn-reposition
+
+type: `SynRepositionEvent`
+
+Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it.

package/data/layers/interface/component/component:syn-prio-nav.json

@@ -0,0 +1,51 @@
+{
+  "attributes": [],
+  "cssParts": [
+    {
+      "description": "The component's base wrapper.",
+      "name": "base"
+    },
+    {
+      "description": "The wrapper around the priority menu",
+      "name": "priority-menu"
+    },
+    {
+      "description": "The container for the shifted navigation items, if there is not enough space.",
+      "name": "priority-menu-container"
+    },
+    {
+      "description": "The icon for the priority menu",
+      "name": "priority-menu-icon"
+    },
+    {
+      "description": "The label for the priority menu",
+      "name": "priority-menu-label"
+    },
+    {
+      "description": "The navigation item for the priority menu",
+      "name": "priority-menu-nav-item"
+    }
+  ],
+  "dependencies": [
+    "syn-dropdown",
+    "syn-icon",
+    "syn-menu",
+    "syn-nav-item"
+  ],
+  "documentation": "https://synergy-design-system.github.io/?path=/docs/components-syn-prio-nav--docs",
+  "events": [],
+  "figmaComponentId": "41227-206412",
+  "methods": [],
+  "properties": [],
+  "since": "1.14.0",
+  "slots": [
+    {
+      "description": "The given navigation items. Must be horizontal `<syn-nav-item>`s or have a role of \"menuitem\"",
+      "name": ""
+    }
+  ],
+  "sourceModulePath": "components/prio-nav/prio-nav.js",
+  "status": "stable",
+  "summary": "The `<syn-prio-nav />` element provides a generic navigation bar\nthat can be used to group multiple navigation items  (usually horizontal `<syn-nav-item />`s)\ntogether. It will automatically group all items not visible in the viewport into a custom\npriority menu.",
+  "tagName": "syn-prio-nav"
+}