@ukic/docs 3.4.2 → 3.4.4

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": []
         },
         {
@@ -18015,10 +18054,10 @@
         },
         {
           "name": "icI18n",
-          "type": "{ next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+          "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; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+            "resolved": "{ next: string; step: string; steps: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
             "references": {
               "IcStepI18n": {
                 "location": "import",
@@ -18031,10 +18070,10 @@
           "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  }",
+          "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; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }"
+              "type": "{ next: string; step: string; steps: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }"
             }
           ],
           "optional": false,
@@ -18276,10 +18315,10 @@
         },
         {
           "name": "icI18n",
-          "type": "undefined | { next: string; step: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+          "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; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
+            "resolved": "undefined | { next: string; step: string; steps: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }",
             "references": {
               "IcStepI18n": {
                 "location": "import",
@@ -18292,13 +18331,13 @@
           "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  }",
+          "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; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }"
+              "type": "{ next: string; step: string; steps: string; of: string; lastStep: string; completed: string; notRequired: string; required: string; optional: string; }"
             }
           ],
           "optional": true,
@@ -20383,15 +20422,16 @@
         },
         {
           "event": "icKeydown",
-          "detail": "{ event: KeyboardEvent; }",
+          "detail": "IcTextFieldKeydownEventDetail",
           "bubbles": true,
           "complexType": {
-            "original": "{ event: KeyboardEvent }",
-            "resolved": "{ event: KeyboardEvent; }",
+            "original": "IcTextFieldKeydownEventDetail",
+            "resolved": "IcTextFieldKeydownEventDetail",
             "references": {
-              "KeyboardEvent": {
-                "location": "global",
-                "id": "global::KeyboardEvent"
+              "IcTextFieldKeydownEventDetail": {
+                "location": "import",
+                "path": "./ic-text-field.types",
+                "id": "src/components/ic-text-field/ic-text-field.types.ts::IcTextFieldKeydownEventDetail"
               }
             }
           },
@@ -23250,11 +23290,21 @@
       "docstring": "",
       "path": "src/components/ic-tooltip/ic-tooltip.types.ts"
     },
+    "src/utils/types.ts::IcTypographyVariants": {
+      "declaration": "export type IcTypographyVariants =\n  | \"h1\"\n  | \"h2\"\n  | \"h3\"\n  | \"h4\"\n  | \"subtitle-large\"\n  | \"subtitle-small\"\n  | \"body\"\n  | \"label\"\n  | \"label-uppercase\"\n  | \"caption\"\n  | \"caption-uppercase\"\n  | \"code-large\"\n  | \"code-small\"\n  | \"code-extra-small\"\n  | \"badge\"\n  | \"badge-small\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
     "src/utils/types.ts::IcAdditionalFieldTypes": {
       "declaration": "export type IcAdditionalFieldTypes = \"static\" | \"dynamic\";",
       "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": "",
@@ -23305,13 +23355,18 @@
       "docstring": "",
       "path": "src/utils/types.ts"
     },
+    "src/components/ic-text-field/ic-text-field.types.ts::IcTextFieldKeydownEventDetail": {
+      "declaration": "export interface IcTextFieldKeydownEventDetail {\n  event: KeyboardEvent;\n  cursorPosition: number;\n  selectionEnd: number;\n}",
+      "docstring": "",
+      "path": "src/components/ic-text-field/ic-text-field.types.ts"
+    },
     "src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
       "declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
       "docstring": "",
       "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"
     },
@@ -23345,11 +23400,6 @@
       "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": "",
@@ -23375,11 +23425,6 @@
       "docstring": "",
       "path": "src/components/ic-divider/ic-divider.types.tsx"
     },
-    "src/utils/types.ts::IcTypographyVariants": {
-      "declaration": "export type IcTypographyVariants =\n  | \"h1\"\n  | \"h2\"\n  | \"h3\"\n  | \"h4\"\n  | \"subtitle-large\"\n  | \"subtitle-small\"\n  | \"body\"\n  | \"label\"\n  | \"label-uppercase\"\n  | \"caption\"\n  | \"caption-uppercase\"\n  | \"code-large\"\n  | \"code-small\"\n  | \"code-extra-small\"\n  | \"badge\"\n  | \"badge-small\";",
-      "docstring": "",
-      "path": "src/utils/types.ts"
-    },
     "src/components/ic-empty-state/ic-empty-state.types.ts::IcEmptyStateAlignment": {
       "declaration": "export type IcEmptyStateAlignment = \"left\" | \"center\" | \"right\";",
       "docstring": "",
@@ -23476,7 +23521,7 @@
       "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}",
+      "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"
     },

package/package.json

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