@warp-ds/elements 2.9.1-next.3 → 2.9.1-next.4

package/dist/custom-elements.json

@@ -2074,7 +2074,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Breadcrumbs show the navigation structure for the current location.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/navigation-breadcrumbs--docs)",
+          "description": "Shows the navigation structure for the current page.\nRenders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/navigation-breadcrumbs--docs)",
           "name": "WarpBreadcrumbs",
           "members": [
             {
@@ -2087,7 +2087,11 @@
             },
             {
               "kind": "field",
-              "name": "ariaLabel"
+              "name": "ariaLabel",
+              "type": {
+                "text": "string | null"
+              },
+              "description": "Accessible label for the breadcrumb navigation.\nDefaults to the localized \"You are here\" label. Set `aria-label` when the default label is not specific enough for the page."
             }
           ],
           "superclass": {
@@ -6457,24 +6461,17 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Component to place inside a `<w-slider>`.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-slider-and-range-slider--docs)",
+          "description": "Component to place inside a `<w-slider>`.",
           "name": "WarpSliderThumb",
           "members": [
-            {
-              "kind": "field",
-              "name": "shadowRootOptions",
-              "type": {
-                "text": "object"
-              },
-              "static": true,
-              "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true, }"
-            },
             {
               "kind": "field",
               "name": "ariaLabel",
               "type": {
                 "text": "string"
               },
+              "description": "Label for the range input.",
+              "default": "`label` from `w-slider`",
               "attribute": "aria-label"
             },
             {
@@ -6483,6 +6480,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Contextual information for assistive technology, should it be needed",
               "attribute": "aria-description"
             },
             {
@@ -6491,6 +6489,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "The name of this input field in the form. The canonical source of the value is the text field.",
               "attribute": "name",
               "reflects": true
             },
@@ -6500,6 +6499,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "The initial value, if any",
               "attribute": "value",
               "reflects": true
             },
@@ -6509,6 +6509,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Placeholder in empty text fields",
               "attribute": "placeholder",
               "reflects": true
             },
@@ -6660,34 +6661,6 @@
                   }
                 }
               ]
-            },
-            {
-              "kind": "field",
-              "name": "boundaryValue",
-              "type": {
-                "text": "string"
-              },
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "textFieldDisplayValue",
-              "description": "Value to display in the textfield (shows boundary when focused on empty value)",
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "tooltipDisplayValue",
-              "type": {
-                "text": "string | number"
-              },
-              "description": "Value to display in the tooltip",
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "ariaDescriptionText",
-              "readonly": true
             }
           ],
           "events": [
@@ -6695,13 +6668,15 @@
               "name": "thumbreset",
               "type": {
                 "text": "CustomEvent"
-              }
+              },
+              "description": "Internal event used by (and stopped by) `w-slider`."
             },
             {
               "name": "slidervalidity",
               "type": {
                 "text": "CustomEvent"
-              }
+              },
+              "description": "Internal event used by (and stopped by) `w-slider`."
             }
           ],
           "attributes": [
@@ -6710,6 +6685,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "Label for the range input.",
+              "default": "`label` from `w-slider`",
               "fieldName": "ariaLabel"
             },
             {
@@ -6717,6 +6694,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Contextual information for assistive technology, should it be needed",
               "fieldName": "ariaDescription"
             },
             {
@@ -6724,6 +6702,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "The name of this input field in the form. The canonical source of the value is the text field.",
               "fieldName": "name"
             },
             {
@@ -6731,6 +6710,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "The initial value, if any",
               "fieldName": "value"
             },
             {
@@ -6738,6 +6718,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Placeholder in empty text fields",
               "fieldName": "placeholder"
             }
           ],
@@ -6751,6 +6732,10 @@
             "name": "LitElement",
             "package": "lit"
           },
+          "parent": {
+            "name": "w-slider",
+            "description": ""
+          },
           "tagName": "w-slider-thumb",
           "customElement": true,
           "modulePath": "packages/slider-thumb/slider-thumb.ts",
