@ukic/docs 3.0.0-alpha.6 → 3.0.0-alpha.8

package/docs.json

@@ -6780,11 +6780,15 @@
       ],
       "parts": [],
       "dependents": [
+        "ic-search-bar",
         "ic-select",
         "ic-text-field"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "ic-search-bar": [
+          "ic-input-component-container"
+        ],
         "ic-select": [
           "ic-input-component-container"
         ],
@@ -6854,11 +6858,15 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "ic-search-bar",
         "ic-select",
         "ic-text-field"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "ic-search-bar": [
+          "ic-input-container"
+        ],
         "ic-select": [
           "ic-input-container"
         ],
@@ -7064,6 +7072,7 @@
       "dependents": [
         "ic-checkbox-group",
         "ic-radio-group",
+        "ic-search-bar",
         "ic-select",
         "ic-switch",
         "ic-text-field"
@@ -7081,6 +7090,9 @@
         "ic-radio-group": [
           "ic-input-label"
         ],
+        "ic-search-bar": [
+          "ic-input-label"
+        ],
         "ic-select": [
           "ic-input-label"
         ],
@@ -8330,7 +8342,22 @@
           ]
         }
       ],
-      "events": [],
+      "events": [
+        {
+          "event": "icClear",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the clear all button is clicked.",
+          "docsTags": []
+        }
+      ],
       "listeners": [],
       "styles": [
         {
@@ -12682,6 +12709,25 @@
           "docs": "Emitted when a keyboard input occurred.",
           "docsTags": []
         },
+        {
+          "event": "icKeydown",
+          "detail": "{ event: KeyboardEvent; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ event: KeyboardEvent }",
+            "resolved": "{ event: KeyboardEvent; }",
+            "references": {
+              "KeyboardEvent": {
+                "location": "global",
+                "id": "global::KeyboardEvent"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when a keydown event occurred.",
+          "docsTags": []
+        },
         {
           "event": "icMenuChange",
           "detail": "IcMenuChangeEventDetail",
@@ -12805,7 +12851,7 @@
       ],
       "listeners": [
         {
-          "event": "icKeydown",
+          "event": "keydown",
           "capture": false,
           "passive": false
         },
@@ -12826,29 +12872,23 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "ic-text-field",
+        "ic-input-container",
+        "ic-input-label",
+        "ic-input-component-container",
         "ic-button",
         "ic-menu"
       ],
       "dependencyGraph": {
         "ic-search-bar": [
-          "ic-text-field",
-          "ic-button",
-          "ic-menu"
-        ],
-        "ic-text-field": [
           "ic-input-container",
           "ic-input-label",
           "ic-input-component-container",
-          "ic-input-validation",
-          "ic-typography"
+          "ic-button",
+          "ic-menu"
         ],
         "ic-input-label": [
           "ic-typography"
         ],
-        "ic-input-validation": [
-          "ic-typography"
-        ],
         "ic-button": [
           "ic-loading-indicator",
           "ic-tooltip"
@@ -12992,7 +13032,7 @@
           "mutable": false,
           "attr": "debounce",
           "reflectToAttr": false,
-          "docs": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
+          "docs": "The amount of time, in milliseconds, to wait to trigger the `icInput` event after each keystroke.",
           "docsTags": [],
           "default": "0",
           "values": [
@@ -13775,7 +13815,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when the clear button is clicked.",
+          "docs": "Emitted when the clear or clear all button is clicked.",
           "docsTags": []
         },
         {
@@ -16870,9 +16910,7 @@
         }
       ],
       "parts": [],
-      "dependents": [
-        "ic-search-bar"
-      ],
+      "dependents": [],
       "dependencies": [
         "ic-input-container",
         "ic-input-label",
@@ -16893,9 +16931,6 @@
         ],
         "ic-input-validation": [
           "ic-typography"
-        ],
-        "ic-search-bar": [
-          "ic-text-field"
         ]
       }
     },
@@ -17389,7 +17424,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "disabled",
           "reflectToAttr": false,
           "docs": "If `true`, the toggle button will be in disabled state.",
@@ -17411,7 +17446,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "full-width",
           "reflectToAttr": false,
           "docs": "If `true`, the toggle button will fill the width of the container.",
@@ -17429,15 +17464,22 @@
           "name": "iconPlacement",
           "type": "\"left\" | \"right\" | \"top\"",
           "complexType": {
-            "original": "\"left\" | \"right\" | \"top\"",
+            "original": "IcIconPlacementOptions",
             "resolved": "\"left\" | \"right\" | \"top\"",
-            "references": {}
+            "references": {
+              "IcIconPlacementOptions": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcIconPlacementOptions"
+              }
+            }
           },
           "mutable": false,
           "attr": "icon-placement",
           "reflectToAttr": false,
           "docs": "The placement of the icon in relation to the toggle button label.",
           "docsTags": [],
+          "default": "\"left\"",
           "values": [
             {
               "value": "left",
@@ -17484,7 +17526,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "loading",
           "reflectToAttr": false,
           "docs": "If `true`, the toggle button will be in loading state.",
@@ -17506,7 +17548,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "monochrome",
           "reflectToAttr": false,
           "docs": "If `true`, the toggle button will display as black in the light theme, and white in dark theme.",
@@ -17534,7 +17576,7 @@
               }
             }
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "size",
           "reflectToAttr": false,
           "docs": "The size of the toggle button to be displayed.",
@@ -17571,7 +17613,7 @@
               }
             }
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "theme",
           "reflectToAttr": false,
           "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
@@ -17602,7 +17644,7 @@
             "resolved": "\"default\" | \"icon\"",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "variant",
           "reflectToAttr": true,
           "docs": "The variant of the toggle button.",
@@ -19478,6 +19520,11 @@
       "docstring": "",
       "path": "src/utils/types.ts"
     },
+    "src/utils/types.ts::IcIconPlacementOptions": {
+      "declaration": "export type IcIconPlacementOptions = \"left\" | \"right\" | \"top\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
     "src/utils/types.ts::IcSelectMethodTypes": {
       "declaration": "export type IcSelectMethodTypes = \"auto\" | \"manual\";",
       "docstring": "",

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-alpha.8",
   "description": "API documentation for @ukic components",
   "main": "docs.json",
   "types": "docs.d.ts",
@@ -18,5 +18,5 @@
     "email": "icds@gchq.gov.uk"
   },
   "license": "MIT",
-  "gitHead": "d12d44ce767e650601d380df6d5ce1b0d8fb78fb"
+  "gitHead": "aadff337c20cb1dee5e221f7e88179dc8242789e"
 }