@ukic/docs 3.4.1 → 3.4.3

package/docs.json

@@ -4825,6 +4825,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\"",
@@ -6266,7 +6305,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Cancelation event emitted when default 'Cancel' button clicked or 'cancelDialog' method is called.",
+          "docs": "Cancellation event emitted when default 'Cancel' button clicked or 'cancelDialog' method is called.",
           "docsTags": []
         },
         {
@@ -8720,13 +8759,13 @@
           "name": "ariaLiveMode",
           "type": "\"assertive\" | \"off\" | \"polite\" | undefined",
           "complexType": {
-            "original": "IcAriaLiveModeVariants",
+            "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"
               }
             }
           },
@@ -13834,6 +13873,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",
@@ -13881,10 +13959,10 @@
         },
         {
           "name": "validationText",
-          "type": "string | undefined",
+          "type": "string",
           "complexType": {
             "original": "string",
-            "resolved": "string | undefined",
+            "resolved": "string",
             "references": {}
           },
           "mutable": false,
@@ -13896,12 +13974,9 @@
           "values": [
             {
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -16525,6 +16600,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\"",
@@ -17938,6 +18052,35 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "icI18n",
+          "type": "{ next: string; step: string; steps: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+          "complexType": {
+            "original": "IcStepI18n",
+            "resolved": "{ next: string; step: string; steps: 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    steps: \"Steps\",\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; steps: 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",
@@ -18170,6 +18313,38 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "icI18n",
+          "type": "undefined | { next: string; step: string; steps: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+          "complexType": {
+            "original": "IcStepI18n",
+            "resolved": "undefined | { next: string; step: string; steps: 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    steps: \"Steps\",\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; steps: 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",
@@ -23119,6 +23294,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/utils/types.ts::IcInformationStatusOrEmpty": {
       "declaration": "export type IcInformationStatusOrEmpty = \"warning\" | \"error\" | \"success\" | \"\";",
       "docstring": "",
@@ -23134,11 +23314,6 @@
       "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::IcAutocompleteTypes": {
       "declaration": "export type IcAutocompleteTypes =\n  | \"on\"\n  | \"off\"\n  | \"name\"\n  | \"honorific-prefix\"\n  | \"given-name\"\n  | \"additional-name\"\n  | \"family-name\"\n  | \"honorific-suffix\"\n  | \"nickname\"\n  | \"email\"\n  | \"username\"\n  | \"new-password\"\n  | \"current-password\"\n  | \"one-time-code\"\n  | \"organization-title\"\n  | \"organization\"\n  | \"street-address\"\n  | \"address-line1\"\n  | \"address-line2\"\n  | \"address-line3\"\n  | \"address-level4\"\n  | \"address-level3\"\n  | \"address-level2\"\n  | \"address-level1\"\n  | \"country\"\n  | \"country-name\"\n  | \"postal-code\"\n  | \"cc-name\"\n  | \"cc-given-name\"\n  | \"cc-additional-name\"\n  | \"cc-family-name\"\n  | \"cc-family-name\"\n  | \"cc-number\"\n  | \"cc-exp\"\n  | \"cc-exp-month\"\n  | \"cc-exp-year\"\n  | \"cc-csc\"\n  | \"cc-type\"\n  | \"transaction-currency\"\n  | \"transaction-amount\"\n  | \"language\"\n  | \"bday\"\n  | \"bday-day\"\n  | \"bday-month\"\n  | \"bday-year\"\n  | \"sex\"\n  | \"tel\"\n  | \"tel-country-code\"\n  | \"tel-national\"\n  | \"tel-area-code\"\n  | \"tel-local\"\n  | \"tel-extension\"\n  | \"impp\"\n  | \"url\"\n  | \"photo\";",
       "docstring": "",
@@ -23164,6 +23339,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": "",
@@ -23175,7 +23355,7 @@
       "path": "src/components/ic-search-bar/ic-search-bar.types.ts"
     },
     "src/utils/types.ts::IcMenuOption": {
-      "declaration": "export interface IcMenuOption {\n  description?: string;\n  disabled?: boolean;\n  recommended?: boolean;\n  children?: IcMenuOption[];\n  loading?: boolean;\n  timedOut?: boolean;\n  [key: string]: any;\n  element?: {\n    component: any;\n    ariaLabel: string;\n  };\n  icon?: any;\n}",
+      "declaration": "export interface IcMenuOption {\n  description?: string;\n  disabled?: boolean;\n  recommended?: boolean;\n  children?: IcMenuOption[];\n  loading?: boolean;\n  timedOut?: boolean;\n  [key: string]: any;\n  element?: {\n    component: any;\n    ariaLabel: string;\n  };\n  icon?: any;\n  hideLabel?: boolean;\n  htmlProps?: Record<string, any>;\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -23249,11 +23429,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\" | \"off\";",
-      "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": "",
@@ -23339,6 +23514,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  steps: 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.1",
+  "version": "3.4.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": "3614c603996bdfb39b4be9114ec272a4ee138c23"
+  "gitHead": "7218b39b3c6116e600c3e6ba9e785d0b2f3a390a"
 }