@ukic/docs 2.1.0-beta.6 → 2.1.0-beta.8

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-02-07T11:39:33",
+  "timestamp": "2023-03-01T11:38:13",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -312,7 +312,19 @@
           "required": true
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the breadcrumb.",
+          "docsTags": []
+        }
+      ],
       "events": [],
       "listeners": [],
       "styles": [],
@@ -762,7 +774,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the native `button`",
+          "docs": "Sets focus on the native `button`.",
           "docsTags": []
         }
       ],
@@ -1139,7 +1151,19 @@
           "required": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the card.",
+          "docsTags": []
+        }
+      ],
       "events": [],
       "listeners": [
         {
@@ -1384,7 +1408,19 @@
           "required": true
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the checkbox.",
+          "docsTags": []
+        }
+      ],
       "events": [
         {
           "event": "checkboxChecked",
@@ -1751,7 +1787,19 @@
           "required": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the chip.",
+          "docsTags": []
+        }
+      ],
       "events": [
         {
           "event": "dismiss",
@@ -3449,7 +3497,19 @@
           "required": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the link.",
+          "docsTags": []
+        }
+      ],
       "events": [],
       "listeners": [
         {
@@ -3885,17 +3945,6 @@
         }
       ],
       "methods": [
-        {
-          "name": "handleClickOpen",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "signature": "handleClickOpen() => Promise<void>",
-          "parameters": [],
-          "docs": "If menu is opened with the mouse, emit icMenuStateChange custom event.",
-          "docsTags": []
-        },
         {
           "name": "handleKeyboardOpen",
           "returns": {
@@ -3913,40 +3962,8 @@
           ]
         }
       ],
-      "events": [
-        {
-          "event": "icMenuStateChange",
-          "detail": "IcMenuChangeEventDetail",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when state of menu changes (i.e. open or close).",
-          "docsTags": []
-        },
-        {
-          "event": "icOptionSelect",
-          "detail": "IcOptionSelectEventDetail",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when an option is selected.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [
-        {
-          "event": "icClear",
-          "target": "document",
-          "capture": false,
-          "passive": false
-        },
-        {
-          "event": "icSubmitSearch",
-          "target": "document",
-          "capture": false,
-          "passive": false
-        }
-      ],
+      "events": [],
+      "listeners": [],
       "styles": [],
       "slots": [],
       "parts": [],
@@ -4141,7 +4158,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the native `button`",
+          "docs": "Sets focus on the native `button`.",
           "docsTags": []
         }
       ],
@@ -4246,7 +4263,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the nav item",
+          "docs": "Sets focus on the nav item.",
           "docsTags": []
         }
       ],
@@ -4356,7 +4373,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the nav item",
+          "docs": "Sets focus on the nav item.",
           "docsTags": []
         }
       ],
@@ -4827,6 +4844,28 @@
           "optional": false,
           "required": true
         },
+        {
+          "name": "orientation",
+          "type": "\"horizontal\" | \"vertical\"",
+          "mutable": true,
+          "attr": "orientation",
+          "reflectToAttr": true,
+          "docs": "The orientation of the radio buttons in the radio group. If there are more than two radio buttons in a radio group or either of the radio buttons use the `additional-field` slot, then the orientation will always be vertical.",
+          "docsTags": [],
+          "default": "\"vertical\"",
+          "values": [
+            {
+              "value": "horizontal",
+              "type": "string"
+            },
+            {
+              "value": "vertical",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "required",
           "type": "boolean",
@@ -5095,7 +5134,19 @@
           "required": true
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the radio option.",
+          "docsTags": []
+        }
+      ],
       "events": [
         {
           "event": "icCheck",
@@ -5768,7 +5819,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the native `input`",
+          "docs": "Sets focus on the native `input`.",
           "docsTags": []
         }
       ],
@@ -5886,16 +5937,6 @@
           "event": "keyup",
           "capture": false,
           "passive": false
-        },
-        {
-          "event": "icMenuStateChange",
-          "capture": false,
-          "passive": false
-        },
-        {
-          "event": "menuOptionId",
-          "capture": false,
-          "passive": false
         }
       ],
       "styles": [],
@@ -6052,6 +6093,40 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "debounce",
+          "type": "number",
+          "mutable": false,
+          "attr": "debounce",
+          "reflectToAttr": false,
+          "docs": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
+          "docsTags": [],
+          "default": "0",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "disableFilter",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disable-filter",
+          "reflectToAttr": false,
+          "docs": "Specify whether to disable the built in filtering for a searchable variant. For example, if options will already be filtered from external source.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -6143,7 +6218,7 @@
           "mutable": false,
           "attr": "include-descriptions-in-search",
           "reflectToAttr": false,
-          "docs": "If `true`, descriptions of options will be included when filtering options in a searchable select.",
+          "docs": "If `true`, descriptions of options will be included when filtering options in a searchable select. Only applies to built in filtering.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -6160,7 +6235,7 @@
           "mutable": false,
           "attr": "include-group-titles-in-search",
           "reflectToAttr": false,
