@ukic/docs 2.1.0-beta.8 → 2.1.0-beta.9

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-03-01T11:38:13",
+  "timestamp": "2023-03-21T13:37:41",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -240,7 +240,13 @@
       "methods": [],
       "events": [],
       "listeners": [],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-back-to-top",
+          "annotation": "prop",
+          "docs": "z-index of back to top"
+        }
+      ],
       "slots": [],
       "parts": [],
       "dependents": [],
@@ -822,11 +828,13 @@
       "dependents": [
         "ic-alert",
         "ic-card",
+        "ic-horizontal-scroll",
         "ic-navigation-button",
         "ic-navigation-menu",
         "ic-search-bar",
         "ic-select",
         "ic-side-navigation",
+        "ic-toast",
         "ic-top-navigation"
       ],
       "dependencies": [
@@ -850,6 +858,9 @@
         "ic-card": [
           "ic-button"
         ],
+        "ic-horizontal-scroll": [
+          "ic-button"
+        ],
         "ic-navigation-button": [
           "ic-button"
         ],
@@ -865,6 +876,9 @@
         "ic-side-navigation": [
           "ic-button"
         ],
+        "ic-toast": [
+          "ic-button"
+        ],
         "ic-top-navigation": [
           "ic-button"
         ]
@@ -1971,7 +1985,13 @@
       "methods": [],
       "events": [],
       "listeners": [],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-classification-banner",
+          "annotation": "prop",
+          "docs": "z-index of classification banner"
+        }
+      ],
       "slots": [],
       "parts": [],
       "dependents": [],
@@ -2715,6 +2735,81 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/ic-horizontal-scroll/ic-horizontal-scroll.tsx",
+      "encapsulation": "shadow",
+      "tag": "ic-horizontal-scroll",
+      "readme": "# ic-horizontal-scroll\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "appearance",
+          "type": "\"dark\" | \"default\" | \"light\"",
+          "mutable": false,
+          "attr": "appearance",
+          "reflectToAttr": false,
+          "docs": "The appearance of the horizontal scroll, e.g. dark, light or the default.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "ic-page-header",
+        "ic-tab-group",
+        "ic-top-navigation"
+      ],
+      "dependencies": [
+        "ic-button"
+      ],
+      "dependencyGraph": {
+        "ic-horizontal-scroll": [
+          "ic-button"
+        ],
+        "ic-button": [
+          "ic-loading-indicator",
+          "ic-tooltip"
+        ],
+        "ic-loading-indicator": [
+          "ic-typography"
+        ],
+        "ic-tooltip": [
+          "ic-typography"
+        ],
+        "ic-page-header": [
+          "ic-horizontal-scroll"
+        ],
+        "ic-tab-group": [
+          "ic-horizontal-scroll"
+        ],
+        "ic-top-navigation": [
+          "ic-horizontal-scroll"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/ic-input-component-container/ic-input-component-container.tsx",
       "encapsulation": "none",
@@ -3752,7 +3847,8 @@
       "parts": [],
       "dependents": [
         "ic-button",
-        "ic-step"
+        "ic-step",
+        "ic-toast"
       ],
       "dependencies": [
         "ic-typography"
@@ -3766,6 +3862,9 @@
         ],
         "ic-step": [
           "ic-loading-indicator"
+        ],
+        "ic-toast": [
+          "ic-loading-indicator"
         ]
       }
     },
@@ -3964,7 +4063,13 @@
       ],
       "events": [],
       "listeners": [],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-menu",
+          "annotation": "prop",
+          "docs": "z-index of menu"
+        }
+      ],
       "slots": [],
       "parts": [],
       "dependents": [
@@ -4286,7 +4391,13 @@
           "passive": false
         }
       ],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-navigation-item",
+          "annotation": "prop",
+          "docs": "z-index of navigation group item"
+        }
+      ],
       "slots": [],
       "parts": [],
       "dependents": [],
@@ -4386,7 +4497,13 @@
           "passive": false
         }
       ],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-navigation-item",
+          "annotation": "prop",
+          "docs": "z-index of navigation item"
+        }
+      ],
       "slots": [],
       "parts": [
         {
@@ -4477,7 +4594,13 @@
           "passive": false
         }
       ],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-navigation-menu",