@@ -6782,7 +6767,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-slider-and-range-slider--docs)",
+          "description": "Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.",
           "name": "WarpSlider",
           "slots": [
             {
@@ -6807,15 +6792,6 @@
             }
           ],
           "members": [
-            {
-              "kind": "field",
-              "name": "shadowRootOptions",
-              "type": {
-                "text": "object"
-              },
-              "static": true,
-              "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true, }"
-            },
             {
               "kind": "field",
               "name": "label",
@@ -6852,6 +6828,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Validation error text, if any",
               "attribute": "error",
               "reflects": true
             },
@@ -6861,6 +6838,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Additional description to show below the fieldset",
               "attribute": "help-text",
               "reflects": true
             },
@@ -6871,6 +6849,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Sets the form fields and fieldset in an invalid state",
               "attribute": "invalid",
               "reflects": true
             },
@@ -6881,7 +6860,7 @@
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Ensures a child slider thumb has a value before allowing the containing form to submit.",
+              "description": "Ensures a child slider thumb has a value before allowing the containing form to submit",
               "attribute": "required",
               "reflects": true
             },
@@ -6891,6 +6870,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "The minimum allowed value in the range inputs",
+              "default": "0",
               "attribute": "min",
               "reflects": true
             },
@@ -6900,6 +6881,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "The maximum allowed value in the range inputs",
+              "default": "100",
               "attribute": "max",
               "reflects": true
             },
@@ -6919,6 +6902,7 @@
               "type": {
                 "text": "number"
               },
+              "description": "ets step on the range input to jump between values when dragging",
               "attribute": "step",
               "reflects": true
             },
@@ -6928,7 +6912,7 @@
               "type": {
                 "text": "string"
               },
-              "description": "Suffix used in text input fields and for the min and max values of the slider.",
+              "description": "Suffix used in text input fields and for the min and max values of the slider",
               "attribute": "suffix",
               "reflects": true
             },
@@ -6939,6 +6923,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Should only be used in special cases",
               "attribute": "hidden-textfield",
               "reflects": true
             },
@@ -6948,7 +6933,7 @@
               "type": {
                 "text": "(value: string, slot: SliderSlot) => string"
               },
-              "description": "Formatter for the tooltip and input mask values."
+              "description": "Formatter for the tooltip and input mask values"
             },
             {
               "kind": "field",
@@ -6956,7 +6941,7 @@
               "type": {
                 "text": "(value: string, slot: SliderSlot) => string"
               },
-              "description": "Replaces valueFormatter for the tooltip. Use in open-ended sliders to show for example \"300+ hk\" instead of \"Max\" in the tooltip."
+              "description": "Overrides valueFormatter for the tooltip.\n\nUse in open-ended sliders to show for example \"300+ hk\" instead of \"Max\" in the tooltip."
             },
             {
               "kind": "field",
@@ -6966,45 +6951,6 @@
               },
               "description": "Formatter for the min and max labels below the range."
             },
-            {
-              "kind": "field",
-              "name": "fieldset",
-              "type": {
-                "text": "HTMLFieldSetElement"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "_invalidMessage",
-              "type": {
-                "text": "string"
-              },
-              "default": "''"
-            },
-            {
-              "kind": "field",
-              "name": "_hasInternalError",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false"
-            },
-            {
-              "kind": "field",
-              "name": "_showError",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false"
-            },
-            {
-              "kind": "field",
-              "name": "_tabbableElements",
-              "type": {
-                "text": "Array<HTMLElement>"
-              },
-              "default": "[]"
-            },
             {
               "kind": "method",
               "name": "#syncSliderThumbs",
@@ -7015,16 +6961,6 @@
                 }
               }
             },
-            {
-              "kind": "field",
-              "name": "edgeMin",
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "edgeMax",
-              "readonly": true
-            },
             {
               "kind": "method",
               "name": "#onThumbReset",
@@ -7124,22 +7060,6 @@
                 }
               ],
               "description": "We use CSS variables to fill the active track with a background color."
