@ukic/docs 3.0.0-alpha.7 → 3.0.0-alpha.9

package/docs.json

@@ -2193,8 +2193,8 @@
             "references": {
               "IcButtonTooltipPlacement": {
                 "location": "import",
-                "path": "./ic-button.types",
-                "id": "src/components/ic-button/ic-button.types.ts::IcButtonTooltipPlacement"
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcButtonTooltipPlacement"
               }
             }
           },
@@ -14986,7 +14986,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "right-adornment - Content is placed to the right of switch before state label."
+          "text": "right-adornment - Content is placed to the right of switch."
         }
       ],
       "usage": {},
@@ -15122,28 +15122,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "showState",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "show-state",
-          "reflectToAttr": false,
-          "docs": "If `true`, the switch will render the On/Off state text.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "size",
           "type": "\"medium\" | \"small\"",
@@ -15316,19 +15294,17 @@
       "slots": [
         {
           "name": "right-adornment",
-          "docs": "Content is placed to the right of switch before state label."
+          "docs": "Content is placed to the right of switch."
         }
       ],
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "ic-input-label",
-        "ic-typography"
+        "ic-input-label"
       ],
       "dependencyGraph": {
         "ic-switch": [
-          "ic-input-label",
-          "ic-typography"
+          "ic-input-label"
         ],
         "ic-input-label": [
           "ic-typography"
@@ -17424,7 +17400,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "disabled",
           "reflectToAttr": false,
           "docs": "If `true`, the toggle button will be in disabled state.",
@@ -17446,7 +17422,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.",
@@ -17464,15 +17440,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",
@@ -17519,7 +17502,7 @@
             "resolved": "boolean",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "loading",
           "reflectToAttr": false,
           "docs": "If `true`, the toggle button will be in loading state.",
@@ -17541,7 +17524,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.",
@@ -17569,7 +17552,7 @@
               }
             }
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "size",
           "reflectToAttr": false,
           "docs": "The size of the toggle button to be displayed.",
