@ukic/docs 2.9.4 → 2.10.0

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2024-02-28T15:28:24",
+  "timestamp": "2024-03-18T10:40:36",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.10.0",
@@ -207,6 +207,28 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "accessibleButtonLabel",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "accessible-button-label",
+          "reflectToAttr": false,
+          "docs": "The accessible button label to provide more context to the 'See all/Hide all' button for screen reader users.",
+          "docsTags": [],
+          "default": "\"accordions\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "appearance",
           "type": "\"dark\" | \"default\" | \"light\"",
@@ -1331,6 +1353,10 @@
         {
           "name": "slot",
           "text": "badge - Badge component overlaying the top right of the button."
+        },
+        {
+          "name": "slot",
+          "text": "router-item - Handle routing by nesting your routes in this slot. Setting loading to true will have no impact on this slot."
         }
       ],
       "usage": {},
@@ -2208,6 +2234,10 @@
           "name": "right-icon",
           "docs": "Content will be placed to the right of the button label."
         },
+        {
+          "name": "router-item",
+          "docs": "Handle routing by nesting your routes in this slot. Setting loading to true will have no impact on this slot."
+        },
         {
           "name": "top-icon",
           "docs": "Content will be placed above the button label."
@@ -2217,7 +2247,6 @@
       "dependents": [
         "ic-accordion-group",
         "ic-alert",
-        "ic-card",
         "ic-dialog",
         "ic-horizontal-scroll",
         "ic-menu",
@@ -2253,9 +2282,6 @@
         "ic-alert": [
           "ic-button"
         ],
-        "ic-card": [
-          "ic-button"
-        ],
         "ic-dialog": [
           "ic-button"
         ],
@@ -2736,20 +2762,13 @@
       "dependents": [],
       "dependencies": [
         "ic-typography",
-        "ic-button"
+        "ic-tooltip"
       ],
       "dependencyGraph": {
         "ic-card": [
           "ic-typography",
-          "ic-button"
-        ],
-        "ic-button": [
-          "ic-loading-indicator",
           "ic-tooltip"
         ],
-        "ic-loading-indicator": [
-          "ic-typography"
-        ],
         "ic-tooltip": [
           "ic-typography"
         ]
@@ -6275,15 +6294,15 @@
         },
         {
           "name": "size",
-          "type": "\"default\" | \"small\"",
+          "type": "\"default\" | \"large\" | \"small\"",
           "complexType": {
-            "original": "IcSizesNoLarge",
-            "resolved": "\"default\" | \"small\"",
+            "original": "IcSizes",
+            "resolved": "\"default\" | \"large\" | \"small\"",
             "references": {
-              "IcSizesNoLarge": {
+              "IcSizes": {
                 "location": "import",
                 "path": "../../utils/types",
-                "id": "src/utils/types.ts::IcSizesNoLarge"
+                "id": "src/utils/types.ts::IcSizes"
               }
             }
           },
@@ -6298,6 +6317,10 @@
               "value": "default",
               "type": "string"
             },
+            {
+              "value": "large",
+              "type": "string"
+            },
             {
               "value": "small",
               "type": "string"
@@ -7817,15 +7840,15 @@
         },
         {
           "name": "size",
-          "type": "\"default\" | \"small\"",
+          "type": "\"default\" | \"large\" | \"small\"",
           "complexType": {
-            "original": "IcSizesNoLarge",
-            "resolved": "\"default\" | \"small\"",
+            "original": "IcSizes",
+            "resolved": "\"default\" | \"large\" | \"small\"",
             "references": {
-              "IcSizesNoLarge": {
+              "IcSizes": {
                 "location": "import",
                 "path": "../../utils/types",
-                "id": "src/utils/types.ts::IcSizesNoLarge"
+                "id": "src/utils/types.ts::IcSizes"
               }
             }
           },
@@ -7840,6 +7863,10 @@
               "value": "default",
               "type": "string"
             },
+            {
+              "value": "large",
+              "type": "string"
+            },
             {
               "value": "small",
               "type": "string"
@@ -10280,7 +10307,6 @@
         },
         {
           "event": "keydown",
-          "target": "document",
           "capture": false,
           "passive": false
         }
@@ -11717,7 +11743,7 @@
           "mutable": true,
           "attr": "loading",
           "reflectToAttr": false,
-          "docs": "Trigger loading state when fetching options asyncronously",
+          "docs": "Trigger loading state when fetching options asynchronously",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -12872,7 +12898,7 @@
           "mutable": true,
           "attr": "loading",
           "reflectToAttr": false,
-          "docs": "If `true`, the loading state will be triggered when fetching options asyncronously.",
+          "docs": "If `true`, the loading state will be triggered when fetching options asynchronously.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -13143,15 +13169,15 @@
         },
         {
           "name": "size",
-          "type": "\"default\" | \"small\"",
+          "type": "\"default\" | \"large\" | \"small\"",
           "complexType": {
-            "original": "IcSizesNoLarge",
-            "resolved": "\"default\" | \"small\"",
+            "original": "IcSizes",
+            "resolved": "\"default\" | \"large\" | \"small\"",
             "references": {
-              "IcSizesNoLarge": {
+              "IcSizes": {
                 "location": "import",
                 "path": "../../utils/types",
-                "id": "src/utils/types.ts::IcSizesNoLarge"
+                "id": "src/utils/types.ts::IcSizes"
               }
             }
           },
@@ -13166,6 +13192,10 @@
               "value": "default",
               "type": "string"
             },
+            {
+              "value": "large",
+              "type": "string"
+            },
             {
               "value": "small",
               "type": "string"
@@ -13380,6 +13410,20 @@
           "docs": "Emitted when the clear button is clicked.",
           "docsTags": []
         },
+        {
+          "event": "icClose",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the select options menu is closed.",
+          "docsTags": []
+        },
         {
           "event": "icFocus",
           "detail": "void",
@@ -13414,6 +13458,20 @@
           "docs": "Emitted when a keyboard input occurred.",
           "docsTags": []
         },
+        {
+          "event": "icOpen",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the select options menu is opened.",
+          "docsTags": []
+        },
         {
           "event": "icOptionSelect",
           "detail": "IcOptionSelectEventDetail",
@@ -17232,6 +17290,338 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/ic-toggle-button-group/ic-toggle-button-group.tsx",
+      "encapsulation": "shadow",
+      "tag": "ic-toggle-button-group",
+      "readme": "# ic-toggle-button-group\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "accessibleLabel",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "accessible-label",
+          "reflectToAttr": false,
+          "docs": "The accessible label of the toggle button group component to provide context for screen reader users.",
+          "docsTags": [],
+          "default": "\"Toggle button group\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "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 toggle button group, e.g dark, or light.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": false,
+          "docs": "If `true`, the toggle button group will be set to the disabled state.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "fullWidth",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "full-width",
+          "reflectToAttr": false,
+          "docs": "If `true`, the toggle button group will fill the width of the container.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "iconPlacement",
+          "type": "\"left\" | \"right\" | \"top\"",
+          "complexType": {
+            "original": "\"left\" | \"right\" | \"top\"",
+            "resolved": "\"left\" | \"right\" | \"top\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "icon-placement",
+          "reflectToAttr": false,
+          "docs": "The placement of the icons in relation to the toggle button labels.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "loading",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "loading",
+          "reflectToAttr": false,
+          "docs": "If `true`, the toggle button group will be in loading state.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "selectMethod",
+          "type": "\"auto\" | \"manual\"",
+          "complexType": {
+            "original": "IcSelectMethodTypes",
+            "resolved": "\"auto\" | \"manual\"",
+            "references": {
+              "IcSelectMethodTypes": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcSelectMethodTypes"
+              }
+            }
+          },
+          "mutable": true,
+          "attr": "select-method",
+          "reflectToAttr": false,
+          "docs": "If `auto`, controls are toggled automatically when navigated to. If `manual`, the controls must be actioned to change their toggled state. The value of this prop is ignored if `selectType` is set to`multi`.",
+          "docsTags": [],
+          "default": "\"manual\"",
+          "values": [
+            {
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "manual",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "selectType",
+          "type": "\"multi\" | \"single\"",
+          "complexType": {
+            "original": "IcSelectTypes",
+            "resolved": "\"multi\" | \"single\"",
+            "references": {
+              "IcSelectTypes": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcSelectTypes"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "select-type",
+          "reflectToAttr": false,
+          "docs": "Sets whether single or multiple options can be toggled. If `multi`, then the `selectMethod` is always `manual`.",
+          "docsTags": [],
+          "default": "\"single\"",
+          "values": [
+            {
+              "value": "multi",
+              "type": "string"
+            },
+            {
+              "value": "single",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "size",
+          "type": "\"default\" | \"large\" | \"small\"",
+          "complexType": {
+            "original": "IcSizes",
+            "resolved": "\"default\" | \"large\" | \"small\"",
+            "references": {
+              "IcSizes": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcSizes"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "size",
+          "reflectToAttr": false,
+          "docs": "The size of the toggle buttons to be displayed. This does not affect the font size of the accessible label.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "large",
+              "type": "string"
+            },
+            {
+              "value": "small",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "variant",
+          "type": "\"default\" | \"icon\"",
+          "complexType": {
+            "original": "\"default\" | \"icon\"",
+            "resolved": "\"default\" | \"icon\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "variant",
+          "reflectToAttr": true,
+          "docs": "The variant of the toggle button.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "icon",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "icChange",
+          "detail": "IcChangeEventDetail",
+          "bubbles": true,
+          "complexType": {
+            "original": "IcChangeEventDetail",
+            "resolved": "IcChangeEventDetail",
+            "references": {
+              "IcChangeEventDetail": {
+                "location": "import",
+                "path": "./ic-toggle-button-group.types",
+                "id": "src/components/ic-toggle-button-group/ic-toggle-button-group.types.ts::IcChangeEventDetail"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when a toggle button is selected.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "icToggleChecked",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "src/components/ic-tooltip/ic-tooltip.tsx",
       "encapsulation": "shadow",
@@ -17468,6 +17858,7 @@
       "parts": [],
       "dependents": [
         "ic-button",
+        "ic-card",
         "ic-chip",
         "ic-navigation-item"
       ],
@@ -17481,6 +17872,9 @@
         "ic-button": [
           "ic-tooltip"
         ],
+        "ic-card": [
+          "ic-tooltip"
+        ],
         "ic-chip": [
           "ic-tooltip"
         ],
@@ -18502,6 +18896,21 @@
       "declaration": "{\n  mode: IcThemeForeground;\n  color: IcColorRGB;\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
+    },
+    "src/utils/types.ts::IcSelectMethodTypes": {
+      "declaration": "export type IcSelectMethodTypes = \"auto\" | \"manual\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
+    "src/utils/types.ts::IcSelectTypes": {
+      "declaration": "export type IcSelectTypes = \"single\" | \"multi\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
+    "src/components/ic-toggle-button-group/ic-toggle-button-group.types.ts::IcChangeEventDetail": {
+      "declaration": "export interface IcChangeEventDetail {\n  toggleChecked: boolean[] | boolean;\n  toggledOptions?: {\n    toggleButton: HTMLIcToggleButtonElement;\n  }[];\n  selectedOption: HTMLIcToggleButtonElement;\n}",
+      "docstring": "",
+      "path": "src/components/ic-toggle-button-group/ic-toggle-button-group.types.ts"
     }
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "2.9.4",
+  "version": "2.10.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": "851d7863c504a1890a0d1a09f4bc8dbd5c94a4ba"
+  "gitHead": "58d6040e80a2fe1ca1feeca8e203130e2c59ff29"
 }