-          "docs": "If `true`, group titles of grouped options will be included when filtering options in a searchable select.",
+          "docs": "If `true`, group titles of grouped options will be included when filtering options in a searchable select. Only applies to built in filtering.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -6277,7 +6352,7 @@
           "mutable": false,
           "attr": "search-match-position",
           "reflectToAttr": false,
-          "docs": "Whether the search string of the searchable select should match the start of or anywhere in the options.",
+          "docs": "Whether the search string of the searchable select should match the start of or anywhere in the options. Only applies to built in filtering.",
           "docsTags": [],
           "default": "\"anywhere\"",
           "values": [
@@ -6427,7 +6502,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when select has blur.",
+          "docs": "Emitted when select loses focus.",
           "docsTags": []
         },
         {
@@ -6436,7 +6511,16 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when a value is selected.",
+          "docs": "Emitted when the value changes.",
+          "docsTags": []
+        },
+        {
+          "event": "icClear",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when clear button clicked.",
           "docsTags": []
         },
         {
@@ -6445,7 +6529,25 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when select has focus.",
+          "docs": "Emitted when select gains focus.",
+          "docsTags": []
+        },
+        {
+          "event": "icInput",
+          "detail": "IcValueEventDetail",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when a keyboard input occurred.",
+          "docsTags": []
+        },
+        {
+          "event": "icOptionSelect",
+          "detail": "IcOptionSelectEventDetail",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when option is highlighted within the menu.",
           "docsTags": []
         }
       ],
@@ -6511,6 +6613,10 @@
           "name": "slot",
           "text": "app-icon - Content will be rendered adjacent to the app title at the very top of the side navigation."
         },
+        {
+          "name": "slot",
+          "text": "app-title - Handle routing by nesting a route in the app title."
+        },
         {
           "name": "slot",
           "text": "primary-navigation - Content will be rendered at the top of the side navigation."
@@ -6528,7 +6634,7 @@
           "mutable": false,
           "attr": "app-title",
           "reflectToAttr": false,
-          "docs": "The title of the app to be displayed.",
+          "docs": "The app title to be displayed. This is required, unless a slotted app title link is used.",
           "docsTags": [],
           "values": [
             {
@@ -6536,7 +6642,7 @@
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
           "name": "collapsedIconLabels",
@@ -6672,6 +6778,10 @@
           "name": "app-icon",
           "docs": "Content will be rendered adjacent to the app title at the very top of the side navigation."
         },
+        {
+          "name": "app-title",
+          "docs": "Handle routing by nesting a route in the app title."
+        },
         {
           "name": "primary-navigation",
           "docs": "Content will be rendered at the top of the side navigation."
@@ -7276,7 +7386,19 @@
           "required": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the switch.",
+          "docsTags": []
+        }
+      ],
       "events": [
         {
           "event": "icBlur",
@@ -7362,7 +7484,19 @@
           "required": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the tab.",
+          "docsTags": []
+        }
+      ],
       "events": [],
       "listeners": [],
       "styles": [],
@@ -8382,7 +8516,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the native `input`",
+          "docs": "Sets focus on the native `input`.",
           "docsTags": []
         }
       ],
@@ -8685,6 +8819,10 @@
           "name": "slot",
           "text": "app-icon - Content will be rendered to left of app title."
         },
+        {
+          "name": "slot",
+          "text": "app-title - Handle routing by nesting a route in the app title."
+        },
         {
           "name": "slot",
           "text": "search - Content will be rendered in search area to left of buttons."
@@ -8710,7 +8848,7 @@
           "mutable": false,
           "attr": "app-title",
           "reflectToAttr": false,
-          "docs": "The app title to be displayed.",
+          "docs": "The app title to be displayed. This is required, unless a slotted app title link is used.",
           "docsTags": [],
           "values": [
             {
@@ -8718,7 +8856,7 @@
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
           "name": "contentAligned",
@@ -8846,6 +8984,10 @@
           "name": "app-icon",
           "docs": "Content will be rendered to left of app title."
         },
+        {
+          "name": "app-title",
+          "docs": "Handle routing by nesting a route in the app title."
+        },
         {
           "name": "buttons",
           "docs": "Content will be rendered to right of search bar."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukic/docs",
-  "version": "2.1.0-beta.6",
+  "version": "2.1.0-beta.8",
   "description": "API documentation for @ukic components",
   "main": "docs.json",
   "types": "docs.d.ts",
@@ -9,5 +9,5 @@
     "docs.d.ts"
   ],
   "license": "MIT",
-  "gitHead": "96e96337cfb37e1ee1a9fdfedb09d3923f4e0d2a"
+  "gitHead": "20d7df2ba2c281735d96b667a3e037568443cdf8"
 }