-            },
-            {
-              "kind": "field",
-              "name": "componentHasError",
-              "type": {
-                "text": "boolean"
-              },
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "errorText",
-              "type": {
-                "text": "string"
-              },
-              "readonly": true
             }
           ],
           "attributes": [
@@ -7173,6 +7093,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Validation error text, if any",
               "fieldName": "error"
             },
             {
@@ -7180,6 +7101,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Additional description to show below the fieldset",
               "fieldName": "helpText"
             },
             {
@@ -7188,6 +7110,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Sets the form fields and fieldset in an invalid state",
               "fieldName": "invalid"
             },
             {
@@ -7196,7 +7119,7 @@
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Ensures a child slider thumb has a value before allowing the containing form to submit.",
+              "description": "Ensures a child slider thumb has a value before allowing the containing form to submit",
               "fieldName": "required"
             },
             {
@@ -7204,6 +7127,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "The minimum allowed value in the range inputs",
+              "default": "0",
               "fieldName": "min"
             },
             {
@@ -7211,6 +7136,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "The maximum allowed value in the range inputs",
+              "default": "100",
               "fieldName": "max"
             },
             {
@@ -7226,6 +7153,7 @@
               "type": {
                 "text": "number"
               },
+              "description": "ets step on the range input to jump between values when dragging",
               "fieldName": "step"
             },
             {
@@ -7233,7 +7161,7 @@
               "type": {
                 "text": "string"
               },
-              "description": "Suffix used in text input fields and for the min and max values of the slider.",
+              "description": "Suffix used in text input fields and for the min and max values of the slider",
               "fieldName": "suffix"
             },
             {
@@ -7242,6 +7170,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Should only be used in special cases",
               "fieldName": "hiddenTextfield"
             }
           ],
@@ -7633,18 +7562,9 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Individual tab component used within w-tabs container.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/tabs--docs)",
+          "description": "Individual tab component used within w-tabs container.",
           "name": "WarpTab",
           "members": [
-            {
-              "kind": "field",
-              "name": "shadowRootOptions",
-              "type": {
-                "text": "object"
-              },
-              "static": true,
-              "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true, }"
-            },
             {
               "kind": "field",
               "name": "_internals",
@@ -7658,50 +7578,16 @@
               "name": "_handleClick",
               "privacy": "private"
             },
-            {
-              "kind": "field",
-              "name": "id",
-              "type": {
-                "text": "string"
-              },
-              "attribute": "id",
-              "reflects": true
-            },
             {
               "kind": "field",
               "name": "for",
               "type": {
                 "text": "string"
               },
+              "description": "The `id` of the `<w-tab-panel>` this tab controls.",
               "attribute": "for",
               "reflects": true
             },
-            {
-              "kind": "field",
-              "name": "_ariaControlsAttr",
-              "type": {
-                "text": "string | undefined"
-              },
-              "privacy": "private",
-              "attribute": "aria-controls"
-            },
-            {
-              "kind": "field",
-              "name": "tabIndex",
-              "type": {
-                "text": "number"
-              },
-              "description": "Override tabIndex setter to set _parentTabIndex (for backwards compatibility)."
-            },
-            {
-              "kind": "field",
-              "name": "_computedAriaSelected",
-              "type": {
-                "text": "'true' | 'false' | undefined"
-              },
-              "description": "Computed aria-selected: prefers parent-managed, falls back to own property",
-              "readonly": true
-            },
             {
               "kind": "field",
               "name": "_effectiveAriaControls",
@@ -7711,14 +7597,6 @@
               "privacy": "private",
               "readonly": true
             },
-            {
-              "kind": "field",
-              "name": "ariaSelected",
-              "type": {
-                "text": "'true' | 'false'"
-              },
-              "attribute": "aria-selected"
-            },
             {
               "kind": "field",
               "name": "_ownAriaSelected",
@@ -7727,17 +7605,6 @@
               },
               "privacy": "private"
             },
-            {
-              "kind": "field",
-              "name": "active",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "deprecated": "Use `aria-selected=\"true\"` instead",
-              "attribute": "active",
-              "reflects": true
-            },
             {
               "kind": "field",
               "name": "over",
@@ -7745,6 +7612,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether to show the `icon` slot over the tab title instead of inline.",
               "attribute": "over",
               "reflects": true
             },
