@uplynk/lynk-design 1.14.0 → 1.15.0

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

@@ -33,77 +33,6 @@
         }
       ]
     },
-    {
-      "name": "lynk-alert",
-      "description": "Alerts are used to display important messages inline or as toast notifications.\n---\n\n\n### **Events:**\n - **ev-show** - Emitted when the alert opens.\n- **ev-after-show** - Emitted after the alert opens and all animations are complete.\n- **ev-hide** - Emitted when the alert closes.\n- **ev-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 content.\n- **icon** - An icon to show in the alert.\n- **action** - Append custom actions to alert.\n\n### **CSS Properties:**\n - **--box-shadow** - The alert's box shadow. _(default: undefined)_\n- **--padding** - The top and bottom padding of the message. Use any spacing token (--lynk-spacing-large) or a custom value. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal block wrapper.\n- **icon** - The container that wraps the alert icon.\n- **message** - The alert message.\n- **close-button** - The close button.\n- **close-button__base** - The close button's `base` part.",
-      "attributes": [
-        {
-          "name": "open",
-          "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.",
-          "values": []
-        },
-        {
-          "name": "closable",
-          "description": "Makes the alert closable.",
-          "values": []
-        },
-        {
-          "name": "type",
-          "description": "The alert's type (color).",
-          "values": [
-            { "name": "primary" },
-            { "name": "info" },
-            { "name": "success" },
-            { "name": "neutral" },
-            { "name": "warning" },
-            { "name": "danger" }
-          ]
-        },
-        {
-          "name": "duration",
-          "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`.",
-          "values": []
-        },
-        {
-          "name": "countdown",
-          "description": "Enables a countdown that indicates the remaining time the alert will be displayed.\nTypically used to indicate the remaining time before a whole app refresh.",
-          "values": [{ "name": "rtl" }, { "name": "ltr" }]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://lynk.design/components/alert"
-        }
-      ]
-    },
-    {
-      "name": "lynk-auto-grid",
-      "description": "A simple automatic two-dimensional grid-based layout system based off CSS Grid spec.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n\n### **CSS Properties:**\n - **--gap** - Customize the gap of the auto-grid group. _(default: var(--lynk-spacing-base))_\n- **--min-size** - Customize the allowed min-size of the auto-grid items. _(default: 20rem)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.",
-      "attributes": [
-        {
-          "name": "auto-size",
-          "description": "How to justify auto-grid items",
-          "values": [{ "name": "fit" }, { "name": "fill" }]
-        },
-        {
-          "name": "min-size",
-          "description": "How to align auto-grid items to each-other",
-          "values": []
-        },
-        {
-          "name": "gap",
-          "description": "The space between auto-grid items. Use spacing tokens or any custom size.",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://lynk.design/components/auto-grid"
-        }
-      ]
-    },
     {
       "name": "lynk-animation",
       "description": "Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).\n---\n\n\n### **Events:**\n - **ev-cancel** - Emitted when the animation is canceled.\n- **ev-finish** - Emitted when the animation finishes.\n- **ev-start** - Emitted when the animation starts or restarts.\n\n### **Methods:**\n - **cancel()** - Clears all KeyframeEffects caused by this animation and aborts its playback.\n- **finish()** - Sets the playback time to the end of the animation corresponding to the current playback direction.\n\n### **Slots:**\n - _default_ - The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<lynk-animation>` elements.",
@@ -172,43 +101,73 @@
       ]
     },
     {
-      "name": "lynk-avatar",
-      "description": "Avatars are used to represent a person or object.\n---\n\n\n### **Events:**\n - **ev-error** - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.\n\n### **Slots:**\n - **icon** - The default icon to use when no image or initials are present. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--size** - The size of the avatar. _(default: undefined)_\n\n### **CSS Parts:**\n - **icon** - The container that wraps the avatar's icon.\n- **initials** - The container that wraps the avatar's initials.\n- **image** - The avatar image. Only shown when the `image` attribute is set.",
+      "name": "lynk-alert",
+      "description": "Alerts are used to display important messages inline or as toast notifications.\n---\n\n\n### **Events:**\n - **ev-show** - Emitted when the alert opens.\n- **ev-after-show** - Emitted after the alert opens and all animations are complete.\n- **ev-hide** - Emitted when the alert closes.\n- **ev-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 content.\n- **icon** - An icon to show in the alert.\n- **action** - Append custom actions to alert.\n\n### **CSS Properties:**\n - **--box-shadow** - The alert's box shadow. _(default: undefined)_\n- **--padding** - The top and bottom padding of the message. Use any spacing token (--lynk-spacing-large) or a custom value. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal block wrapper.\n- **icon** - The container that wraps the alert icon.\n- **message** - The alert message.\n- **close-button** - The close button.\n- **close-button__base** - The close button's `base` part.",
       "attributes": [
         {
-          "name": "image",
-          "description": "The image source to use for the avatar.",
+          "name": "open",
+          "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.",
           "values": []
         },
         {
-          "name": "label",
-          "description": "A label to use to describe the avatar to assistive devices.",
+          "name": "closable",
+          "description": "Makes the alert closable.",
           "values": []
         },
         {
-          "name": "initials",
-          "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
+          "name": "type",
+          "description": "The alert's type (color).",
+          "values": [
+            { "name": "primary" },
+            { "name": "info" },
+            { "name": "success" },
+            { "name": "neutral" },
+            { "name": "warning" },
+            { "name": "danger" }
+          ]
+        },
+        {
+          "name": "duration",
+          "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`.",
           "values": []
         },
         {
-          "name": "loading",
-          "description": "Indicates how the browser should load the image.",
-          "values": [{ "name": "eager" }, { "name": "lazy" }]
+          "name": "countdown",
+          "description": "Enables a countdown that indicates the remaining time the alert will be displayed.\nTypically used to indicate the remaining time before a whole app refresh.",
+          "values": [{ "name": "rtl" }, { "name": "ltr" }]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://lynk.design/components/alert"
+        }
+      ]
+    },
+    {
+      "name": "lynk-auto-grid",
+      "description": "A simple automatic two-dimensional grid-based layout system based off CSS Grid spec.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n\n### **CSS Properties:**\n - **--gap** - Customize the gap of the auto-grid group. _(default: var(--lynk-spacing-base))_\n- **--min-size** - Customize the allowed min-size of the auto-grid items. _(default: 20rem)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.",
+      "attributes": [
+        {
+          "name": "auto-size",
+          "description": "How to justify auto-grid items",
+          "values": [{ "name": "fit" }, { "name": "fill" }]
         },
         {
-          "name": "shape",
-          "description": "The shape of the avatar.",
-          "values": [
-            { "name": "circle" },
-            { "name": "square" },
-            { "name": "rounded" }
-          ]
+          "name": "min-size",
+          "description": "How to align auto-grid items to each-other",
+          "values": []
+        },
+        {
+          "name": "gap",
+          "description": "The space between auto-grid items. Use spacing tokens or any custom size.",
+          "values": []
         }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://lynk.design/components/avatar"
+          "url": "https://lynk.design/components/auto-grid"
         }
       ]
     },
