@ukic/docs 2.10.4 → 2.11.1

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2024-04-18T12:10:30",
+  "timestamp": "2024-05-29T14:10:07",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.10.0",
@@ -204,7 +204,12 @@
       "tag": "ic-accordion-group",
       "readme": "# ic-accordion-title\n\n\n",
       "docs": "",
-      "docsTags": [],
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "group-title - Content is placed as the accordion group title."
+        }
+      ],
       "usage": {},
       "props": [
         {
@@ -403,7 +408,12 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "group-title",
+          "docs": "Content is placed as the accordion group title."
+        }
+      ],
       "parts": [],
       "dependents": [],
       "dependencies": [
@@ -712,6 +722,39 @@
           ],
           "optional": false,
           "required": true
+        },
+        {
+          "name": "variant",
+          "type": "\"default\" | \"icon\"",
+          "complexType": {
+            "original": "IcBackToTopVariants",
+            "resolved": "\"default\" | \"icon\"",
+            "references": {
+              "IcBackToTopVariants": {
+                "location": "import",
+                "path": "./ic-back-to-top.types",
+                "id": "src/components/ic-back-to-top/ic-back-to-top.types.ts::IcBackToTopVariants"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "variant",
+          "reflectToAttr": false,
+          "docs": "The variant of the button to render",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "icon",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [],
@@ -728,10 +771,15 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "ic-typography"
+        "ic-typography",
+        "ic-tooltip"
       ],
       "dependencyGraph": {
         "ic-back-to-top": [
+          "ic-typography",
+          "ic-tooltip"
+        ],
+        "ic-tooltip": [
           "ic-typography"
         ]
       }
@@ -4645,7 +4693,7 @@
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
           "name": "hideCloseButton",
@@ -5931,7 +5979,7 @@
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
           "name": "secondaryHeading",
@@ -10049,6 +10097,7 @@
           "reflectToAttr": false,
           "docs": "The appearance of the pagination, e.g. dark, light or the default.",
           "docsTags": [],
+          "default": "\"default\"",
           "values": [
             {
               "value": "dark",
@@ -10066,28 +10115,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "ariaOverride",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "aria-override",
-          "reflectToAttr": false,
-          "docs": "If true the aria-label will be set to `Page X of Y`, where X is the current page and Y is the page count.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -10123,7 +10150,7 @@
           "reflectToAttr": false,
           "docs": "The label for the pagination item (applicable when simple pagination is being used).",
           "docsTags": [],
-          "default": "\"Page \"",
+          "default": "\"Page\"",
           "values": [
             {
               "type": "string"
@@ -10153,27 +10180,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "pages",
-          "type": "number",
-          "complexType": {
-            "original": "number",
-            "resolved": "number",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "pages",
-          "reflectToAttr": false,
-          "docs": "The total number of pages.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "selected",
           "type": "boolean",
@@ -14085,7 +14091,7 @@
           "mutable": false,
           "attr": "announced",
           "reflectToAttr": false,
-          "docs": "If `true`, role='status' is added to the component and it will act as an 'aria-live' region.",
+          "docs": "If `true`, role='status' is added to the component and it will act as an 'aria-live' region.\nScreen readers will announce changes to the `label`, but not the initial value.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -16622,11 +16628,17 @@
       "props": [
         {
           "name": "color",
-          "type": "string",
+          "type": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
           "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
+            "original": "IcColor",
+            "resolved": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
+            "references": {
+              "IcColor": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcColor"
+              }
+            }
           },
           "mutable": false,
           "attr": "color",
@@ -16636,7 +16648,13 @@
           "default": "null",
           "values": [
             {
-              "type": "string"
+              "type": "`#${string}`"
+            },
+            {
+              "type": "`rgb(${string})`"
+            },
+            {
+              "type": "`rgba(${string})`"
             }
           ],
           "optional": true,
@@ -17941,6 +17959,7 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "ic-back-to-top",
         "ic-button",
         "ic-card",
         "ic-chip",
@@ -17953,6 +17972,9 @@
         "ic-tooltip": [
           "ic-typography"
         ],
+        "ic-back-to-top": [
+          "ic-tooltip"
+        ],
         "ic-button": [
           "ic-tooltip"
         ],
@@ -17976,7 +17998,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "app-icon - Content will be rendered to left of app title."
+          "text": "app-icon - Content will be rendered to left of app title. Anything that is slotted here will be hidden from screen readers."
         },
         {
           "name": "slot",
@@ -18263,7 +18285,7 @@
       "slots": [
         {
           "name": "app-icon",
-          "docs": "Content will be rendered to left of app title."
+          "docs": "Content will be rendered to left of app title. Anything that is slotted here will be hidden from screen readers."
         },
         {
           "name": "app-title",
@@ -18741,6 +18763,11 @@
       "docstring": "",
       "path": "src/utils/types.ts"
     },
+    "src/components/ic-back-to-top/ic-back-to-top.types.ts::IcBackToTopVariants": {
+      "declaration": "export type IcBackToTopVariants = \"default\" | \"icon\";",
+      "docstring": "",
+      "path": "src/components/ic-back-to-top/ic-back-to-top.types.ts"
+    },
     "src/components/ic-classification-banner/ic-classification-banner.types.tsx::IcProtectiveMarkings": {
       "declaration": "export type IcProtectiveMarkings =\n  | \"default\"\n  | \"official\"\n  | \"official-sensitive\"\n  | \"secret\"\n  | \"top-secret\";",
       "docstring": "",

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "2.10.4",
+  "version": "2.11.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": "5441c917fd593f7797ace93dc674a78006abb775"
+  "gitHead": "5dd43dde5edbcd9f62e6fa706e762fd95ff19935"
 }