@uplynk/lynk-design 1.11.2 → 1.11.3

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

@@ -33,33 +33,6 @@
         }
       ]
     },
-    {
-      "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-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.",
@@ -171,6 +144,33 @@
         }
       ]
     },
+    {
+      "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-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.",
@@ -905,68 +905,6 @@
         }
       ]
     },
-    {
-      "name": "lynk-copy-button",
-      "description": "Copies text data to the clipboard when the user clicks the trigger.\n---\n\n\n### **Events:**\n - **ev-copy** - Emitted when the data has been copied.\n- **ev-error** - Emitted when the data could not be copied.\n\n### **Slots:**\n - **copy-icon** - The icon to show in the default copy state. Works best with `<lynk-icon>`.\n- **success-icon** - The icon to show when the content is copied. Works best with `<lynk-icon>`.\n- **error-icon** - The icon to show when a copy error occurs. Works best with `<lynk-icon>`.\n\n### **CSS Properties:**\n - **--success-color** - The color to use for success feedback. _(default: undefined)_\n- **--error-color** - The color to use for error feedback. _(default: undefined)_\n\n### **CSS Parts:**\n - **button** - The internal `<button>` element.\n- **copy-icon** - The container that holds the copy icon.\n- **success-icon** - The container that holds the success icon.\n- **error-icon** - The container that holds the error icon.\n- **tooltip__base** - The tooltip's exported `base` part.\n- **tooltip__base__popup** - The tooltip's exported `popup` part.\n- **tooltip__base__arrow** - The tooltip's exported `arrow` part.\n- **tooltip__body** - The tooltip's exported `body` part.",
-      "attributes": [
-        {
-          "name": "value",
-          "description": "The text value to copy.",
-          "values": []
-        },
-        {
-          "name": "from",
-          "description": "An id that references an element in the same document from which data will be copied. If both this and `value` are\npresent, this value will take precedence. By default, the target element's `textContent` will be copied. To copy an\nattribute, append the attribute name wrapped in square brackets, e.g. `from=\"el[value]\"`. To copy a property,\nappend a dot and the property name, e.g. `from=\"el.value\"`.",
-          "values": []
-        },
-        {
-          "name": "disabled",
-          "description": "Disables the copy button.",
-          "values": []
-        },
-        {
-          "name": "copy-label",
-          "description": "A custom label to show in the tooltip.",
-          "values": []
-        },
-        {
-          "name": "success-label",
-          "description": "A custom label to show in the tooltip after copying.",
-          "values": []
-        },
-        {
-          "name": "error-label",
-          "description": "A custom label to show in the tooltip when a copy error occurs.",
-          "values": []
-        },
-        {
-          "name": "feedback-duration",
-          "description": "The length of time to show feedback before restoring the default trigger.",
-          "values": []
-        },
-        {
-          "name": "tooltip-placement",
-          "description": "The preferred placement of the tooltip.",
-          "values": [
-            { "name": "top" },
-            { "name": "right" },
-            { "name": "bottom" },
-            { "name": "left" }
-          ]
-        },
-        {
-          "name": "hoist",
-          "description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all,\nscenarios.",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://lynk.design/components/copy-button"
-        }
-      ]
-    },
     {
       "name": "lynk-combobox",
       "description": "Comboboxes allow you to choose items from a menu of predefined options.\n---\n\n\n### **Events:**\n - **ev-change** - Emitted when the control's value changes.\n- **ev-clear** - Emitted when the control's value is cleared.\n- **ev-input** - Emitted when the control receives input.\n- **ev-focus** - Emitted when the control gains focus.\n- **ev-blur** - Emitted when the control loses focus.\n- **ev-show** - Emitted when the combobox's menu opens.\n- **ev-after-show** - Emitted after the combobox's menu opens and all animations are complete.\n- **ev-hide** - Emitted when the combobox's menu closes.\n- **ev-after-hide** - Emitted after the combobox's menu closes and all animations are complete.\n- **ev-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n- **ev-error** - Emitted when the combobox menu fails to open.\n- **ev-add-option** - Emitted when a custom option is added via allowCustomValues.\n\n### **Methods:**\n - **show()** - Shows the listbox. If it is not possible to open the listbox, because there are no\nappropriate filtered options, a ev-error is emitted and the listbox stays closed.\n- **hide()** - Hides the listbox.\n- **checkValidity()** - Checks for validity but does not show a validation message.\nReturns `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- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The listbox options. Must be `<lynk-option>` elements. You can use `<lynk-optgroup>`'s to group items visually.\n- **label** - The combobox's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the combobox.\n- **suffix** - Used to append a presentational icon or similar element to the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n- **help-text** - Text that describes how to use the combobox. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, combobox, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The combobox's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container the wraps the prefix, combobox, clear icon, and expand button.\n- **prefix** - The container that wraps the prefix slot.\n- **suffix** - The container that wraps the suffix slot.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where the options are slotted and the filtered options list exists.\n- **filtered-listbox** - The container that wraps the filtered options.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
@@ -1091,6 +1029,68 @@
         }
       ]
     },