@@ -255,6 +214,47 @@
         { "name": "Documentation", "url": "https://lynk.design/components/box" }
       ]
     },
+    {
+      "name": "lynk-avatar",
+      "description": "Avatars are used to represent a person or object.\n---\n\n\n### **Events:**\n - **ev-error** - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.\n\n### **Slots:**\n - **icon** - The default icon to use when no image or initials are present. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--size** - The size of the avatar. _(default: undefined)_\n\n### **CSS Parts:**\n - **icon** - The container that wraps the avatar's icon.\n- **initials** - The container that wraps the avatar's initials.\n- **image** - The avatar image. Only shown when the `image` attribute is set.",
+      "attributes": [
+        {
+          "name": "image",
+          "description": "The image source to use for the avatar.",
+          "values": []
+        },
+        {
+          "name": "label",
+          "description": "A label to use to describe the avatar to assistive devices.",
+          "values": []
+        },
+        {
+          "name": "initials",
+          "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
+          "values": []
+        },
+        {
+          "name": "loading",
+          "description": "Indicates how the browser should load the image.",
+          "values": [{ "name": "eager" }, { "name": "lazy" }]
+        },
+        {
+          "name": "shape",
+          "description": "The shape of the avatar.",
+          "values": [
+            { "name": "circle" },
+            { "name": "square" },
+            { "name": "rounded" }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://lynk.design/components/avatar"
+        }
+      ]
+    },
     {
       "name": "lynk-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 `<lynk-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
@@ -2639,7 +2639,7 @@
     },
     {
       "name": "lynk-panel",
-      "description": "Panels are lightweight content containers that function like a native `detail` HTML element with a collapsable body. They can either stand alone or be grouped together to form an [Accordion](/components/accordion).\n---\n\n\n### **Events:**\n - **ev-expand** - Emitted when the panel expands.\n- **ev-after-expand** - Emitted after the panel expands and all animations are complete.\n- **ev-collapse** - Emitted when the panel closes.\n- **ev-after-collapse** - Emitted after the panel closes and all animations are complete.\n\n### **Methods:**\n - **expand()** - Shows the panel.\n- **collapse()** - Hides the panel\n\n### **Slots:**\n - _default_ - The panels' main content.\n- **heading** - The panels' heading. Alternatively, you can use the `heading` attribute.\n- **prefix** - The panels' summary prefix `<slot>`.\n- **suffix** - The panels' summary suffix `<slot>`.\n- **expand-icon** - The expand icon's `<slot>`.\n- **collapse-icon** - The collapse icon's `<slot>`.\n- **footer** - The panels' footer `<slot>`.\n\n### **CSS Properties:**\n - **--background-color** - The panels background color _(default: undefined)_\n- **--spacing** - The amount of padding to use for the header, body, and footer. _(default: undefined)_\n- **--border-color** - Apply a panel border of your choosing. _(default: undefined)_\n- **--border-radius** - The panels border radius. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.\n- **header** - The panel header area.\n- **heading** - The panel heading.\n- **prefix** - The panel header prefix area.\n- **suffix** - The panel header suffix area.\n- **toggle-icon** - The expand/collapse toggle icon in the header.\n- **content** - The panel content.\n- **footer** - The panel footer.",
+      "description": "Panels are lightweight content containers that function like a native `detail` HTML element with a collapsable body. They can either stand alone or be grouped together to form an [Accordion](/components/accordion).\n---\n\n\n### **Events:**\n - **ev-expand** - Emitted when the panel expands.\n- **ev-after-expand** - Emitted after the panel expands and all animations are complete.\n- **ev-collapse** - Emitted when the panel closes.\n- **ev-after-collapse** - Emitted after the panel closes and all animations are complete.\n\n### **Methods:**\n - **expand()** - Shows the panel.\n- **collapse()** - Hides the panel\n\n### **Slots:**\n - _default_ - The panels' main content.\n- **heading** - The panels' heading. Alternatively, you can use the `heading` attribute.\n- **prefix** - The panels' summary prefix `<slot>`.\n- **suffix** - The panels' summary suffix `<slot>`.\n- **expand-icon** - The expand icon's `<slot>`.\n- **collapse-icon** - The collapse icon's `<slot>`.\n- **subheader** - Optional content displayed below the header, only visible when the panel is expanded.\n- **footer** - The panels' footer `<slot>`.\n\n### **CSS Properties:**\n - **--background-color** - The panels background color _(default: undefined)_\n- **--spacing** - The amount of padding to use for the header, body, and footer. _(default: undefined)_\n- **--border-color** - Apply a panel border of your choosing. _(default: undefined)_\n- **--border-radius** - The panels border radius. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.\n- **header** - The panel header area.\n- **heading** - The panel heading.\n- **prefix** - The panel header prefix area.\n- **suffix** - The panel header suffix area.\n- **toggle-icon** - The expand/collapse toggle icon in the header.\n- **subheader** - The panel subheader area, visible only when expanded.\n- **content** - The panel content.\n- **footer** - The panel footer.",
       "attributes": [
         {
           "name": "expanded",
@@ -3160,7 +3160,7 @@
     },
     {
       "name": "lynk-range",
-      "description": "Ranges allow the user to select a single value within a given range using a slider.\n---\n\n\n### **Events:**\n - **ev-blur** - Emitted when the control loses focus.\n- **ev-change** - Emitted when an alteration to the control's value is committed by the user.\n- **ev-focus** - Emitted when the control gains focus.\n- **ev-input** - Emitted when the control receives input.\n- **ev-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the range.\n- **blur()** - Removes focus from the range.\n- **stepUp()** - Increments the value of the range by the value of the step attribute.\n- **stepDown()** - Decrements the value of the range by the value of the step attribute.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - **label** - The range's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n- **help-tip** - Help tooltip next to the label. Alternatively, you can use the `help-tip` attribute.\n- **ticks** - Custom tick markers. Use this to override the default tick rendering.\n- **reference** - Reference labels displayed below the range (e.g., min/max labels).\n\n### **CSS Properties:**\n - **--thumb-size** - The size of the thumb. _(default: undefined)_\n- **--thumb-color** - The color of the thumb. _(default: undefined)_\n- **--thumb-border** - The box-shadow used for the thumb border. _(default: undefined)_\n- **--track-color-active** - The color of the active portion of the track. _(default: undefined)_\n- **--track-color-inactive** - The color of the inactive portion of the track. _(default: undefined)_\n- **--track-height** - The height of the track. _(default: undefined)_\n- **--track-active-offset** - The starting point of the active track (useful for ranges that don't start at 0). _(default: undefined)_\n- **--tick-color** - The color of tick markers. _(default: undefined)_\n- **--tick-label-color** - The color of tick labels. _(default: undefined)_\n- **--tick-width** - The width of tick markers. _(default: undefined)_\n- **--tick-height** - The height of tick markers. _(default: undefined)_\n- **--tick-selected-color** - The color of selected tick markers. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **wrapper** - The range track wrapper.\n- **track** - The range track (inactive portion).\n- **track-active** - The active portion of the track.\n- **thumb** - The draggable thumb.\n- **ticks** - The container for custom tick markers.\n- **markers** - The container that holds all the markers when `with-markers` is used.\n- **marker** - The individual markers that are shown when `with-markers` is used.\n- **references** - The container for reference labels.",
+      "description": "Ranges allow the user to select a single value within a given range using a slider.\n---\n\n\n### **Events:**\n - **ev-blur** - Emitted when the control loses focus.\n- **ev-change** - Emitted when an alteration to the control's value is committed by the user.\n- **ev-focus** - Emitted when the control gains focus.\n- **ev-input** - Emitted when the control receives input.\n- **ev-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the range.\n- **blur()** - Removes focus from the range.\n- **stepUp()** - Increments the value of the range by the value of the step attribute.\n- **stepDown()** - Decrements the value of the range by the value of the step attribute.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - **label** - The range's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend an icon or similar element to the range.\n- **suffix** - Used to append an icon or similar element to the range.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n- **help-tip** - Help tooltip next to the label. Alternatively, you can use the `help-tip` attribute.\n- **ticks** - Custom tick markers. Use this to override the default tick rendering.\n- **reference** - Reference labels displayed below the range (e.g., min/max labels).\n\n### **CSS Properties:**\n - **--thumb-size** - The size of the thumb. _(default: undefined)_\n- **--thumb-color** - The color of the thumb. _(default: undefined)_\n- **--thumb-border** - The box-shadow used for the thumb border. _(default: undefined)_\n- **--track-color-active** - The color of the active portion of the track. _(default: undefined)_\n- **--track-color-inactive** - The color of the inactive portion of the track. _(default: undefined)_\n- **--track-height** - The height of the track. _(default: undefined)_\n- **--track-active-offset** - The starting point of the active track (useful for ranges that don't start at 0). _(default: undefined)_\n- **--tick-color** - The color of tick markers. _(default: undefined)_\n- **--tick-label-color** - The color of tick labels. _(default: undefined)_\n- **--tick-width** - The width of tick markers. _(default: undefined)_\n- **--tick-height** - The height of tick markers. _(default: undefined)_\n- **--tick-selected-color** - The color of selected tick markers. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **prefix** - The container that wraps the prefix slot.\n- **suffix** - The container that wraps the suffix slot.\n- **wrapper** - The range track wrapper.\n- **track** - The range track (inactive portion).\n- **track-active** - The active portion of the track.\n- **thumb** - The draggable thumb.\n- **ticks** - The container for custom tick markers.\n- **markers** - The container that holds all the markers when `with-markers` is used.\n- **marker** - The individual markers that are shown when `with-markers` is used.\n- **references** - The container for reference labels.",
       "attributes": [
         {
           "name": "name",