+          "annotation": "prop",
+          "docs": "z-index of navigation menu"
+        }
+      ],
       "slots": [
         {
           "name": "buttons",
@@ -4705,7 +4828,13 @@
       "methods": [],
       "events": [],
       "listeners": [],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-page-header",
+          "annotation": "prop",
+          "docs": "z-index of page-header"
+        }
+      ],
       "slots": [
         {
           "name": "actions",
@@ -4744,11 +4873,26 @@
       "dependents": [],
       "dependencies": [
         "ic-section-container",
-        "ic-typography"
+        "ic-typography",
+        "ic-horizontal-scroll"
       ],
       "dependencyGraph": {
         "ic-page-header": [
           "ic-section-container",
+          "ic-typography",
+          "ic-horizontal-scroll"
+        ],
+        "ic-horizontal-scroll": [
+          "ic-button"
+        ],
+        "ic-button": [
+          "ic-loading-indicator",
+          "ic-tooltip"
+        ],
+        "ic-loading-indicator": [
+          "ic-typography"
+        ],
+        "ic-tooltip": [
           "ic-typography"
         ]
       }
@@ -5939,7 +6083,13 @@
           "passive": false
         }
       ],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-menu",
+          "annotation": "prop",
+          "docs": "z-index of search bar menu"
+        }
+      ],
       "slots": [],
       "parts": [],
       "dependents": [],
@@ -6547,12 +6697,17 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when option is highlighted within the menu.",
+          "docs": "Emitted when option is highlighted within the menu.\nHighlighting a menu item will trigger an `icChange/onIcChange` due to the value being updated.",
           "docsTags": []
         }
       ],
       "listeners": [],
       "styles": [
+        {
+          "name": "--ic-z-index-menu",
+          "annotation": "prop",
+          "docs": "z-index of select menu"
+        },
         {
           "name": "--input-width",
           "annotation": "prop",
@@ -6772,7 +6927,13 @@
           "passive": false
         }
       ],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-side-navigation",
