@ukic/docs 2.11.0 → 2.12.0

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2024-05-10T14:30:05",
+  "timestamp": "2024-05-30T13:05:50",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.10.0",
@@ -2146,10 +2146,10 @@
         },
         {
           "name": "variant",
-          "type": "\"destructive\" | \"icon\" | \"primary\" | \"secondary\" | \"tertiary\"",
+          "type": "\"destructive\" | \"icon\" | \"icon-destructive\" | \"icon-primary\" | \"icon-secondary\" | \"icon-tertiary\" | \"primary\" | \"secondary\" | \"tertiary\"",
           "complexType": {
             "original": "IcButtonVariants",
-            "resolved": "\"destructive\" | \"icon\" | \"primary\" | \"secondary\" | \"tertiary\"",
+            "resolved": "\"destructive\" | \"icon\" | \"icon-destructive\" | \"icon-primary\" | \"icon-secondary\" | \"icon-tertiary\" | \"primary\" | \"secondary\" | \"tertiary\"",
             "references": {
               "IcButtonVariants": {
                 "location": "import",
@@ -2173,6 +2173,22 @@
               "value": "icon",
               "type": "string"
             },
+            {
+              "value": "icon-destructive",
+              "type": "string"
+            },
+            {
+              "value": "icon-primary",
+              "type": "string"
+            },
+            {
+              "value": "icon-secondary",
+              "type": "string"
+            },
+            {
+              "value": "icon-tertiary",
+              "type": "string"
+            },
             {
               "value": "primary",
               "type": "string"
@@ -3105,6 +3121,28 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "hideLabel",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "hide-label",
+          "reflectToAttr": false,
+          "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "indeterminate",
           "type": "boolean",
@@ -4693,7 +4731,7 @@
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
           "name": "hideCloseButton",
@@ -5979,7 +6017,7 @@
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
           "name": "secondaryHeading",
@@ -8945,6 +8983,10 @@
         {
           "name": "slot",
           "text": "badge - Badge component overlaying the top right of the icon."
+        },
+        {
+          "name": "slot",
+          "text": "icon - Content will be displayed to the left of the label for expanded navigation items, and in replacement of the label for collapsed navigation items."
         }
       ],
       "usage": {},
@@ -9205,6 +9247,10 @@
         {
           "name": "badge",
           "docs": "Badge component overlaying the top right of the icon."
+        },
+        {
+          "name": "icon",
+          "docs": "Content will be displayed to the left of the label for expanded navigation items, and in replacement of the label for collapsed navigation items."
         }
       ],
       "parts": [
@@ -10097,6 +10143,7 @@
           "reflectToAttr": false,
           "docs": "The appearance of the pagination, e.g. dark, light or the default.",
           "docsTags": [],
+          "default": "\"default\"",
           "values": [
             {
               "value": "dark",
@@ -10114,28 +10161,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",
@@ -10171,7 +10196,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"
@@ -10201,27 +10226,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",
@@ -14133,7 +14137,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": [
@@ -18040,7 +18044,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",
@@ -18327,7 +18331,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",
@@ -18856,7 +18860,7 @@
       "path": "src/components/ic-button/ic-button.types.ts"
     },
     "src/components/ic-button/ic-button.types.ts::IcButtonVariants": {
-      "declaration": "export type IcButtonVariants =\n  | \"primary\"\n  | \"secondary\"\n  | \"tertiary\"\n  | \"icon\"\n  | \"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"
     },

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "mi6",
   "name": "@ukic/docs",
-  "version": "2.11.0",
+  "version": "2.12.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": "bee9250acbbeec465702a621ad5a68bf74cd91f4"
+  "gitHead": "d514f0b7ea02cad6e1f5f13aba34b7e8a3c162dd"
 }