@@ -7767,49 +7635,21 @@
             }
           ],
           "attributes": [
-            {
-              "name": "id",
-              "type": {
-                "text": "string"
-              },
-              "fieldName": "id"
-            },
             {
               "name": "for",
               "type": {
                 "text": "string"
               },
+              "description": "The `id` of the `<w-tab-panel>` this tab controls.",
               "fieldName": "for"
             },
-            {
-              "name": "aria-controls",
-              "type": {
-                "text": "string | undefined"
-              },
-              "fieldName": "_ariaControlsAttr"
-            },
-            {
-              "name": "aria-selected",
-              "type": {
-                "text": "'true' | 'false'"
-              },
-              "fieldName": "ariaSelected"
-            },
-            {
-              "name": "active",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "deprecated": "Use `aria-selected=\"true\"` instead",
-              "fieldName": "active"
-            },
             {
               "name": "over",
               "type": {
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether to show the `icon` slot over the tab title instead of inline.",
               "fieldName": "over"
             }
           ],
@@ -7817,6 +7657,10 @@
             "name": "LitElement",
             "package": "lit"
           },
+          "parent": {
+            "name": "w-tabs",
+            "description": ""
+          },
           "tagName": "w-tab",
           "customElement": true,
           "modulePath": "packages/tab/tab.ts",
@@ -7848,7 +7692,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Tab panel component that holds content for individual tabs.\nEach tab panel should have a name that matches a corresponding tab.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/tabs--docs)",
+          "description": "Tab panel component that holds content for individual tabs.\nEach tab panel should have a name that matches a corresponding tab.",
           "name": "WarpTabPanel",
           "members": [
             {
@@ -7861,12 +7705,13 @@
             },
             {
               "kind": "field",
-              "name": "active",
-              "description": "Whether this panel is active (visible).\nSet by parent w-tabs via the _parentActive property.",
+              "name": "id",
               "type": {
-                "text": "boolean"
+                "text": "string"
               },
-              "attribute": "active"
+              "description": "Required so `<w-tab>` has something to target.",
+              "attribute": "id",
+              "reflects": true
             },
             {
               "kind": "field",
@@ -7884,18 +7729,22 @@
           ],
           "attributes": [
             {
-              "name": "active",
-              "description": "Whether this panel is active (visible).\nSet by parent w-tabs via the _parentActive property.",
+              "name": "id",
               "type": {
-                "text": "boolean"
+                "text": "string"
               },
-              "fieldName": "active"
+              "description": "Required so `<w-tab>` has something to target.",
+              "fieldName": "id"
             }
           ],
           "superclass": {
             "name": "LitElement",
             "package": "lit"
           },
+          "parent": {
+            "name": "w-tabs",
+            "description": ""
+          },
           "tagName": "w-tab-panel",
           "customElement": true,
           "modulePath": "packages/tab-panel/tab-panel.ts",
@@ -7927,7 +7776,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Tabs are used to organize content by grouping similar information on the same page.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/tabs--docs)",
+          "description": "Tabs are used to organize content by grouping similar information on the same page.",
           "name": "WarpTabs",
           "members": [
             {
@@ -7936,6 +7785,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "The `id` of the panel that should be active.",
+              "default": "\"\" (Shows the first tab)",
               "attribute": "active",
               "reflects": true
             },
@@ -7987,16 +7838,6 @@
               "name": "_assignSlots",
               "privacy": "private"
             },
-            {
-              "kind": "field",
-              "name": "tabs",
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "activeTab",
-              "readonly": true
-            },
             {
               "kind": "method",
               "name": "_initializeActiveTab",
@@ -8044,8 +7885,9 @@
             {
               "name": "change",
               "type": {
-                "text": "CustomEvent"
-              }
+                "text": "WarpTabsChangeEvent"
+              },
+              "description": "Includes `details.panelId` with the now active tab's ID"
             }
           ],
           "attributes": [
@@ -8054,6 +7896,8 @@
               "type": {
                 "text": "string"
               },
+              "description": "The `id` of the panel that should be active.",
+              "default": "\"\" (Shows the first tab)",
               "fieldName": "active"
             }
           ],