@ukic/docs 2.8.0 → 2.9.1

package/docs.d.ts

@@ -60,30 +60,10 @@ interface ComponentCompilerEventComplexType {
 }
 interface ComponentCompilerMethodComplexType {
   signature: string;
-  parameters: CompilerJsDoc[];
+  parameters: JsonDocMethodParameter[];
   references: ComponentCompilerTypeReferences;
   return: string;
 }
-interface CompilerJsDoc {
-  /**
-   * The text associated with the JSDoc
-   */
-  text: string;
-  /**
-   * Tags included in the JSDoc
-   */
-  tags: CompilerJsDocTagInfo[];
-}
-interface CompilerJsDocTagInfo {
-  /**
-   * The name of the tag - e.g. `@deprecated`
-   */
-  name: string;
-  /**
-   * Additional text that is associated with the tag - e.g. `@deprecated use v2 of this API`
-   */
-  text?: string;
-}
 /**
  * The Type Library holds information about the types which are used in a
  * Stencil project. During compilation, Stencil gathers information about the

package/docs.json

@@ -1,9 +1,9 @@
 {
-  "timestamp": "2023-12-08T14:47:48",
+  "timestamp": "2024-01-22T11:57:10",
   "compiler": {
     "name": "@stencil/core",
-    "version": "4.3.0",
-    "typescriptVersion": "5.1.6"
+    "version": "4.9.0",
+    "typescriptVersion": "5.2.2"
   },
   "components": [
     {
@@ -1204,6 +1204,43 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "appearance",
+          "type": "\"dark\" | \"default\" | \"light\"",
+          "complexType": {
+            "original": "IcThemeForeground",
+            "resolved": "\"dark\" | \"default\" | \"light\"",
+            "references": {
+              "IcThemeForeground": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcThemeForeground"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "appearance",
+          "reflectToAttr": false,
+          "docs": "The appearance of the breadcrumb group.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "backBreadcrumbOnly",
           "type": "boolean",
@@ -1400,6 +1437,50 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "dropdown",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "dropdown",
+          "reflectToAttr": false,
+          "docs": "If `true`, the button will show a dropdown icon.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "dropdownExpanded",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "dropdown-expanded",
+          "reflectToAttr": true,
+          "docs": "If `true`, the aria-expanded value will be set to true. This is only applied if the dropdown prop is also true.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "form",
           "type": "string",
@@ -1790,6 +1871,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "transparentBackground",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "transparent-background",
+          "reflectToAttr": false,
+          "docs": "If `true`, the secondary variant of button will have a transparent background rather than white.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "type",
           "type": "\"button\" | \"reset\" | \"submit\"",
@@ -3482,6 +3585,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "transparentBackground",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "transparent-background",
+          "reflectToAttr": false,
+          "docs": "If `true`, the outlined variant of chip will have a transparent background rather than white.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "variant",
           "type": "\"filled\" | \"outlined\"",
@@ -7233,7 +7358,12 @@
         }
       ],
       "slots": [],
-      "parts": [],
+      "parts": [
+        {
+          "name": "ic-loading-container",
+          "docs": ""
+        }
+      ],
       "dependents": [
         "ic-button",
         "ic-menu",
@@ -7635,13 +7765,9 @@
             "signature": "(event: KeyboardEvent) => Promise<void>",
             "parameters": [
               {
-                "tags": [
-                  {
-                    "name": "param",
-                    "text": "event - keyboard event"
-                  }
-                ],
-                "text": "- keyboard event"
+                "name": "event",
+                "type": "KeyboardEvent",
+                "docs": "The keyboard event which is available when handleKeyboardOpen is invoked."
               }
             ],
             "references": {
@@ -7657,12 +7783,18 @@
             "return": "Promise<void>"
           },
           "signature": "handleKeyboardOpen(event: KeyboardEvent) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "event",
+              "type": "KeyboardEvent",
+              "docs": "The keyboard event which is available when handleKeyboardOpen is invoked."
+            }
+          ],
           "docs": "Used alongside activationType\nIf menu is opened via keyboard navigation (i.e. Enter, ArrowUp or ArrowDown), emit optionSelect custom event.",
           "docsTags": [
             {
               "name": "param",
-              "text": "event - keyboard event"
+              "text": "event The keyboard event which is available when handleKeyboardOpen is invoked."
             }
           ]
         }
@@ -9552,8 +9684,9 @@
             "signature": "(page: number) => Promise<void>",
             "parameters": [
               {
-                "tags": [],
-                "text": ""
+                "name": "page",
+                "type": "number",
+                "docs": "The page number to set as the current page"
               }
             ],
             "references": {
@@ -9565,9 +9698,20 @@
             "return": "Promise<void>"
           },
           "signature": "setCurrentPage(page: number) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "page",
+              "type": "number",
+              "docs": "The page number to set as the current page"
+            }
+          ],
           "docs": "Sets the currently displayed page.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "page The page number to set as the current page"
+            }
+          ]
         }
       ],
       "events": [
@@ -9935,7 +10079,22 @@
         }
       ],
       "methods": [],
-      "events": [],
+      "events": [
+        {
+          "event": "icPopoverClosed",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the popover menu is closed.",
+          "docsTags": []
+        }
+      ],
       "listeners": [
         {
           "event": "handleMenuItemClick",
@@ -13433,7 +13592,28 @@
         }
       ],
       "methods": [],
-      "events": [],
+      "events": [
+        {
+          "event": "sideNavExpanded",
+          "detail": "IcExpandedDetail",
+          "bubbles": true,
+          "complexType": {
+            "original": "IcExpandedDetail",
+            "resolved": "IcExpandedDetail",
+            "references": {
+              "IcExpandedDetail": {
+                "location": "import",
+                "path": "./ic-side-navigation.types",
+                "id": "src/components/ic-side-navigation/ic-side-navigation.types.ts::IcExpandedDetail"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the side navigation is collapsed and expanded.",
+          "docsTags": []
+        }
+      ],
       "listeners": [
         {
           "event": "themeChange",
@@ -16452,8 +16632,9 @@
             "signature": "(toast: HTMLIcToastElement) => Promise<void>",
             "parameters": [
               {
-                "tags": [],
-                "text": ""
+                "name": "toast",
+                "type": "HTMLIcToastElement",
+                "docs": "The toast component to display"
               }
             ],
             "references": {
@@ -16469,12 +16650,22 @@
             "return": "Promise<void>"
           },
           "signature": "setVisible(toast: HTMLIcToastElement) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "toast",
+              "type": "HTMLIcToastElement",
+              "docs": "The toast component to display"
+            }
+          ],
           "docs": "",
           "docsTags": [
             {
               "name": "deprecated",
               "text": "Use openToast prop to display toast instead."
+            },
+            {
+              "name": "param",
+              "text": "toast The toast component to display"
             }
           ],
           "deprecation": "Use openToast prop to display toast instead."
@@ -16585,7 +16776,7 @@
           "mutable": true,
           "attr": "placement",
           "reflectToAttr": false,
-          "docs": "The position of the tool-tip in relation to the parent element.",
+          "docs": "The position of the tooltip in relation to the parent element.",
           "docsTags": [],
           "default": "\"bottom\"",
           "values": [
@@ -16674,22 +16865,14 @@
             "signature": "(show: boolean, persistTooltip?: boolean) => Promise<void>",
             "parameters": [
               {
-                "tags": [
-                  {
-                    "name": "param",
-                    "text": "show Whether to show or hide the tooltip"
-                  }
-                ],
-                "text": "Whether to show or hide the tooltip"
+                "name": "show",
+                "type": "boolean",
+                "docs": "Whether to show or hide the tooltip"
               },
               {
-                "tags": [
-                  {
-                    "name": "param",
-                    "text": "persistTooltip Whether the tooltip should stay on the screen when actions are performed that would previously dismiss the tooltip, such as on hover"
-                  }
-                ],
-                "text": "Whether the tooltip should stay on the screen when actions are performed that would previously dismiss the tooltip, such as on hover"
+                "name": "persistTooltip",
+                "type": "boolean",
+                "docs": "Whether the tooltip should stay on the screen when actions are performed that would previously dismiss the tooltip, such as on hover"
               }
             ],
             "references": {
@@ -16701,7 +16884,18 @@
             "return": "Promise<void>"
           },
           "signature": "displayTooltip(show: boolean, persistTooltip?: boolean) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "show",
+              "type": "boolean",
+              "docs": "Whether to show or hide the tooltip"
+            },
+            {
+              "name": "persistTooltip",
+              "type": "boolean",
+              "docs": "Whether the tooltip should stay on the screen when actions are performed that would previously dismiss the tooltip, such as on hover"
+            }
+          ],
           "docs": "Method to programmatically show/hide the tooltip without needing to interact with an anchor element",
           "docsTags": [
             {
@@ -16957,7 +17151,22 @@
         }
       ],
       "methods": [],
-      "events": [],
+      "events": [
+        {
+          "event": "topNavResized",
+          "detail": "{ size: number; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ size: number }",
+            "resolved": "{ size: number; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the top navigation is resized.",
+          "docsTags": []
+        }
+      ],
       "listeners": [
         {
           "event": "icNavigationMenuClose",
@@ -17648,6 +17857,11 @@
       "docstring": "",
       "path": "src/components/ic-menu-item/ic-menu-item.types.ts"
     },
+    "src/components/ic-side-navigation/ic-side-navigation.types.ts::IcExpandedDetail": {
+      "declaration": "export interface IcExpandedDetail {\n  sideNavExpanded: boolean;\n  sideNavMobile: boolean;\n}",
+      "docstring": "",
+      "path": "src/components/ic-side-navigation/ic-side-navigation.types.ts"
+    },
     "src/components/ic-pagination/ic-pagination.types.ts::IcPaginationTypes": {
       "declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
       "docstring": "",

package/package.json

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