@ukic/docs 2.6.0 → 2.7.0

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-11-06T14:24:06",
+  "timestamp": "2023-11-17T09:08:20",
   "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": [
         {
@@ -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,
@@ -4243,6 +4258,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",
@@ -16243,39 +16280,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 +16370,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 +16408,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 +16426,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": [],

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "2.6.0",
+  "version": "2.7.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": "ec2153427bdc13034d87de99f502045cd04054d5"
 }