+    {
+      "name": "lynk-copy-button",
+      "description": "Copies text data to the clipboard when the user clicks the trigger.\n---\n\n\n### **Events:**\n - **ev-copy** - Emitted when the data has been copied.\n- **ev-error** - Emitted when the data could not be copied.\n\n### **Slots:**\n - **copy-icon** - The icon to show in the default copy state. Works best with `<lynk-icon>`.\n- **success-icon** - The icon to show when the content is copied. Works best with `<lynk-icon>`.\n- **error-icon** - The icon to show when a copy error occurs. Works best with `<lynk-icon>`.\n\n### **CSS Properties:**\n - **--success-color** - The color to use for success feedback. _(default: undefined)_\n- **--error-color** - The color to use for error feedback. _(default: undefined)_\n\n### **CSS Parts:**\n - **button** - The internal `<button>` element.\n- **copy-icon** - The container that holds the copy icon.\n- **success-icon** - The container that holds the success icon.\n- **error-icon** - The container that holds the error icon.\n- **tooltip__base** - The tooltip's exported `base` part.\n- **tooltip__base__popup** - The tooltip's exported `popup` part.\n- **tooltip__base__arrow** - The tooltip's exported `arrow` part.\n- **tooltip__body** - The tooltip's exported `body` part.",
+      "attributes": [
+        {
+          "name": "value",
+          "description": "The text value to copy.",
+          "values": []
+        },
+        {
+          "name": "from",
+          "description": "An id that references an element in the same document from which data will be copied. If both this and `value` are\npresent, this value will take precedence. By default, the target element's `textContent` will be copied. To copy an\nattribute, append the attribute name wrapped in square brackets, e.g. `from=\"el[value]\"`. To copy a property,\nappend a dot and the property name, e.g. `from=\"el.value\"`.",
+          "values": []
+        },
+        {
+          "name": "disabled",
+          "description": "Disables the copy button.",
+          "values": []
+        },
+        {
+          "name": "copy-label",
+          "description": "A custom label to show in the tooltip.",
+          "values": []
+        },
+        {
+          "name": "success-label",
+          "description": "A custom label to show in the tooltip after copying.",
+          "values": []
+        },
+        {
+          "name": "error-label",
+          "description": "A custom label to show in the tooltip when a copy error occurs.",
+          "values": []
+        },
+        {
+          "name": "feedback-duration",
+          "description": "The length of time to show feedback before restoring the default trigger.",
+          "values": []
+        },
+        {
+          "name": "tooltip-placement",
+          "description": "The preferred placement of the tooltip.",
+          "values": [
+            { "name": "top" },
+            { "name": "right" },
+            { "name": "bottom" },
+            { "name": "left" }
+          ]
+        },
+        {
+          "name": "hoist",
+          "description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all,\nscenarios.",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://lynk.design/components/copy-button"
+        }
+      ]
+    },
     {
       "name": "lynk-date-picker",
       "description": "A date picker that combines calendar component with accessible input field.\n---\n\n\n### **Events:**\n - **ev-change** - Emitted when the date value changes.\n- **ev-input** - Emitted when the control receives input.\n- **ev-clear** - Emitted when the input is cleared.\n\n### **Methods:**\n - **show()** - Shows the dropdown.\n- **hide()** - Hides the dropdown.\n- **focus(options: _FocusOptions_)** - Sets focus on the date input.\n- **blur()** - Removes focus from the input.\n- **checkValidity()** - Checks for validity but does not show a validation message.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message.\n\n### **Slots:**\n - **label** - The input's label. Alternatively, you can use the label prop.\n- **help-text** - Help text that describes how to use the input.\n- **help-tip** - Help tooltip next to the label that can be used in place of help-text to give additional information about how to use the input. Alternatively, you can use the help-tip prop.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **form-control** - The form control wrapper.\n- **form-control-label** - The label wrapper.\n- **form-control-input** - The input wrapper.\n- **form-control-help-text** - The help text wrapper.\n- **input-group** - The input group container.\n- **date-input** - The date input field.\n- **trigger** - The dropdown trigger button.\n- **dropdown** - The dropdown panel.\n- **calendar** - The calendar component.",
@@ -1532,37 +1532,6 @@
         }
       ]
     },