+          "annotation": "prop",
+          "docs": "z-index of side navigation panel"
+        }
+      ],
       "slots": [
         {
           "name": "app-icon",
@@ -7707,24 +7868,28 @@
       ],
       "methods": [],
       "events": [],
-      "listeners": [
-        {
-          "event": "tabFocus",
-          "capture": false,
-          "passive": false
-        }
-      ],
+      "listeners": [],
       "styles": [],
       "slots": [],
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "ic-tooltip"
+        "ic-horizontal-scroll"
       ],
       "dependencyGraph": {
         "ic-tab-group": [
+          "ic-horizontal-scroll"
+        ],
+        "ic-horizontal-scroll": [
+          "ic-button"
+        ],
+        "ic-button": [
+          "ic-loading-indicator",
           "ic-tooltip"
         ],
+        "ic-loading-indicator": [
+          "ic-typography"
+        ],
         "ic-tooltip": [
           "ic-typography"
         ]
@@ -8654,6 +8819,292 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/ic-toast/ic-toast.tsx",
+      "encapsulation": "shadow",
+      "tag": "ic-toast",
+      "readme": "# ic-toast\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "action - IcButton or IcLink is placed below header and message. If used will default toast to manual `dismiss` type."
+        },
+        {
+          "name": "slot",
+          "text": "neutral-icon - A custom neutral icon is placed on the left side of the component. If used will default toast to `neutral` variant."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "autoDismissTimeout",
+          "type": "number",
+          "mutable": false,
+          "attr": "auto-dismiss-timeout",
+          "reflectToAttr": false,
+          "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\n(NOTE: Has a minimum value of `5000ms`)",
+          "docsTags": [],
+          "default": "5000",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "dismissButtonAriaLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "dismiss-button-aria-label",
+          "reflectToAttr": false,
+          "docs": "If toast can be manually dismissed, this prop sets a custom aria-label for the ic-button component",
+          "docsTags": [],
+          "default": "\"dismiss\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "dismissMode",
+          "type": "\"automatic\" | \"manual\"",
+          "mutable": false,
+          "attr": "dismiss-mode",
+          "reflectToAttr": false,
+          "docs": "How the toast will be dismissed. If manual will display a dismiss button.",
+          "docsTags": [],
+          "default": "\"manual\"",
+          "values": [
+            {
+              "value": "automatic",
+              "type": "string"
+            },
+            {
+              "value": "manual",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "heading",
+          "type": "string",
+          "mutable": false,
+          "attr": "heading",
+          "reflectToAttr": false,
+          "docs": "The title to display at the start of the toast. (NOTE: Should be no more than `70` characters)",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "message",
+          "type": "string",
+          "mutable": false,
+          "attr": "message",
+          "reflectToAttr": false,
+          "docs": "The main body message of the toast. (NOTE: Should be no more than `140` characters)",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "neutralIconAriaLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "neutral-icon-aria-label",
+          "reflectToAttr": false,
+          "docs": "Provides a custom alt-text to be announced to screen readers, if slotting a custom neutral icon",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "variant",
+          "type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
+          "mutable": false,
+          "attr": "variant",
+          "reflectToAttr": false,
+          "docs": "The variant of the toast being rendered",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "error",
+              "type": "string"
+            },
+            {
+              "value": "info",
+              "type": "string"
+            },
+            {
+              "value": "neutral",
+              "type": "string"
+            },
+            {
+              "value": "success",
+              "type": "string"
+            },
+            {
+              "value": "warning",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "setVisible",
+          "returns": {
+            "type": "Promise<HTMLElement>",
+            "docs": "The element that previously had focus before the toast appeared"
+          },
+          "signature": "setVisible() => Promise<HTMLElement>",
+          "parameters": [],
+          "docs": "Used to display the individual toast",
+          "docsTags": [
+            {
+              "name": "returns",
+              "text": "The element that previously had focus before the toast appeared"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "icDismiss",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Is emitted when the user dismisses the toast",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "icDismiss",
+          "capture": true,
+          "passive": false
+        },
+        {
+          "event": "keydown",
+          "target": "document",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "mouseenter",
+          "capture": false,
+          "passive": true
+        },
+        {
+          "event": "mouseleave",
+          "capture": false,
+          "passive": true
+        }
+      ],
+      "styles": [],
+      "slots": [
+        {
+          "name": "action",
+          "docs": "IcButton or IcLink is placed below header and message. If used will default toast to manual `dismiss` type."
+        },
+        {
+          "name": "neutral-icon",
+          "docs": "A custom neutral icon is placed on the left side of the component. If used will default toast to `neutral` variant."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "ic-typography",
+        "ic-loading-indicator",
+        "ic-button"
+      ],
+      "dependencyGraph": {
+        "ic-toast": [
+          "ic-typography",
+          "ic-loading-indicator",
+          "ic-button"
+        ],
+        "ic-loading-indicator": [
+          "ic-typography"
+        ],
+        "ic-button": [
+          "ic-loading-indicator",
+          "ic-tooltip"
+        ],
+        "ic-tooltip": [
+          "ic-typography"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/ic-toast-region/ic-toast-region.tsx",
+      "encapsulation": "none",
+      "tag": "ic-toast-region",
+      "readme": "# ic-toast-region\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [
+        {
+          "name": "setVisible",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setVisible(toast: HTMLIcToastElement) => Promise<void>",
+          "parameters": [],
+          "docs": "Handles setting the visibility of various toasts based on what is already visible",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "toast The toast element being requested to display"
+            }
+          ]
+        }
+      ],
+      "events": [],
+      "listeners": [
+        {
+          "event": "icDismiss",
+          "capture": true,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "./src/components/ic-tooltip/ic-tooltip.tsx",
       "encapsulation": "shadow",
@@ -8778,14 +9229,19 @@
       "methods": [],
       "events": [],
       "listeners": [],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--ic-z-index-tooltip",
+          "annotation": "prop",
+          "docs": "z-index of tooltip"
+        }
+      ],
       "slots": [],
       "parts": [],
       "dependents": [
         "ic-button",
         "ic-chip",
-        "ic-navigation-item",
-        "ic-tab-group"
+        "ic-navigation-item"
       ],
       "dependencies": [
         "ic-typography"
@@ -8802,9 +9258,6 @@
         ],
         "ic-navigation-item": [
           "ic-tooltip"
-        ],
-        "ic-tab-group": [
-          "ic-tooltip"
         ]
       }
     },
@@ -9011,6 +9464,7 @@
         "ic-section-container",
         "ic-typography",
         "ic-button",
+        "ic-horizontal-scroll",
         "ic-navigation-menu"
       ],
       "dependencyGraph": {
@@ -9018,6 +9472,7 @@
           "ic-section-container",
           "ic-typography",
           "ic-button",
+          "ic-horizontal-scroll",
           "ic-navigation-menu"
         ],
         "ic-button": [
@@ -9030,6 +9485,9 @@
         "ic-tooltip": [
           "ic-typography"
         ],
+        "ic-horizontal-scroll": [
+          "ic-button"
+        ],
         "ic-navigation-menu": [
           "ic-button",
           "ic-typography"
@@ -9155,6 +9613,7 @@
         "ic-switch",
         "ic-tab",
         "ic-text-field",
+        "ic-toast",
         "ic-tooltip",
         "ic-top-navigation"
       ],
@@ -9241,6 +9700,9 @@
         "ic-text-field": [
           "ic-typography"
         ],
+        "ic-toast": [
+          "ic-typography"
+        ],
         "ic-tooltip": [
           "ic-typography"
         ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukic/docs",
-  "version": "2.1.0-beta.8",
+  "version": "2.1.0-beta.9",
   "description": "API documentation for @ukic components",
   "main": "docs.json",
   "types": "docs.d.ts",
@@ -9,5 +9,5 @@
     "docs.d.ts"
   ],
   "license": "MIT",
-  "gitHead": "20d7df2ba2c281735d96b667a3e037568443cdf8"
+  "gitHead": "f25923c8f6fe3d6c65f4cd048bdab9c46d324759"
 }