@ukic/canary-docs 3.0.0-canary.24 → 3.0.0-canary.26

package/docs.json

@@ -1643,7 +1643,7 @@
           "reflectToAttr": false,
           "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
           "docsTags": [],
-          "default": "{\n    alignment: \"right\",\n    hideAllFromItemsPerPage: false,\n    hideRangeLabel: false,\n    itemLabel: \"Item\",\n    itemsPerPageOptions: [\n      { label: \"10\", value: \"10\" },\n      { label: \"25\", value: \"25\" },\n      { label: \"50\", value: \"50\" },\n    ],\n    monochrome: false,\n    pageLabel: \"Page\",\n    rangeLabelType: \"page\",\n    selectedItemsPerPage: 10,\n    selectItemsPerPageOnEnter: true,\n    setToFirstPageOnPaginationChange: false,\n    showGoToPageControl: true,\n    showItemsPerPageControl: true,\n    type: \"simple\",\n  }",
+          "default": "{\n    alignment: \"right\",\n    hideAllFromItemsPerPage: false,\n    hideCurrentPage: false,\n    hideFirstAndLastPageButton: false,\n    hideRangeLabel: false,\n    itemLabel: \"Item\",\n    itemsPerPageOptions: [\n      { label: \"10\", value: \"10\" },\n      { label: \"25\", value: \"25\" },\n      { label: \"50\", value: \"50\" },\n    ],\n    monochrome: false,\n    pageLabel: \"Page\",\n    rangeLabelType: \"page\",\n    selectedItemsPerPage: 10,\n    selectItemsPerPageOnEnter: true,\n    setToFirstPageOnPaginationChange: false,\n    showGoToPageControl: true,\n    showItemsPerPageControl: true,\n    type: \"simple\",\n  }",
           "values": [
             {
               "type": "IcPaginationBarOptions"
@@ -4530,6 +4530,33 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "accessibleLabel",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "accessible-label",
+          "reflectToAttr": false,
+          "docs": "The accessible label passed down to the pagination component to provide context for screen reader users.",
+          "docsTags": [],
+          "default": "\"Pagination Navigation\"",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "alignment",
           "type": "\"left\" | \"right\" | \"space-between\" | undefined",
@@ -4626,6 +4653,60 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "hideCurrentPage",
+          "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "hide-current-page",
+          "reflectToAttr": false,
+          "docs": "If `true`, the current page of the simple pagination will not be displayed.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "hideFirstAndLastPageButton",
+          "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "hide-first-and-last-page-button",
+          "reflectToAttr": false,
+          "docs": "If `true`, the first and last page buttons will not be displayed.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "hideRangeLabel",
           "type": "boolean | undefined",
@@ -5505,7 +5586,7 @@
           "mutable": false,
           "attr": "emit-time-part-change",
           "reflectToAttr": false,
-          "docs": "If `true`, every individual input field completed will emit an icChange event.",
+          "docs": "If `true`, every individual input field completed will emit an icTimeChange event.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -5781,6 +5862,33 @@
           "getter": false,
           "setter": false
         },
+        {
+          "name": "showAmPmToggle",
+          "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "show-am-pm-toggle",
+          "reflectToAttr": false,
+          "docs": "If `true`, the time input will show an AM/PM toggle when in 12-hour time period.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "showClearButton",
           "type": "boolean | undefined",
@@ -5891,10 +5999,10 @@
         },
         {
           "name": "timeFormat",
-          "type": "\"HH:MM\" | \"HH:MM:SS\"",
+          "type": "\"HH:MM\" | \"HH:MM:SS\" | \"HH:MM:SS.SSS\"",
           "complexType": {
             "original": "IcTimeFormat",
-            "resolved": "\"HH:MM\" | \"HH:MM:SS\"",
+            "resolved": "\"HH:MM\" | \"HH:MM:SS\" | \"HH:MM:SS.SSS\"",
             "references": {
               "IcTimeFormat": {
                 "location": "import",
@@ -5917,6 +6025,10 @@
             {
               "value": "HH:MM:SS",
               "type": "string"
+            },
+            {
+              "value": "HH:MM:SS.SSS",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -6155,12 +6267,12 @@
           "docsTags": []
         },
         {
-          "event": "icChange",
-          "detail": "{ value: Date | null; timeObject: { hour: string | null; minute: string | null; second: string | null; }; }",
+          "event": "icFocus",
+          "detail": "{ value: Date | null; }",
           "bubbles": true,
           "complexType": {
-            "original": "{\n    value: Date | null;\n    timeObject: {\n      hour: string | null;\n      minute: string | null;\n      second: string | null;\n    };\n  }",
-            "resolved": "{ value: Date | null; timeObject: { hour: string | null; minute: string | null; second: string | null; }; }",
+            "original": "{ value: Date | null }",
+            "resolved": "{ value: Date | null; }",
             "references": {
               "Date": {
                 "location": "global",
@@ -6170,16 +6282,16 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when the value has changed.",
+          "docs": "Emitted when the input gains focus.",
           "docsTags": []
         },
         {
-          "event": "icFocus",
-          "detail": "{ value: Date | null; }",
+          "event": "icTimeChange",
+          "detail": "{ value: Date | null; timeObject: { hour: string | null; minute: string | null; second: string | null; millisecond: string | null; period: string | null; }; }",
           "bubbles": true,
           "complexType": {
-            "original": "{ value: Date | null }",
-            "resolved": "{ value: Date | null; }",
+            "original": "{\n    value: Date | null;\n    timeObject: {\n      hour: string | null;\n      minute: string | null;\n      second: string | null;\n      millisecond: string | null;\n      period: string | null;\n    };\n  }",
+            "resolved": "{ value: Date | null; timeObject: { hour: string | null; minute: string | null; second: string | null; millisecond: string | null; period: string | null; }; }",
             "references": {
               "Date": {
                 "location": "global",
@@ -6189,7 +6301,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when the input gains focus.",
+          "docs": "Emitted when the value has changed.",
           "docsTags": []
         }
       ],
@@ -6208,6 +6320,8 @@
         "ic-input-label",
         "ic-input-component-container",
         "ic-button",
+        "ic-toggle-button-group",
+        "ic-toggle-button",
         "ic-input-validation"
       ],
       "dependencyGraph": {
@@ -6216,6 +6330,8 @@
           "ic-input-label",
           "ic-input-component-container",
           "ic-button",
+          "ic-toggle-button-group",
+          "ic-toggle-button",
           "ic-input-validation"
         ],
         "ic-input-label": [
@@ -6232,11 +6348,354 @@
         "ic-tooltip": [
           "ic-typography"
         ],
+        "ic-toggle-button": [
+          "ic-button"
+        ],
         "ic-input-validation": [
           "ic-typography"
         ]
       }
     },
+    {
+      "filePath": "src/components/ic-time-selector/ic-time-selector.tsx",
+      "encapsulation": "shadow",
+      "tag": "ic-time-selector",
+      "readme": "# ic-time-selector\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "disableTimes",
+          "type": "IcDisableTimeSelection[]",
+          "complexType": {
+            "original": "IcDisableTimeSelection[]",
+            "resolved": "IcDisableTimeSelection[]",
+            "references": {
+              "IcDisableTimeSelection": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcDisableTimeSelection"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "An array of times that will be disabled in the time selector. The times can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.",
+          "docsTags": [],
+          "default": "[]",
+          "values": [
+            {
+              "type": "IcDisableTimeSelection[]"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "max",
+          "type": "Date | string",
+          "complexType": {
+            "original": "string | Date",
+            "resolved": "Date | string",
+            "references": {
+              "Date": {
+                "location": "global",
+                "id": "global::Date"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "max",
+          "reflectToAttr": false,
+          "docs": "The latest time that will be allowed. The value can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.",
+          "docsTags": [],
+          "default": "\"\"",
+          "values": [
+            {
+              "type": "Date"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "min",
+          "type": "Date | string",
+          "complexType": {
+            "original": "string | Date",
+            "resolved": "Date | string",
+            "references": {
+              "Date": {
+                "location": "global",
+                "id": "global::Date"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "min",
+          "reflectToAttr": false,
+          "docs": "The earliest time that will be allowed. The value can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.",
+          "docsTags": [],
+          "default": "\"\"",
+          "values": [
+            {
+              "type": "Date"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "size",
+          "type": "\"large\" | \"medium\" | \"small\"",
+          "complexType": {
+            "original": "IcSizes",
+            "resolved": "\"large\" | \"medium\" | \"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 time selector to be displayed.",
+          "docsTags": [],
+          "default": "\"medium\"",
+          "values": [
+            {
+              "value": "large",
+              "type": "string"
+            },
+            {
+              "value": "medium",
+              "type": "string"
+            },
+            {
+              "value": "small",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "theme",
+          "type": "\"dark\" | \"inherit\" | \"light\" | undefined",
+          "complexType": {
+            "original": "IcThemeMode",
+            "resolved": "\"dark\" | \"inherit\" | \"light\" | undefined",
+            "references": {
+              "IcThemeMode": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcThemeMode"
+              }
+            }
+          },
+          "mutable": false,
+          "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.",
+          "docsTags": [],
+          "default": "\"inherit\"",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "inherit",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "timeFormat",
+          "type": "\"HH:MM\" | \"HH:MM:SS\"",
+          "complexType": {
+            "original": "IcTimeFormatSelector",
+            "resolved": "\"HH:MM\" | \"HH:MM:SS\"",
+            "references": {
+              "IcTimeFormatSelector": {
+                "location": "import",
+                "path": "../../utils/types",
+                "id": "src/utils/types.ts::IcTimeFormatSelector"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "time-format",
+          "reflectToAttr": false,
+          "docs": "The format in which the time will be displayed.",
+          "docsTags": [],
+          "default": "this.DEFAULT_TIME_FORMAT",
+          "values": [
+            {
+              "value": "HH:MM",
+              "type": "string"
+            },
+            {
+              "value": "HH:MM:SS",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "timePeriod",
+          "type": "\"12\" | \"24\"",
+          "complexType": {
+            "original": "\"12\" | \"24\"",
+            "resolved": "\"12\" | \"24\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "time-period",
+          "reflectToAttr": false,
+          "docs": "The time period format: \"12\" for 12-hour, \"24\" for 24-hour. Defaults to \"24\".",
+          "docsTags": [],
+          "default": "\"24\"",
+          "values": [
+            {
+              "value": "12",
+              "type": "string"
+            },
+            {
+              "value": "24",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "value",
+          "type": "Date | null | string | undefined",
+          "complexType": {
+            "original": "string | Date | null | undefined",
+            "resolved": "Date | null | string | undefined",
+            "references": {
+              "Date": {
+                "location": "global",
+                "id": "global::Date"
+              }
+            }
+          },
+          "mutable": true,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The value of the time selector. The value can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.",
+          "docsTags": [],
+          "default": "\"\"",
+          "values": [
+            {
+              "type": "Date"
+            },
+            {
+              "type": "null"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "icChange",
+          "detail": "{ value: Date | null; timeString: string | null; timeObject: { hour: string | null; minute: string | null; second: string | null; period?: IcTimePeriods | undefined; }; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{\n    value: Date | null;\n    timeString: string | null;\n    timeObject: {\n      hour: string | null;\n      minute: string | null;\n      second: string | null;\n      period?: IcTimePeriods;\n    };\n  }",
+            "resolved": "{ value: Date | null; timeString: string | null; timeObject: { hour: string | null; minute: string | null; second: string | null; period?: IcTimePeriods | undefined; }; }",
+            "references": {
+              "Date": {
+                "location": "global",
+                "id": "global::Date"
+              },
+              "IcTimePeriods": {
+                "location": "import",
+                "path": "./ic-time-selector.types",
+                "id": "src/components/ic-time-selector/ic-time-selector.types.ts::IcTimePeriods"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the value has changed.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "ic-typography",
+        "ic-button"
+      ],
+      "dependencyGraph": {
+        "ic-time-selector": [
+          "ic-typography",
+          "ic-button"
+        ],
+        "ic-button": [
+          "ic-typography",
+          "ic-loading-indicator",
+          "ic-tooltip"
+        ],
+        "ic-loading-indicator": [
+          "ic-typography"
+        ],
+        "ic-tooltip": [
+          "ic-typography"
+        ]
+      }
+    },
     {
       "filePath": "src/components/ic-tree-item/ic-tree-item.tsx",
       "encapsulation": "shadow",
@@ -7009,7 +7468,7 @@
       "path": "src/components/ic-data-table/ic-data-table.types.tsx"
     },
     "src/utils/types.ts::IcPaginationBarOptions": {
-      "declaration": "export interface IcPaginationBarOptions {\n  alignment?: IcPaginationAlignmentOptions;\n  hideAllFromItemsPerPage?: boolean;\n  hideRangeLabel?: boolean;\n  itemLabel?: string;\n  itemsPerPageOptions?: { label: string; value: string }[];\n  monochrome?: boolean;\n  pageLabel?: string;\n  rangeLabelType?: IcPaginationLabelTypes;\n  selectedItemsPerPage?: number;\n  selectItemsPerPageOnEnter?: boolean;\n  setToFirstPageOnPaginationChange?: boolean;\n  showGoToPageControl?: boolean;\n  showItemsPerPageControl?: boolean;\n  theme?: IcThemeMode;\n  type?: IcPaginationTypes;\n}",
+      "declaration": "export interface IcPaginationBarOptions {\n  alignment?: IcPaginationAlignmentOptions;\n  hideAllFromItemsPerPage?: boolean;\n  hideCurrentPage?: boolean;\n  hideFirstAndLastPageButton?: boolean;\n  hideRangeLabel?: boolean;\n  itemLabel?: string;\n  itemsPerPageOptions?: { label: string; value: string }[];\n  monochrome?: boolean;\n  pageLabel?: string;\n  rangeLabelType?: IcPaginationLabelTypes;\n  selectedItemsPerPage?: number;\n  selectItemsPerPageOnEnter?: boolean;\n  setToFirstPageOnPaginationChange?: boolean;\n  showGoToPageControl?: boolean;\n  showItemsPerPageControl?: boolean;\n  theme?: IcThemeMode;\n  type?: IcPaginationTypes;\n}",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
@@ -7079,10 +7538,20 @@
       "path": "src/utils/types.ts"
     },
     "src/utils/types.ts::IcTimeFormat": {
-      "declaration": "export type IcTimeFormat = \"HH:MM\" | \"HH:MM:SS\";",
+      "declaration": "export type IcTimeFormat = \"HH:MM\" | \"HH:MM:SS\" | \"HH:MM:SS.SSS\";",
+      "docstring": "",
+      "path": "src/utils/types.ts"
+    },
+    "src/utils/types.ts::IcTimeFormatSelector": {
+      "declaration": "export type IcTimeFormatSelector = \"HH:MM\" | \"HH:MM:SS\";",
       "docstring": "",
       "path": "src/utils/types.ts"
     },
+    "src/components/ic-time-selector/ic-time-selector.types.ts::IcTimePeriods": {
+      "declaration": "export type IcTimePeriods = \"AM\" | \"PM\";",
+      "docstring": "",
+      "path": "src/components/ic-time-selector/ic-time-selector.types.ts"
+    },
     "src/components/ic-tree-view/ic-tree-view.types.tsx::IcTreeItemOptions": {
       "declaration": "{\n  label: string;\n  icon?: string;\n  children?: IcTreeItemOptions[];\n  disabled?: boolean;\n  expanded?: boolean;\n  href?: string;\n  selected?: boolean;\n  treeItemId?: string;\n  theme?: IcThemeMode;\n  truncateTreeItem?: boolean;\n}",
       "docstring": "",

package/package.json

@@ -1,23 +1,23 @@
 {
-  "author": "mi6",
   "name": "@ukic/canary-docs",
-  "version": "3.0.0-canary.24",
+  "version": "3.0.0-canary.26",
   "description": "API documentation for @ukic canary components",
+  "bugs": {
+    "url": "https://github.com/mi6/ic-ui-kit/issues",
+    "email": "icds@gchq.gov.uk"
+  },
+  "repository": {
+    "url": "git+https://github.com/mi6/ic-ui-kit.git",
+    "directory": "packages/canary-docs"
+  },
+  "license": "MIT",
+  "author": "mi6",
   "main": "docs.json",
   "types": "./docs.d.ts",
   "files": [
     "docs.json",
     "docs.d.ts"
   ],
-  "repository": {
-    "url": "git+https://github.com/mi6/ic-ui-kit.git",
-    "directory": "packages/canary-docs"
-  },
-  "bugs": {
-    "url": "https://github.com/mi6/ic-ui-kit/issues",
-    "email": "icds@gchq.gov.uk"
-  },
-  "license": "MIT",
   "packageManager": "^npm@10.9.2",
-  "gitHead": "055d3ec189bdc7b19e08762df4a74905043b5ea3"
+  "gitHead": "f02f7dbf5c2a7967e86689b425e601f34f50231b"
 }