-    {
-      "name": "lynk-format-bytes",
-      "description": "Formats a number as a human readable bytes value.\n---\n",
-      "attributes": [
-        {
-          "name": "value",
-          "description": "The number to format in bytes.",
-          "values": []
-        },
-        {
-          "name": "unit",
-          "description": "The type of unit to display.",
-          "values": [{ "name": "byte" }, { "name": "bit" }]
-        },
-        {
-          "name": "display",
-          "description": "Determines how to display the result, e.g. \"100 bytes\", \"100 b\", or \"100b\".",
-          "values": [
-            { "name": "long" },
-            { "name": "short" },
-            { "name": "narrow" }
-          ]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://lynk.design/components/format-bytes"
-        }
-      ]
-    },
     {
       "name": "lynk-form-field",
       "description": "A standalone or wrapper component for all lynk form components. Handles basic label, help-tip, and help-text styles.\n---\n\n\n### **Events:**\n - **ev-focus** - Emitted when field or slotted element gains focus.\n- **ev-blur** - Emitted when field or slotted element loses focus.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The default slot.\n- **help-tip** - Custom help-tip content.\n- **help-text** - Custom help-text content.\n- **label** - Custom label content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The component's label wrapper.\n- **control** - The component's slotted control wrapper.\n- **help-text** - The component's help-text wrapper.",
@@ -1630,6 +1599,37 @@
         }
       ]
     },
