@ukic/docs 3.4.0 → 3.4.2

package/docs.json

@@ -3324,7 +3324,7 @@
               }
             }
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "variant",
           "reflectToAttr": false,
           "docs": "The variant of the button to be displayed.",
@@ -8718,15 +8718,15 @@
       "props": [
         {
           "name": "ariaLiveMode",
-          "type": "\"assertive\" | \"polite\" | undefined",
+          "type": "\"assertive\" | \"off\" | \"polite\" | undefined",
           "complexType": {
-            "original": "IcAriaLiveModeVariants",
-            "resolved": "\"assertive\" | \"polite\" | undefined",
+            "original": "IcAriaLive",
+            "resolved": "\"assertive\" | \"off\" | \"polite\" | undefined",
             "references": {
-              "IcAriaLiveModeVariants": {
+              "IcAriaLive": {
                 "location": "import",
-                "path": "./ic-input-validation.types",
-                "id": "src/components/ic-input-validation/ic-input-validation.types.tsx::IcAriaLiveModeVariants"
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcAriaLive"
               }
             }
           },
@@ -8741,6 +8741,10 @@
               "value": "assertive",
               "type": "string"
             },
+            {
+              "value": "off",
+              "type": "string"
+            },
             {
               "value": "polite",
               "type": "string"
@@ -13830,6 +13834,45 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "validationAriaLive",
+          "type": "\"assertive\" | \"off\" | \"polite\"",
+          "complexType": {
+            "original": "IcAriaLive",
+            "resolved": "\"assertive\" | \"off\" | \"polite\"",
+            "references": {
+              "IcAriaLive": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcAriaLive"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "validation-aria-live",
+          "reflectToAttr": false,
+          "docs": "The value of the `aria-live` attribute on the validation message.",
+          "docsTags": [],
+          "default": "\"polite\"",
+          "values": [
+            {
+              "value": "assertive",
+              "type": "string"
+            },
+            {
+              "value": "off",
+              "type": "string"
+            },
+            {
+              "value": "polite",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "validationStatus",
           "type": "\"\" | \"error\" | \"success\" | \"warning\" | undefined",
@@ -13877,10 +13920,10 @@
         },
         {
           "name": "validationText",
-          "type": "string | undefined",
+          "type": "string",
           "complexType": {
             "original": "string",
-            "resolved": "string | undefined",
+            "resolved": "string",
             "references": {}
           },
           "mutable": false,
@@ -13892,12 +13935,9 @@
           "values": [
             {
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -16521,6 +16561,45 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "validationAriaLive",
+          "type": "\"assertive\" | \"off\" | \"polite\"",
+          "complexType": {
+            "original": "IcAriaLive",
+            "resolved": "\"assertive\" | \"off\" | \"polite\"",
+            "references": {
+              "IcAriaLive": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcAriaLive"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "validation-aria-live",
+          "reflectToAttr": false,
+          "docs": "The value of the `aria-live` attribute on the validation message.",
+          "docsTags": [],
+          "default": "\"polite\"",
+          "values": [
+            {
+              "value": "assertive",
+              "type": "string"
+            },
+            {
+              "value": "off",
+              "type": "string"
+            },
+            {
+              "value": "polite",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "validationStatus",
           "type": "\"\" | \"error\" | \"success\" | \"warning\"",
@@ -17934,6 +18013,35 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "icI18n",
+          "type": "{ next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+          "complexType": {
+            "original": "IcStepI18n",
+            "resolved": "{ next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+            "references": {
+              "IcStepI18n": {
+                "location": "import",
+                "path": "./ic-step.types",
+                "id": "src/components/ic-step/ic-step.types.ts::IcStepI18n"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "Words within the component that can be replaced to translate the component into a different language",
+          "docsTags": [],
+          "default": "{\n    next: \"Next\",\n    step: \"Step\",\n    of: \"of\",\n    lastStep: \"Last step\",\n    completed: \"Completed\",\n    notRequired: \"Not required\",\n    required: \"Required\",\n    optional: \"Optional\",\n  }",
+          "values": [
+            {
+              "type": "{ next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "status",
           "type": "\"optional\" | \"required\" | undefined",
@@ -18166,6 +18274,38 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "icI18n",
+          "type": "undefined | { next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+          "complexType": {
+            "original": "IcStepI18n",
+            "resolved": "undefined | { next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+            "references": {
+              "IcStepI18n": {
+                "location": "import",
+                "path": "../ic-step/ic-step.types",
+                "id": "src/components/ic-step/ic-step.types.ts::IcStepI18n"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "Provide alternative values for text in all child steps. For the purpose of translating the application into other languages.",
+          "docsTags": [],
+          "default": "{\n    next: \"Next\",\n    step: \"Step\",\n    of: \"of\",\n    lastStep: \"Last step\",\n    completed: \"Completed\",\n    notRequired: \"Not required\",\n    required: \"Required\",\n    optional: \"Optional\",\n  }",
+          "values": [
+            {
+              "type": "undefined"
+            },
+            {
+              "type": "{ next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "theme",
           "type": "\"dark\" | \"inherit\" | \"light\" | undefined",
@@ -18908,7 +19048,30 @@
           "setter": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the tab context.",
+          "docsTags": []
+        }
+      ],
       "events": [
         {
           "event": "icTabSelect",
@@ -19955,6 +20118,49 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "validationAriaLive",
+          "type": "\"assertive\" | \"default\" | \"off\" | \"polite\"",
+          "complexType": {
+            "original": "IcValidationAriaLive",
+            "resolved": "\"assertive\" | \"default\" | \"off\" | \"polite\"",
+            "references": {
+              "IcValidationAriaLive": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcValidationAriaLive"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "validation-aria-live",
+          "reflectToAttr": false,
+          "docs": "The value of the `aria-live` attribute on the validation message. When set to \"default\", the `aria-live` value will be handled automatically, e.g. \"assertive\" for `validation-status=\"error\"`.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "assertive",
+              "type": "string"
+            },
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "off",
+              "type": "string"
+            },
+            {
+              "value": "polite",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "validationInline",
           "type": "boolean",
@@ -23089,6 +23295,11 @@
       "docstring": "",
       "path": "src/components/ic-text-field/ic-text-field.types.ts"
     },
+    "src/utils/types.ts::IcValidationAriaLive": {
+      "declaration": "export type IcValidationAriaLive = \"default\" | \"polite\" | \"assertive\" | \"off\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
     "src/utils/types.ts::IcValueEventDetail": {
       "declaration": "export interface IcValueEventDetail {\n  value: string;\n  keyPressed?: string;\n}",
       "docstring": "",
@@ -23134,6 +23345,11 @@
       "docstring": "",
       "path": "src/utils/types.ts"
     },
+    "src/utils/types.ts::IcAriaLive": {
+      "declaration": "export type IcAriaLive = \"polite\" | \"assertive\" | \"off\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
     "src/components/ic-radio-group/ic-radio-group.types.ts::IcChangeEventDetail": {
       "declaration": "export interface IcChangeEventDetail {\n  value: string;\n  selectedOption: {\n    radio: HTMLIcRadioOptionElement;\n    textFieldValue?: string;\n  };\n}",
       "docstring": "",
@@ -23174,11 +23390,6 @@
       "docstring": "",
       "path": "src/components/ic-hero/ic-hero.types.tsx"
     },
-    "src/components/ic-input-validation/ic-input-validation.types.tsx::IcAriaLiveModeVariants": {
-      "declaration": "export type IcAriaLiveModeVariants = \"polite\" | \"assertive\";",
-      "docstring": "",
-      "path": "src/components/ic-input-validation/ic-input-validation.types.tsx"
-    },
     "src/components/ic-layout-grid/ic-layout-grid.types.ts::IcGridBreakpoints": {
       "declaration": "export type IcGridBreakpoints =\n  | number\n  | {\n      xs?: number;\n      sm?: number;\n      md?: number;\n      lg?: number;\n      xl?: number;\n    };",
       "docstring": "",
@@ -23264,6 +23475,11 @@
       "docstring": "",
       "path": "src/components/ic-step/ic-step.types.ts"
     },
+    "src/components/ic-step/ic-step.types.ts::IcStepI18n": {
+      "declaration": "{\n  next: string;\n  step: string;\n  of: string;\n  lastStep: string;\n  completed: string;\n  notRequired: string;\n  required: string;\n  optional: string;\n}",
+      "docstring": "",
+      "path": "src/components/ic-step/ic-step.types.ts"
+    },
     "src/components/ic-step/ic-step.types.ts::IcStepStatuses": {
       "declaration": "export type IcStepStatuses = \"optional\" | \"required\";",
       "docstring": "",

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "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": "5966ee7320ed3b03f0f61beb7206e4fd0ec5a813"
+  "gitHead": "59dd37757e441316d04134c35f8e09b7aea84e91"
 }