@ukic/docs 2.6.0 → 2.8.0

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-11-06T14:24:06",
+  "timestamp": "2023-12-08T14:47:48",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.3.0",
@@ -697,7 +697,12 @@
       "tag": "ic-badge",
       "readme": "# ic-badge\n\n\n",
       "docs": "",
-      "docsTags": [],
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "badge-icon - Icon will be rendered inside the badge if type is set to icon."
+        }
+      ],
       "usage": {},
       "props": [
         {
@@ -969,7 +974,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "visible",
           "reflectToAttr": false,
           "docs": "If `true`, the badge will be displayed.",
@@ -1045,7 +1050,12 @@
       "events": [],
       "listeners": [],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "badge-icon",
+          "docs": "Icon will be rendered inside the badge if type is set to icon."
+        }
+      ],
       "parts": [],
       "dependents": [],
       "dependencies": [
@@ -3282,6 +3292,11 @@
         }
       ],
       "listeners": [
+        {
+          "event": "icChange",
+          "capture": false,
+          "passive": false
+        },
         {
           "event": "icCheck",
           "capture": false,
@@ -4200,6 +4215,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "disableHeightConstraint",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "disable-height-constraint",
+          "reflectToAttr": false,
+          "docs": "If set to `true`, the content area max height and overflow properties are removed allowing the dialog to stretch below the fold.\nThis prop also prevents popover elements from being cut off within the content area.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "dismissLabel",
           "type": "string",
@@ -4243,6 +4280,28 @@
           "optional": false,
           "required": true
         },
+        {
+          "name": "hideCloseButton",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "hide-close-button",
+          "reflectToAttr": false,
+          "docs": "If `true`, the close button will not be displayed.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "label",
           "type": "string",
@@ -12713,6 +12772,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "selectOnEnter",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "select-on-enter",
+          "reflectToAttr": false,
+          "docs": "If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "showClearButton",
           "type": "boolean",
@@ -16243,39 +16324,7 @@
           "required": false
         }
       ],
-      "methods": [
-        {
-          "name": "setVisible",
-          "returns": {
-            "type": "Promise<HTMLElement>",
-            "docs": "The element that previously had focus before the toast appeared"
-          },
-          "complexType": {
-            "signature": "() => Promise<HTMLElement>",
-            "parameters": [],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              },
-              "HTMLElement": {
-                "location": "global",
-                "id": "global::HTMLElement"
-              }
-            },
-            "return": "Promise<HTMLElement>"
-          },
-          "signature": "setVisible() => Promise<HTMLElement>",
-          "parameters": [],
-          "docs": "Used to display the individual toast",
-          "docsTags": [
-            {
-              "name": "returns",
-              "text": "The element that previously had focus before the toast appeared"
-            }
-          ]
-        }
-      ],
+      "methods": [],
       "events": [
         {
           "event": "icDismiss",
@@ -16365,7 +16414,33 @@
       "docs": "",
       "docsTags": [],
       "usage": {},
-      "props": [],
+      "props": [
+        {
+          "name": "openToast",
+          "type": "HTMLIcToastElement",
+          "complexType": {
+            "original": "HTMLIcToastElement",
+            "resolved": "HTMLIcToastElement",
+            "references": {
+              "HTMLIcToastElement": {
+                "location": "global",
+                "id": "global::HTMLIcToastElement"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The toast element to be displayed.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "HTMLIcToastElement"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
       "methods": [
         {
           "name": "setVisible",
@@ -16377,13 +16452,8 @@
             "signature": "(toast: HTMLIcToastElement) => Promise<void>",
             "parameters": [
               {
-                "tags": [
-                  {
-                    "name": "param",
-                    "text": "toast The toast element being requested to display"
-                  }
-                ],
-                "text": "The toast element being requested to display"
+                "tags": [],
+                "text": ""
               }
             ],
             "references": {
@@ -16400,13 +16470,14 @@
           },
           "signature": "setVisible(toast: HTMLIcToastElement) => Promise<void>",
           "parameters": [],
-          "docs": "Handles setting the visibility of various toasts based on what is already visible",
+          "docs": "",
           "docsTags": [
             {
-              "name": "param",
-              "text": "toast The toast element being requested to display"
+              "name": "deprecated",
+              "text": "Use openToast prop to display toast instead."
             }
-          ]
+          ],
+          "deprecation": "Use openToast prop to display toast instead."
         }
       ],
       "events": [],
@@ -16693,6 +16764,10 @@
           "name": "slot",
           "text": "app-title - Handle routing by nesting a route in the app title."
         },
+        {
+          "name": "slot",
+          "text": "short-app-title - Handle routing by nesting a route in the short app title (to be displayed in place of app title on small screen sizes)."
+        },
         {
           "name": "slot",
           "text": "search - Content will be rendered in search area to left of buttons."
@@ -16928,6 +17003,10 @@
           "name": "search",
           "docs": "Content will be rendered in search area to left of buttons."
         },
+        {
+          "name": "short-app-title",
+          "docs": "Handle routing by nesting a route in the short app title (to be displayed in place of app title on small screen sizes)."
+        },
         {
           "name": "toggle-icon",
           "docs": "Icon to be displayed on the button to toggle search slot content on smaller devices"

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "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": "c4b3058fa6214a35f235af25250c85c7f8aeb9da"
+  "gitHead": "a26d1fa51a4723de8c43302ee54dc897700a0b0a"
 }