+    {
+      "name": "lynk-format-bytes",
+      "description": "Formats a number as a human readable bytes value.\n---\n",
+      "attributes": [
+        {
+          "name": "value",
+          "description": "The number to format in bytes.",
+          "values": []
+        },
+        {
+          "name": "unit",
+          "description": "The type of unit to display.",
+          "values": [{ "name": "byte" }, { "name": "bit" }]
+        },
+        {
+          "name": "display",
+          "description": "Determines how to display the result, e.g. \"100 bytes\", \"100 b\", or \"100b\".",
+          "values": [
+            { "name": "long" },
+            { "name": "short" },
+            { "name": "narrow" }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://lynk.design/components/format-bytes"
+        }
+      ]
+    },
     {
       "name": "lynk-format-date",
       "description": "Formats a date/time using the specified locale and options.\n---\n",
@@ -4489,7 +4489,7 @@
     },
     {
       "name": "lynk-tree-item",
-      "description": "A tree item serves as a hierarchical node that lives inside a [tree](/components/tree).\n---\n\n\n### **Events:**\n - **ev-expand** - Emitted when the tree item expands.\n- **ev-after-expand** - Emitted after the tree item expands and all animations are complete.\n- **ev-collapse** - Emitted when the tree item collapses.\n- **ev-after-collapse** - Emitted after the tree item collapses and all animations are complete.\n- **ev-lazy-change** - Emitted when the tree item's lazy state changes.\n- **ev-lazy-load** - Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree.\n\n### **Methods:**\n - **getChildrenItems({ includeDisabled = true }: _{ includeDisabled?: boolean }_): _LynkTreeItem[]_** - Gets all the nested tree items in this node.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded.\n- **collapse-icon** - The icon to show when the tree item is collapsed.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **item** - The tree item's container. This element wraps everything except slotted tree item children.\n- **item--disabled** - Applied when the tree item is disabled.\n- **item--expanded** - Applied when the tree item is expanded.\n- **item--indeterminate** - Applied when the selection is indeterminate.\n- **item--selected** - Applied when the tree item is selected.\n- **indentation** - The tree item's indentation container.\n- **expand-button** - The container that wraps the tree item's expand button and spinner.\n- **spinner** - The spinner that shows when a lazy tree item is in the loading state.\n- **spinner__base** - The spinner's base part.\n- **label** - The tree item's label.\n- **children** - The container that wraps the tree item's nested children.\n- **checkbox** - The checkbox that shows when using multiselect.\n- **checkbox__base** - The checkbox's exported `base` part.\n- **checkbox__control** - The checkbox's exported `control` part.\n- **checkbox__control--checked** - The checkbox's exported `control--checked` part.\n- **checkbox__control--indeterminate** - The checkbox's exported `control--indeterminate` part.\n- **checkbox__checked-icon** - The checkbox's exported `checked-icon` part.\n- **checkbox__indeterminate-icon** - The checkbox's exported `indeterminate-icon` part.\n- **checkbox__label** - The checkbox's exported `label` part.",
+      "description": "A tree item serves as a hierarchical node that lives inside a [tree](/components/tree).\n---\n\n\n### **Events:**\n - **ev-expand** - Emitted when the tree item expands.\n- **ev-after-expand** - Emitted after the tree item expands and all animations are complete.\n- **ev-collapse** - Emitted when the tree item collapses.\n- **ev-after-collapse** - Emitted after the tree item collapses and all animations are complete.\n- **ev-lazy-change** - Emitted when the tree item's lazy state changes.\n- **ev-lazy-load** - Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree.\n\n### **Methods:**\n - **getChildrenItems({ includeDisabled = true }: _{ includeDisabled?: boolean }_): _LynkTreeItem[]_** - Gets all the nested tree items in this node.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded.\n- **collapse-icon** - The icon to show when the tree item is collapsed.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **item** - The tree item's container. This element wraps everything except slotted tree item children.\n- **item--disabled** - Applied when the tree item is disabled.\n- **item--readonly** - Applied when the tree item is readonly.\n- **item--expanded** - Applied when the tree item is expanded.\n- **item--indeterminate** - Applied when the selection is indeterminate.\n- **item--selected** - Applied when the tree item is selected.\n- **indentation** - The tree item's indentation container.\n- **expand-button** - The container that wraps the tree item's expand button and spinner.\n- **spinner** - The spinner that shows when a lazy tree item is in the loading state.\n- **spinner__base** - The spinner's base part.\n- **label** - The tree item's label.\n- **children** - The container that wraps the tree item's nested children.\n- **checkbox** - The checkbox that shows when using multiselect.\n- **checkbox__base** - The checkbox's exported `base` part.\n- **checkbox__control** - The checkbox's exported `control` part.\n- **checkbox__control--checked** - The checkbox's exported `control--checked` part.\n- **checkbox__control--indeterminate** - The checkbox's exported `control--indeterminate` part.\n- **checkbox__checked-icon** - The checkbox's exported `checked-icon` part.\n- **checkbox__indeterminate-icon** - The checkbox's exported `indeterminate-icon` part.\n- **checkbox__label** - The checkbox's exported `label` part.",
       "attributes": [
         {
           "name": "expanded",
@@ -4506,6 +4506,11 @@
           "description": "Disables the tree item.",
           "values": []
         },
+        {
+          "name": "readonly",
+          "description": "Makes the tree item readonly. The item cannot be selected but can still be expanded/collapsed.",
+          "values": []
+        },
         {
           "name": "lazy",
           "description": "Enables lazy loading behavior.",