@@ -17606,7 +17589,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.",
@@ -17629,6 +17612,47 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "tooltipPlacement",
+          "type": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+          "complexType": {
+            "original": "IcButtonTooltipPlacement",
+            "resolved": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+            "references": {
+              "IcButtonTooltipPlacement": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcButtonTooltipPlacement"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "tooltip-placement",
+          "reflectToAttr": false,
+          "docs": "The position of the tooltip in relation to the toggle button.",
+          "docsTags": [],
+          "default": "\"bottom\"",
+          "values": [
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "variant",
           "type": "\"default\" | \"icon\"",
@@ -17637,7 +17661,7 @@
             "resolved": "\"default\" | \"icon\"",
             "references": {}
           },
-          "mutable": false,
+          "mutable": true,
           "attr": "variant",
           "reflectToAttr": true,
           "docs": "The variant of the toggle button.",
@@ -18002,6 +18026,47 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "tooltipPlacement",
+          "type": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+          "complexType": {
+            "original": "IcButtonTooltipPlacement",
+            "resolved": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+            "references": {
+              "IcButtonTooltipPlacement": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcButtonTooltipPlacement"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "tooltip-placement",
+          "reflectToAttr": false,
+          "docs": "The position of the tooltip in relation to the toggle buttons.",
+          "docsTags": [],
+          "default": "\"bottom\"",
+          "values": [
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "variant",
           "type": "\"default\" | \"icon\"",
@@ -19068,7 +19133,6 @@
         "ic-side-navigation",
         "ic-status-tag",
         "ic-step",
-        "ic-switch",
         "ic-tab",
         "ic-text-field",
         "ic-toast",
@@ -19176,9 +19240,6 @@
         "ic-step": [
           "ic-typography"
         ],
-        "ic-switch": [
-          "ic-typography"
-        ],
         "ic-tab": [
           "ic-typography"
         ],
@@ -19233,10 +19294,10 @@
       "docstring": "",
       "path": "src/components/ic-footer/ic-footer.types.tsx"
     },
-    "src/components/ic-button/ic-button.types.ts::IcButtonTooltipPlacement": {
+    "src/utils/types.ts::IcButtonTooltipPlacement": {
       "declaration": "export type IcButtonTooltipPlacement = \"top\" | \"right\" | \"bottom\" | \"left\";",
       "docstring": "",
-      "path": "src/components/ic-button/ic-button.types.ts"
+      "path": "src/utils/types.ts"
     },
     "src/components/ic-button/ic-button.types.ts::IcButtonTypes": {
       "declaration": "export type IcButtonTypes = \"reset\" | \"submit\" | \"button\";",
@@ -19244,7 +19305,7 @@
       "path": "src/components/ic-button/ic-button.types.ts"
     },
     "src/components/ic-button/ic-button.types.ts::IcButtonVariants": {
-      "declaration": "export type IcButtonVariants =\r\n  | \"primary\"\r\n  | \"secondary\"\r\n  | \"tertiary\"\r\n  | \"destructive\"\r\n  | \"icon\"\r\n  | \"icon-primary\"\r\n  | \"icon-secondary\"\r\n  | \"icon-tertiary\"\r\n  | \"icon-destructive\";",
+      "declaration": "export type IcButtonVariants =\n  | \"primary\"\n  | \"secondary\"\n  | \"tertiary\"\n  | \"destructive\"\n  | \"icon\"\n  | \"icon-primary\"\n  | \"icon-secondary\"\n  | \"icon-tertiary\"\n  | \"icon-destructive\";",
       "docstring": "",
       "path": "src/components/ic-button/ic-button.types.ts"
     },
@@ -19333,6 +19394,36 @@
       "docstring": "",
       "path": "src/utils/types.ts"
     },
+    "src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
+      "declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
+      "docstring": "",
+      "path": "src/components/ic-search-bar/ic-search-bar.types.ts"
+    },
+    "src/utils/types.ts::IcMenuOption": {
+      "declaration": "export interface IcMenuOption {\r\n  description?: string;\r\n  disabled?: boolean;\r\n  recommended?: boolean;\r\n  children?: IcMenuOption[];\r\n  loading?: boolean;\r\n  timedOut?: boolean;\r\n  [key: string]: any;\r\n  element?: {\r\n    component: any;\r\n    ariaLabel: string;\r\n  };\r\n  icon?: any;\r\n}",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
+    "src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail": {
+      "declaration": "export interface IcOptionSelectEventDetail {\n  value: string;\n  label?: string;\n  optionId?: string;\n}",
+      "docstring": "",
+      "path": "src/components/ic-menu/ic-menu.types.ts"
+    },
+    "src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail": {
+      "declaration": "export interface IcMenuChangeEventDetail {\n  open: boolean;\n  focusInput?: boolean;\n}",
+      "docstring": "",
+      "path": "src/components/ic-menu/ic-menu.types.ts"
+    },
+    "src/utils/types.ts::IcBlurEventDetail": {
+      "declaration": "export interface IcBlurEventDetail {\r\n  relatedTarget: IcRelatedTarget;\r\n}",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
+    "src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarBlurEventDetail": {
+      "declaration": "export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {\n  relatedTarget: IcRelatedTarget;\n}",
+      "docstring": "",
+      "path": "src/components/ic-search-bar/ic-search-bar.types.ts"
+    },
     "src/components/ic-divider/ic-divider.types.tsx::IcDividerStyles": {
       "declaration": "export type IcDividerStyles = \"solid\" | \"dashed\";",
       "docstring": "",
@@ -19393,31 +19484,11 @@
       "docstring": "",
       "path": "src/utils/types.ts"
     },
-    "src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
-      "declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
-      "docstring": "",
-      "path": "src/components/ic-search-bar/ic-search-bar.types.ts"
-    },
-    "src/utils/types.ts::IcMenuOption": {
-      "declaration": "export interface IcMenuOption {\r\n  description?: string;\r\n  disabled?: boolean;\r\n  recommended?: boolean;\r\n  children?: IcMenuOption[];\r\n  loading?: boolean;\r\n  timedOut?: boolean;\r\n  [key: string]: any;\r\n  element?: {\r\n    component: any;\r\n    ariaLabel: string;\r\n  };\r\n  icon?: any;\r\n}",
-      "docstring": "",
-      "path": "src/utils/types.ts"
-    },
     "src/components/ic-menu/ic-menu.types.ts::IcMenuOptionIdEventDetail": {
       "declaration": "export interface IcMenuOptionIdEventDetail {\n  optionId: string | undefined;\n}",
       "docstring": "",
       "path": "src/components/ic-menu/ic-menu.types.ts"
     },
-    "src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail": {
-      "declaration": "export interface IcOptionSelectEventDetail {\n  value: string;\n  label?: string;\n  optionId?: string;\n}",
-      "docstring": "",
-      "path": "src/components/ic-menu/ic-menu.types.ts"
-    },
-    "src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail": {
-      "declaration": "export interface IcMenuChangeEventDetail {\n  open: boolean;\n  focusInput?: boolean;\n}",
-      "docstring": "",
-      "path": "src/components/ic-menu/ic-menu.types.ts"
-    },
     "src/components/ic-menu-item/ic-menu-item.types.ts::IcMenuItemVariants": {
       "declaration": "export type IcMenuItemVariants = \"toggle\" | \"destructive\" | \"default\";",
       "docstring": "",
@@ -19453,16 +19524,6 @@
       "docstring": "",
       "path": "src/components/ic-radio-group/ic-radio-group.types.ts"
     },
-    "src/utils/types.ts::IcBlurEventDetail": {
-      "declaration": "export interface IcBlurEventDetail {\r\n  relatedTarget: IcRelatedTarget;\r\n}",
-      "docstring": "",
-      "path": "src/utils/types.ts"
-    },
-    "src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarBlurEventDetail": {
-      "declaration": "export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {\n  relatedTarget: IcRelatedTarget;\n}",
-      "docstring": "",
-      "path": "src/components/ic-search-bar/ic-search-bar.types.ts"
-    },
     "src/utils/types.ts::IcSearchMatchPositions": {
       "declaration": "export type IcSearchMatchPositions = \"start\" | \"anywhere\";",
       "docstring": "",
@@ -19513,6 +19574,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.7",
+  "version": "3.0.0-alpha.9",
   "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": "0a552da91d9f65e72b19d4518fb54efcf018d7bf"
+  "gitHead": "c4ead3a55cd2fcb22af6e0e92a46f99c89cb194f"
 }