@ukic/docs 3.1.0 → 3.2.0

package/docs.json

@@ -558,10 +558,10 @@
       "props": [
         {
           "name": "announced",
-          "type": "boolean | undefined",
+          "type": "boolean",
           "complexType": {
             "original": "boolean",
-            "resolved": "boolean | undefined",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
@@ -573,22 +573,19 @@
           "values": [
             {
               "type": "boolean"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "dismissible",
-          "type": "boolean | undefined",
+          "type": "boolean",
           "complexType": {
             "original": "boolean",
-            "resolved": "boolean | undefined",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
@@ -600,22 +597,19 @@
           "values": [
             {
               "type": "boolean"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "heading",
-          "type": "string | undefined",
+          "type": "string",
           "complexType": {
             "original": "string",
-            "resolved": "string | undefined",
+            "resolved": "string",
             "references": {}
           },
           "mutable": false,
@@ -627,12 +621,9 @@
           "values": [
             {
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -665,10 +656,10 @@
         },
         {
           "name": "showDefaultIcon",
-          "type": "boolean | undefined",
+          "type": "boolean",
           "complexType": {
             "original": "boolean",
-            "resolved": "boolean | undefined",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
@@ -680,22 +671,19 @@
           "values": [
             {
               "type": "boolean"
-            },
-            {
-              "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",
@@ -722,22 +710,19 @@
             {
               "value": "light",
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "titleAbove",
-          "type": "boolean | undefined",
+          "type": "boolean",
           "complexType": {
             "original": "boolean",
-            "resolved": "boolean | undefined",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
@@ -749,22 +734,19 @@
           "values": [
             {
               "type": "boolean"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
         },
         {
           "name": "variant",
-          "type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\" | undefined",
+          "type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
           "complexType": {
             "original": "IcStatusVariants",
-            "resolved": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\" | undefined",
+            "resolved": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
             "references": {
               "IcStatusVariants": {
                 "location": "import",
@@ -799,12 +781,9 @@
             {
               "value": "warning",
               "type": "string"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false,
           "getter": false,
           "setter": false
@@ -832,6 +811,12 @@
           "event": "icDismiss",
           "capture": true,
           "passive": false
+        },
+        {
+          "event": "icThemeChange",
+          "target": "document",
+          "capture": true,
+          "passive": false
         }
       ],
       "styles": [],
@@ -15464,7 +15449,7 @@
           "mutable": true,
           "attr": "value",
           "reflectToAttr": false,
-          "docs": "The value of the select, reflected by the value of the currently selected option.\r\nFor the searchable variant, the value is also reflected by the user input.\r\nFor the multi-select variant, the value must be an array of option values.",
+          "docs": "The value of the select, reflected by the value of the currently selected option.\nFor the searchable variant, the value is also reflected by the user input.\nFor the multi-select variant, the value must be an array of option values.",
           "docsTags": [],
           "values": [
             {
@@ -15658,7 +15643,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when an option is selected.\r\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
+          "docs": "Emitted when an option is selected.\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
           "docsTags": []
         },
         {
@@ -16426,7 +16411,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 element.",
+          "docsTags": []
+        }
+      ],
       "events": [],
       "listeners": [],
       "styles": [
@@ -17900,7 +17908,7 @@
           "mutable": false,
           "attr": "autocapitalize",
           "reflectToAttr": false,
-          "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
+          "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\r\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
           "docsTags": [],
           "default": "\"off\"",
           "values": [
@@ -18079,7 +18087,7 @@
           "mutable": false,
           "attr": "full-width",
           "reflectToAttr": false,
-          "docs": "Specify whether the text field fills the full width of the container.\nIf `true`, this overrides the --input-width CSS variable.",
+          "docs": "Specify whether the text field fills the full width of the container.\r\nIf `true`, this overrides the --input-width CSS variable.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -18220,7 +18228,7 @@
           "mutable": false,
           "attr": "inputmode",
           "reflectToAttr": false,
-          "docs": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
+          "docs": "A hint to the browser for which keyboard to display.\r\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\r\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
           "docsTags": [],
           "default": "\"text\"",
           "values": [
@@ -19184,9 +19192,15 @@
           "name": "theme",
           "type": "\"dark\" | \"light\" | \"system\" | undefined",
           "complexType": {
-            "original": "\"dark\" | \"light\" | \"system\"",
+            "original": "IcThemeSettings",
             "resolved": "\"dark\" | \"light\" | \"system\" | undefined",
-            "references": {}
+            "references": {
+              "IcThemeSettings": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcThemeSettings"
+              }
+            }
           },
           "mutable": false,
           "attr": "theme",
@@ -19218,7 +19232,28 @@
         }
       ],
       "methods": [],
-      "events": [],
+      "events": [
+        {
+          "event": "icThemeChange",
+          "detail": "\"dark\" | \"light\" | \"system\"",
+          "bubbles": true,
+          "complexType": {
+            "original": "IcThemeSettings",
+            "resolved": "\"dark\" | \"light\" | \"system\"",
+            "references": {
+              "IcThemeSettings": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcThemeSettings"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the theme is changed.",
+          "docsTags": []
+        }
+      ],
       "listeners": [],
       "styles": [],
       "slots": [],
@@ -19256,7 +19291,7 @@
           "mutable": true,
           "attr": "auto-dismiss-timeout",
           "reflectToAttr": false,
-          "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\r\n(NOTE: Has a minimum value of `5000ms`)",
+          "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\n(NOTE: Has a minimum value of `5000ms`)",
           "docsTags": [],
           "default": "5000",
           "values": [
@@ -20989,7 +21024,7 @@
           "mutable": false,
           "attr": "custom-mobile-breakpoint",
           "reflectToAttr": false,
-          "docs": "Can set a custom breakpoint for the top navigation to switch to mobile mode.\nMust be one of our specified breakpoints in px: `0`, `576`, `768`, `992`, `1200`.",
+          "docs": "Can set a custom breakpoint for the top navigation to switch to mobile mode.\r\nMust be one of our specified breakpoints in px: `0`, `576`, `768`, `992`, `1200`.",
           "docsTags": [],
           "default": "DEVICE_SIZES.L",
           "values": [
@@ -21796,7 +21831,7 @@
       "path": "src/utils/types.ts"
     },
     "src/utils/types.ts::IcStatusVariants": {
-      "declaration": "export type IcStatusVariants =\n  | \"neutral\"\n  | \"info\"\n  | \"warning\"\n  | \"error\"\n  | \"success\";",
+      "declaration": "export type IcStatusVariants =\r\n  | \"neutral\"\r\n  | \"info\"\r\n  | \"warning\"\r\n  | \"error\"\r\n  | \"success\";",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -21901,7 +21936,7 @@
       "path": "src/components/ic-text-field/ic-text-field.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\";",
+      "declaration": "export type IcAutocompleteTypes =\r\n  | \"on\"\r\n  | \"off\"\r\n  | \"name\"\r\n  | \"honorific-prefix\"\r\n  | \"given-name\"\r\n  | \"additional-name\"\r\n  | \"family-name\"\r\n  | \"honorific-suffix\"\r\n  | \"nickname\"\r\n  | \"email\"\r\n  | \"username\"\r\n  | \"new-password\"\r\n  | \"current-password\"\r\n  | \"one-time-code\"\r\n  | \"organization-title\"\r\n  | \"organization\"\r\n  | \"street-address\"\r\n  | \"address-line1\"\r\n  | \"address-line2\"\r\n  | \"address-line3\"\r\n  | \"address-level4\"\r\n  | \"address-level3\"\r\n  | \"address-level2\"\r\n  | \"address-level1\"\r\n  | \"country\"\r\n  | \"country-name\"\r\n  | \"postal-code\"\r\n  | \"cc-name\"\r\n  | \"cc-given-name\"\r\n  | \"cc-additional-name\"\r\n  | \"cc-family-name\"\r\n  | \"cc-family-name\"\r\n  | \"cc-number\"\r\n  | \"cc-exp\"\r\n  | \"cc-exp-month\"\r\n  | \"cc-exp-year\"\r\n  | \"cc-csc\"\r\n  | \"cc-type\"\r\n  | \"transaction-currency\"\r\n  | \"transaction-amount\"\r\n  | \"language\"\r\n  | \"bday\"\r\n  | \"bday-day\"\r\n  | \"bday-month\"\r\n  | \"bday-year\"\r\n  | \"sex\"\r\n  | \"tel\"\r\n  | \"tel-country-code\"\r\n  | \"tel-national\"\r\n  | \"tel-area-code\"\r\n  | \"tel-local\"\r\n  | \"tel-extension\"\r\n  | \"impp\"\r\n  | \"url\"\r\n  | \"photo\";",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -21926,7 +21961,7 @@
       "path": "src/components/ic-text-field/ic-text-field.types.ts"
     },
     "src/utils/types.ts::IcValueEventDetail": {
-      "declaration": "export interface IcValueEventDetail {\n  value: string;\n  keyPressed?: string;\n}",
+      "declaration": "export interface IcValueEventDetail {\r\n  value: string;\r\n  keyPressed?: string;\r\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -21936,7 +21971,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 {\r\n  description?: string;\r\n  disabled?: boolean;\r\n  recommended?: boolean;\r\n  children?: IcMenuOption[];\r\n  loading?: boolean;\r\n  timedOut?: boolean;\r\n  [key: string]: any;\r\n  element?: {\r\n    component: any;\r\n    ariaLabel: string;\r\n  };\r\n  icon?: any;\r\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -21951,12 +21986,12 @@
       "path": "src/components/ic-menu/ic-menu.types.ts"
     },
     "src/utils/types.ts::IcBlurEventDetail": {
-      "declaration": "export interface IcBlurEventDetail {\n  relatedTarget: IcRelatedTarget | null;\n}",
+      "declaration": "export interface IcBlurEventDetail {\r\n  relatedTarget: IcRelatedTarget | null;\r\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
     "src/utils/types.ts::IcMultiValueEventDetail": {
-      "declaration": "export interface IcMultiValueEventDetail {\n  value: string | string[] | null;\n  keyPressed?: string;\n}",
+      "declaration": "export interface IcMultiValueEventDetail {\r\n  value: string | string[] | null;\r\n  keyPressed?: string;\r\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -21996,7 +22031,7 @@
       "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\";",
+      "declaration": "export type IcTypographyVariants =\r\n  | \"h1\"\r\n  | \"h2\"\r\n  | \"h3\"\r\n  | \"h4\"\r\n  | \"subtitle-large\"\r\n  | \"subtitle-small\"\r\n  | \"body\"\r\n  | \"label\"\r\n  | \"label-uppercase\"\r\n  | \"caption\"\r\n  | \"caption-uppercase\"\r\n  | \"code-large\"\r\n  | \"code-small\"\r\n  | \"code-extra-small\"\r\n  | \"badge\"\r\n  | \"badge-small\";",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -22041,12 +22076,12 @@
       "path": "src/components/ic-menu-item/ic-menu-item.types.ts"
     },
     "src/components/ic-navigation-group/ic-navigation-group.types.ts::IcNavigationOpenEventDetail": {
-      "declaration": "export interface IcNavigationOpenEventDetail {\r\n  source: HTMLElement;\r\n}",
+      "declaration": "export interface IcNavigationOpenEventDetail {\n  source: HTMLElement;\n}",
       "docstring": "",
       "path": "src/components/ic-navigation-group/ic-navigation-group.types.ts"
     },
     "src/components/ic-navigation-group/ic-navigation-group.types.ts::IcNavigationExpandEventDetail": {
-      "declaration": "export interface IcNavigationExpandEventDetail {\r\n  expanded: boolean;\r\n}",
+      "declaration": "export interface IcNavigationExpandEventDetail {\n  expanded: boolean;\n}",
       "docstring": "",
       "path": "src/components/ic-navigation-group/ic-navigation-group.types.ts"
     },
@@ -22115,8 +22150,13 @@
       "docstring": "",
       "path": "src/components/ic-tab/ic-tab.types.ts"
     },
+    "src/utils/types.ts::IcThemeSettings": {
+      "declaration": "export type IcThemeSettings = \"dark\" | \"light\" | \"system\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
     "src/utils/types.ts::IcBrand": {
-      "declaration": "{\n  mode: IcBrandForeground;\n  color: IcColorRGB;\n}",
+      "declaration": "{\r\n  mode: IcBrandForeground;\r\n  color: IcColorRGB;\r\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "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": "6ddd470175efc6e34d94c67fe05db42304dd4e3c"
+  "gitHead": "e084fa80621797c35c5a59446ea6a3e97486a552"
 }