@ukic/docs 3.2.2 → 3.2.3

package/docs.json

@@ -3901,7 +3901,12 @@
       "tag": "ic-checkbox-group",
       "readme": "# ic-checkbox-group\r\n\r\n\r\n\r",
       "docs": "",
-      "docsTags": [],
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "helper-text - Content is set as the helper text for the checkbox group."
+        }
+      ],
       "usage": {},
       "props": [
         {
@@ -4227,7 +4232,12 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "helper-text",
+          "docs": "Content is set as the helper text for the checkbox group."
+        }
+      ],
       "parts": [],
       "dependents": [],
       "dependencies": [
@@ -8553,10 +8563,10 @@
       "props": [
         {
           "name": "description",
-          "type": "string | undefined",
+          "type": "string",
           "complexType": {
             "original": "string",
-            "resolved": "string | undefined",
+            "resolved": "string",
             "references": {}
           },
           "mutable": false,
@@ -8568,22 +8578,19 @@
           "values": [
             {
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "fullWidth",
-          "type": "boolean | undefined",
+          "type": "boolean",
           "complexType": {
             "original": "boolean",
-            "resolved": "boolean | undefined",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
@@ -8595,12 +8602,9 @@
           "values": [
             {
               "type": "boolean"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -8616,7 +8620,7 @@
           "mutable": false,
           "attr": "label",
           "reflectToAttr": false,
-          "docs": "The label to be displayed beneath the loading indicator.\nDisplay a changing label by supplying an array of messages.",
+          "docs": "The label to be displayed beneath the loading indicator.\r\nDisplay a changing label by supplying an array of messages.",
           "docsTags": [],
           "values": [
             {
@@ -8636,10 +8640,10 @@
         },
         {
           "name": "labelDuration",
-          "type": "number | undefined",
+          "type": "number",
           "complexType": {
             "original": "number",
-            "resolved": "number | undefined",
+            "resolved": "number",
             "references": {}
           },
           "mutable": false,
@@ -8651,76 +8655,67 @@
           "values": [
             {
               "type": "number"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "max",
-          "type": "number | undefined",
+          "type": "number",
           "complexType": {
             "original": "number",
-            "resolved": "number | undefined",
+            "resolved": "number",
             "references": {}
           },
           "mutable": false,
           "attr": "max",
           "reflectToAttr": false,
-          "docs": "The maximum value that the progress value can take.\nUsed to calculate the proportional width of the progress bar.",
+          "docs": "The maximum value that the progress value can take.\r\nUsed to calculate the proportional width of the progress bar.",
           "docsTags": [],
           "default": "100",
           "values": [
             {
               "type": "number"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "min",
-          "type": "number | undefined",
+          "type": "number",
           "complexType": {
             "original": "number",
-            "resolved": "number | undefined",
+            "resolved": "number",
             "references": {}
           },
           "mutable": false,
           "attr": "min",
           "reflectToAttr": false,
-          "docs": "The minimum value that the progress value can take.\nUsed to calculate the proportional width of the progress bar.",
+          "docs": "The minimum value that the progress value can take.\r\nUsed to calculate the proportional width of the progress bar.",
           "docsTags": [],
           "default": "0",
           "values": [
             {
               "type": "number"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "monochrome",
-          "type": "boolean | undefined",
+          "type": "boolean",
           "complexType": {
             "original": "boolean",
-            "resolved": "boolean | undefined",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
@@ -8732,12 +8727,9 @@
           "values": [
             {
               "type": "boolean"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -8753,7 +8745,7 @@
           "mutable": false,
           "attr": "progress",
           "reflectToAttr": false,
-          "docs": "The current amount of progress made.\nIf not provided, component acts as an indeterminate loading indicator.",
+          "docs": "The current amount of progress made.\r\nIf not provided, component acts as an indeterminate loading indicator.",
           "docsTags": [],
           "values": [
             {
@@ -8770,10 +8762,10 @@
         },
         {
           "name": "size",
-          "type": "\"icon\" | \"large\" | \"medium\" | \"small\" | undefined",
+          "type": "\"icon\" | \"large\" | \"medium\" | \"small\"",
           "complexType": {
             "original": "IcLoadingSizes",
-            "resolved": "\"icon\" | \"large\" | \"medium\" | \"small\" | undefined",
+            "resolved": "\"icon\" | \"large\" | \"medium\" | \"small\"",
             "references": {
               "IcLoadingSizes": {
                 "location": "import",
@@ -8804,22 +8796,19 @@
             {
               "value": "small",
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "theme",
-          "type": "\"dark\" | \"inherit\" | \"light\" | undefined",
+          "type": "\"dark\" | \"inherit\" | \"light\"",
           "complexType": {
             "original": "IcThemeMode",
-            "resolved": "\"dark\" | \"inherit\" | \"light\" | undefined",
+            "resolved": "\"dark\" | \"inherit\" | \"light\"",
             "references": {
               "IcThemeMode": {
                 "location": "import",
@@ -8846,22 +8835,19 @@
             {
               "value": "light",
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "type",
-          "type": "\"circular\" | \"linear\" | undefined",
+          "type": "\"circular\" | \"linear\"",
           "complexType": {
             "original": "IcLoadingTypes",
-            "resolved": "\"circular\" | \"linear\" | undefined",
+            "resolved": "\"circular\" | \"linear\"",
             "references": {
               "IcLoadingTypes": {
                 "location": "import",
@@ -8884,12 +8870,9 @@
             {
               "value": "linear",
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -8902,7 +8885,7 @@
         {
           "name": "--circular-diameter",
           "annotation": "prop",
-          "docs": "Diameter of the circular-indicator"
+          "docs": "Diameter of the circular-indicator in px, rem or %"
         }
       ],
       "slots": [],
@@ -9953,10 +9936,10 @@
       "props": [
         {
           "name": "download",
-          "type": "boolean | string | undefined",
+          "type": "boolean | string",
           "complexType": {
             "original": "string | boolean",
-            "resolved": "boolean | string | undefined",
+            "resolved": "boolean | string",
             "references": {}
           },
           "mutable": false,
@@ -9971,12 +9954,9 @@
             },
             {
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -10173,10 +10153,10 @@
         },
         {
           "name": "theme",
-          "type": "\"dark\" | \"inherit\" | \"light\" | undefined",
+          "type": "\"dark\" | \"inherit\" | \"light\"",
           "complexType": {
             "original": "IcThemeMode",
-            "resolved": "\"dark\" | \"inherit\" | \"light\" | undefined",
+            "resolved": "\"dark\" | \"inherit\" | \"light\"",
             "references": {
               "IcThemeMode": {
                 "location": "import",
@@ -10185,7 +10165,7 @@
               }
             }
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "theme",
           "reflectToAttr": false,
           "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
@@ -10203,12 +10183,9 @@
             {
               "value": "light",
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -10325,6 +10302,33 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "expanded",
+          "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "expanded",
+          "reflectToAttr": false,
+          "docs": "If `true`, the expandable group will be expanded by default when in an ic-side-navigation component. To enable this prop, `expandable` must also be set to `true`.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "label",
           "type": "string",
@@ -12330,7 +12334,12 @@
       "tag": "ic-radio-group",
       "readme": "# ic-radio-group\r\n\r\n\r\n\r",
       "docs": "",
-      "docsTags": [],
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "helper-text - Content is set as the helper text for the radio group."
+        }
+      ],
       "usage": {},
       "props": [
         {
@@ -12713,7 +12722,12 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "helper-text",
+          "docs": "Content is set as the helper text for the radio group."
+        }
+      ],
       "parts": [],
       "dependents": [],
       "dependencies": [
@@ -13132,7 +13146,12 @@
       "tag": "ic-search-bar",
       "readme": "# ic-search-bar\r\n\r\n\r\n\r",
       "docs": "",
-      "docsTags": [],
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "helper-text - Content is set as the helper text for the search bar."
+        }
+      ],
       "usage": {},
       "props": [
         {
@@ -13185,10 +13204,10 @@
         },
         {
           "name": "autocomplete",
-          "type": "\"on\" | \"off\" | \"name\" | \"honorific-prefix\" | \"given-name\" | \"additional-name\" | \"family-name\" | \"honorific-suffix\" | \"nickname\" | \"email\" | \"username\" | \"new-password\" | \"current-password\" | \"one-time-code\" | \"organization-title\" | \"organization\" | \"street-address\" | \"address-line1\" | \"address-line2\" | \"address-line3\" | \"address-level4\" | \"address-level3\" | \"address-level2\" | \"address-level1\" | \"country\" | \"country-name\" | \"postal-code\" | \"cc-name\" | \"cc-given-name\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-number\" | \"cc-exp\" | \"cc-exp-month\" | \"cc-exp-year\" | \"cc-csc\" | \"cc-type\" | \"transaction-currency\" | \"transaction-amount\" | \"language\" | \"bday\" | \"bday-day\" | \"bday-month\" | \"bday-year\" | \"sex\" | \"tel\" | \"tel-country-code\" | \"tel-national\" | \"tel-area-code\" | \"tel-local\" | \"tel-extension\" | \"impp\" | \"url\" | \"photo\"",
+          "type": "\"name\" | \"on\" | \"off\" | \"honorific-prefix\" | \"given-name\" | \"additional-name\" | \"family-name\" | \"honorific-suffix\" | \"nickname\" | \"email\" | \"username\" | \"new-password\" | \"current-password\" | \"one-time-code\" | \"organization-title\" | \"organization\" | \"street-address\" | \"address-line1\" | \"address-line2\" | \"address-line3\" | \"address-level4\" | \"address-level3\" | \"address-level2\" | \"address-level1\" | \"country\" | \"country-name\" | \"postal-code\" | \"cc-name\" | \"cc-given-name\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-number\" | \"cc-exp\" | \"cc-exp-month\" | \"cc-exp-year\" | \"cc-csc\" | \"cc-type\" | \"transaction-currency\" | \"transaction-amount\" | \"language\" | \"bday\" | \"bday-day\" | \"bday-month\" | \"bday-year\" | \"sex\" | \"tel\" | \"tel-country-code\" | \"tel-national\" | \"tel-area-code\" | \"tel-local\" | \"tel-extension\" | \"impp\" | \"url\" | \"photo\"",
           "complexType": {
             "original": "IcAutocompleteTypes",
-            "resolved": "\"on\" | \"off\" | \"name\" | \"honorific-prefix\" | \"given-name\" | \"additional-name\" | \"family-name\" | \"honorific-suffix\" | \"nickname\" | \"email\" | \"username\" | \"new-password\" | \"current-password\" | \"one-time-code\" | \"organization-title\" | \"organization\" | \"street-address\" | \"address-line1\" | \"address-line2\" | \"address-line3\" | \"address-level4\" | \"address-level3\" | \"address-level2\" | \"address-level1\" | \"country\" | \"country-name\" | \"postal-code\" | \"cc-name\" | \"cc-given-name\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-number\" | \"cc-exp\" | \"cc-exp-month\" | \"cc-exp-year\" | \"cc-csc\" | \"cc-type\" | \"transaction-currency\" | \"transaction-amount\" | \"language\" | \"bday\" | \"bday-day\" | \"bday-month\" | \"bday-year\" | \"sex\" | \"tel\" | \"tel-country-code\" | \"tel-national\" | \"tel-area-code\" | \"tel-local\" | \"tel-extension\" | \"impp\" | \"url\" | \"photo\"",
+            "resolved": "\"name\" | \"on\" | \"off\" | \"honorific-prefix\" | \"given-name\" | \"additional-name\" | \"family-name\" | \"honorific-suffix\" | \"nickname\" | \"email\" | \"username\" | \"new-password\" | \"current-password\" | \"one-time-code\" | \"organization-title\" | \"organization\" | \"street-address\" | \"address-line1\" | \"address-line2\" | \"address-line3\" | \"address-level4\" | \"address-level3\" | \"address-level2\" | \"address-level1\" | \"country\" | \"country-name\" | \"postal-code\" | \"cc-name\" | \"cc-given-name\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-number\" | \"cc-exp\" | \"cc-exp-month\" | \"cc-exp-year\" | \"cc-csc\" | \"cc-type\" | \"transaction-currency\" | \"transaction-amount\" | \"language\" | \"bday\" | \"bday-day\" | \"bday-month\" | \"bday-year\" | \"sex\" | \"tel\" | \"tel-country-code\" | \"tel-national\" | \"tel-area-code\" | \"tel-local\" | \"tel-extension\" | \"impp\" | \"url\" | \"photo\"",
             "references": {
               "IcAutocompleteTypes": {
                 "location": "import",
@@ -13205,7 +13224,7 @@
           "default": "\"off\"",
           "values": [
             {
-              "value": "on",
+              "value": "name",
               "type": "string"
             },
             {
@@ -13213,7 +13232,7 @@
               "type": "string"
             },
             {
-              "value": "name",
+              "value": "on",
               "type": "string"
             },
             {
@@ -13897,6 +13916,30 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "preventFormSubmitOnSearch",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "prevent-form-submit-on-search",
+          "reflectToAttr": false,
+          "docs": "If `true` the parent form will not submit when the icSubmitSearch event fires.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "readonly",
           "type": "boolean",
@@ -14391,7 +14434,12 @@
           "docs": "z-index of search bar menu"
         }
       ],
-      "slots": [],
+      "slots": [
+        {
+          "name": "helper-text",
+          "docs": "Content is set as the helper text for the search bar."
+        }
+      ],
       "parts": [],
       "dependents": [],
       "dependencies": [
@@ -14548,6 +14596,10 @@
       "readme": "# ic-select\r\n\r\n\r\n\r",
       "docs": "",
       "docsTags": [
+        {
+          "name": "slot",
+          "text": "helper-text - Content is set as the helper text for the select."
+        },
         {
           "name": "slot",
           "text": "icon - Content will be placed to the left of the select text input."
@@ -15564,6 +15616,10 @@
         }
       ],
       "slots": [
+        {
+          "name": "helper-text",
+          "docs": "Content is set as the helper text for the select."
+        },
         {
           "name": "icon",
           "docs": "Content will be placed to the left of the select text input."
@@ -16991,6 +17047,10 @@
       "readme": "# ic-switch\r\n\r\n\r\n\r",
       "docs": "",
       "docsTags": [
+        {
+          "name": "slot",
+          "text": "helper-text - Content is set as the helper text for the switch."
+        },
         {
           "name": "slot",
           "text": "right-adornment - Content is placed to the right of switch."
@@ -17344,6 +17404,10 @@
       "listeners": [],
       "styles": [],
       "slots": [
+        {
+          "name": "helper-text",
+          "docs": "Content is set as the helper text for the switch."
+        },
         {
           "name": "right-adornment",
           "docs": "Content is placed to the right of switch."
@@ -17795,6 +17859,10 @@
       "readme": "# ic-textfield\r\n\r\n\r\n\r",
       "docs": "",
       "docsTags": [
+        {
+          "name": "slot",
+          "text": "helper-text - Content is set as the helper text for the text field."
+        },
         {
           "name": "slot",
           "text": "icon - Content will be placed to the left of the text input."
@@ -18939,6 +19007,10 @@
         }
       ],
       "slots": [
+        {
+          "name": "helper-text",
+          "docs": "Content is set as the helper text for the text field."
+        },
         {
           "name": "icon",
           "docs": "Content will be placed to the left of the text input."

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "API documentation for @ukic components",
   "main": "docs.json",
   "types": "docs.d.ts",
@@ -19,5 +19,5 @@
   },
   "license": "MIT",
   "packageManager": "^npm@10.9.2",
-  "gitHead": "f0716114394a6cd31b38fdee67d71042debdcb63"
+  "gitHead": "b2e5e8e0ebf877277c71d9b8c72edde315c70fe5"
 }