@ukic/docs 2.1.0-beta.2 → 2.1.0-beta.3

package/README.md

@@ -1,5 +1,3 @@
 # @ukic/docs
 
-This package publishes the component API JSON data produced by Stencil.
-
-Last manual update: 18/11/2022.
+This package publishes the component API JSON data produced by Stencil.

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-01-10T14:45:33",
+  "timestamp": "2023-01-23T15:31:44",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -151,13 +151,28 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "This event should not be used anymore. Use icDismiss instead."
+            }
+          ],
+          "deprecation": "This event should not be used anymore. Use icDismiss instead."
+        },
+        {
+          "event": "icDismiss",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
           "docs": "Is emitted when the user dismisses the alert.",
           "docsTags": []
         }
       ],
       "listeners": [
         {
-          "event": "dismiss",
+          "event": "icDismiss",
           "capture": true,
           "passive": false
         }
@@ -778,7 +793,7 @@
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -1068,7 +1083,7 @@
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -1272,7 +1287,22 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when a checkbox has been checked",
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "This event should not be used anymore. Use icCheck instead."
+            }
+          ],
+          "deprecation": "This event should not be used anymore. Use icCheck instead."
+        },
+        {
+          "event": "icCheck",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when a checkbox has been checked.",
           "docsTags": []
         }
       ],
@@ -1477,7 +1507,7 @@
       ],
       "listeners": [
         {
-          "event": "checkboxChecked",
+          "event": "icCheck",
           "capture": false,
           "passive": false
         }
@@ -1503,6 +1533,161 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/ic-chip/ic-chip.tsx",
+      "encapsulation": "shadow",
+      "tag": "ic-chip",
+      "readme": "# ic-chip\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "icon - Content will be rendered at the start of the chip."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "appearance",
+          "type": "\"filled\" | \"outline\"",
+          "mutable": false,
+          "attr": "appearance",
+          "reflectToAttr": false,
+          "docs": "The emphasis of the chip.",
+          "docsTags": [],
+          "default": "\"filled\"",
+          "values": [
+            {
+              "value": "filled",
+              "type": "string"
+            },
+            {
+              "value": "outline",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": false,
+          "docs": "If `true`, the chip will appear disabled.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "dismissible",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "dismissible",
+          "reflectToAttr": false,
+          "docs": "If `true`, the chip will have a close button at the end to dismiss it.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "label",
+          "type": "string",
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "The text rendered within the chip.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "size",
+          "type": "\"default\" | \"large\" | \"small\"",
+          "mutable": false,
+          "attr": "size",
+          "reflectToAttr": false,
+          "docs": "The size of the chip.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "default",
+              "type": "string"
+            },
+            {
+              "value": "large",
+              "type": "string"
+            },
+            {
+              "value": "small",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "dismiss",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Is emitted when the user dismisses the chip.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "dismiss",
+          "capture": true,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [
+        {
+          "name": "icon",
+          "docs": "Content will be rendered at the start of the chip."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "ic-typography",
+        "ic-tooltip"
+      ],
+      "dependencyGraph": {
+        "ic-chip": [
+          "ic-typography",
+          "ic-tooltip"
+        ],
+        "ic-tooltip": [
+          "ic-typography"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/ic-classification-banner/ic-classification-banner.tsx",
       "encapsulation": "shadow",
@@ -1804,7 +1989,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -1977,20 +2162,10 @@
         }
       ],
       "methods": [],
-      "events": [
-        {
-          "event": "icFooterResized",
-          "detail": "void",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Triggers on page resize and triggers style changes in footer links and link groups",
-          "docsTags": []
-        }
-      ],
+      "events": [],
       "listeners": [
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -2059,13 +2234,13 @@
       "events": [],
       "listeners": [
         {
-          "event": "icFooterResized",
+          "event": "footerResized",
           "target": "document",
           "capture": false,
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -2108,13 +2283,13 @@
       "events": [],
       "listeners": [
         {
-          "event": "icFooterResized",
+          "event": "footerResized",
           "target": "document",
           "capture": false,
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -2328,7 +2503,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -3158,7 +3333,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -3396,7 +3571,8 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "ic-button"
+        "ic-button",
+        "ic-step"
       ],
       "dependencies": [
         "ic-typography"
@@ -3407,6 +3583,9 @@
         ],
         "ic-button": [
           "ic-loading-indicator"
+        ],
+        "ic-step": [
+          "ic-loading-indicator"
         ]
       }
     },
@@ -3594,7 +3773,7 @@
           },
           "signature": "handleClickOpen() => Promise<void>",
           "parameters": [],
-          "docs": "If menu is opened with the mouse, emit menuChange custom event.",
+          "docs": "If menu is opened with the mouse, emit icMenuStateChange custom event.",
           "docsTags": []
         },
         {
@@ -3616,7 +3795,7 @@
       ],
       "events": [
         {
-          "event": "menuChange",
+          "event": "icMenuStateChange",
           "detail": "IcMenuChangeEventDetail",
           "bubbles": true,
           "cancelable": true,
@@ -3625,16 +3804,7 @@
           "docsTags": []
         },
         {
-          "event": "menuOptionId",
-          "detail": "IcMenuOptionIdEventDetail",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when an option has been highlighted",
-          "docsTags": []
-        },
-        {
-          "event": "optionSelect",
+          "event": "icOptionSelect",
           "detail": "IcOptionSelectEventDetail",
           "bubbles": true,
           "cancelable": true,
@@ -3870,7 +4040,7 @@
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -3968,12 +4138,12 @@
           "passive": false
         },
         {
-          "event": "icNavItemClicked",
+          "event": "navItemClicked",
           "capture": false,
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -4073,7 +4243,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -4159,7 +4329,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "icNavItemClicked",
+          "event": "navItemClicked",
           "capture": false,
           "passive": false
         },
@@ -4632,7 +4802,7 @@
       ],
       "listeners": [
         {
-          "event": "radioOptionSelect",
+          "event": "icCheck",
           "capture": false,
           "passive": false
         }
@@ -4808,13 +4978,28 @@
       "methods": [],
       "events": [
         {
-          "event": "radioOptionSelect",
+          "event": "icCheck",
           "detail": "IcValueEventDetail",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when a radio is selected.",
           "docsTags": []
+        },
+        {
+          "event": "radioOptionSelect",
+          "detail": "IcValueEventDetail",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "This event should not be used anymore. Use icCheck instead."
+            }
+          ],
+          "deprecation": "This event should not be used anymore. Use icCheck instead."
         }
       ],
       "listeners": [
@@ -5501,8 +5686,14 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when input loses focus.",
-          "docsTags": []
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "This event should not be used anymore. Use icSearchBarBlur instead."
+            }
+          ],
+          "deprecation": "This event should not be used anymore. Use icSearchBarBlur instead."
         },
         {
           "event": "icInputFocus",
@@ -5510,8 +5701,14 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when input gains focus.",
-          "docsTags": []
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "This event should not be used anymore. Use icSearchBarFocus instead."
+            }
+          ],
+          "deprecation": "This event should not be used anymore. Use icSearchBarFocus instead."
         },
         {
           "event": "icMenuChange",
@@ -5571,7 +5768,7 @@
           "passive": false
         },
         {
-          "event": "menuChange",
+          "event": "icMenuStateChange",
           "capture": false,
           "passive": false
         },
@@ -6289,23 +6486,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "inline",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "inline",
-          "reflectToAttr": false,
-          "docs": "If `true`, side navigation will be contained by its parent element.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "static",
           "type": "boolean",
@@ -6360,7 +6540,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -6589,13 +6769,34 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "stepStatus",
+          "type": "\"optional\" | \"required\"",
+          "mutable": false,
+          "attr": "step-status",
+          "reflectToAttr": false,
+          "docs": "The status of the step. Use this prop to display a status message on the step if it is required or optional.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "optional",
+              "type": "string"
+            },
+            {
+              "value": "required",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "stepSubtitle",
           "type": "string",
           "mutable": false,
           "attr": "step-subtitle",
           "reflectToAttr": false,
-          "docs": "The additional information about the step.",
+          "docs": "Additional information about the step. Use this prop to override the default step status messaging displayed when selecting a step type or step status.",
           "docsTags": [],
           "values": [
             {
@@ -6611,7 +6812,7 @@
           "mutable": false,
           "attr": "step-title",
           "reflectToAttr": false,
-          "docs": "The name of the step within the stepper.",
+          "docs": "The title of the step within the stepper.",
           "docsTags": [],
           "values": [
             {
@@ -6660,10 +6861,15 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
+        "ic-loading-indicator",
         "ic-typography"
       ],
       "dependencyGraph": {
         "ic-step": [
+          "ic-loading-indicator",
+          "ic-typography"
+        ],
+        "ic-loading-indicator": [
           "ic-typography"
         ]
       }
@@ -6683,7 +6889,7 @@
           "mutable": false,
           "attr": "aligned",
           "reflectToAttr": false,
-          "docs": "The alignment of the stepper within its container.",
+          "docs": "The alignment of the default stepper within its container.",
           "docsTags": [],
           "default": "\"full-width\"",
           "values": [
@@ -6715,6 +6921,45 @@
           ],
           "optional": true,
           "required": false
+        },
+        {
+          "name": "hideStepInfo",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "hide-step-info",
+          "reflectToAttr": false,
+          "docs": "If `true`, the information about each step, i.e. step title, step subtitle and step status, will be hidden on all default steps. The information about each step will still be visible in the compact variant of the stepper.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "variant",
+          "type": "\"compact\" | \"default\"",
+          "mutable": true,
+          "attr": "variant",
+          "reflectToAttr": false,
+          "docs": "The variant of the stepper.",
+          "docsTags": [],
+          "default": "\"default\"",
+          "values": [
+            {
+              "value": "compact",
+              "type": "string"
+            },
+            {
+              "value": "default",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
         }
       ],
       "methods": [],
@@ -6981,17 +7226,7 @@
         }
       ],
       "methods": [],
-      "events": [
-        {
-          "event": "tabClick",
-          "detail": "IcTabClickEventDetail",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when a tab is selected.",
-          "docsTags": []
-        }
-      ],
+      "events": [],
       "listeners": [],
       "styles": [],
       "slots": [
@@ -7087,7 +7322,7 @@
           "mutable": false,
           "attr": "selected-tab-index",
           "reflectToAttr": false,
-          "docs": "The selected tab to be controlled by the user. Must be used alongside the tabSelect event to manage tab selection.",
+          "docs": "The selected tab to be controlled by the user. Must be used alongside the icTabSelect event to manage tab selection.",
           "docsTags": [],
           "values": [
             {
@@ -7101,13 +7336,28 @@
       "methods": [],
       "events": [
         {
-          "event": "tabSelect",
+          "event": "icTabSelect",
           "detail": "IcTabSelectEventDetail",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when a user selects a tab.",
           "docsTags": []
+        },
+        {
+          "event": "tabSelect",
+          "detail": "IcTabSelectEventDetail",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "This event should not be used anymore. Use icTabSelect instead."
+            }
+          ],
+          "deprecation": "This event should not be used anymore. Use icTabSelect instead."
         }
       ],
       "listeners": [
@@ -7766,7 +8016,7 @@
           "type": "boolean",
           "mutable": false,
           "attr": "readonly",
-          "reflectToAttr": false,
+          "reflectToAttr": true,
           "docs": "If `true`, the read only state will be set.",
           "docsTags": [],
           "default": "false",
@@ -7834,7 +8084,7 @@
           "type": "boolean",
           "mutable": false,
           "attr": "small",
-          "reflectToAttr": false,
+          "reflectToAttr": true,
           "docs": "If `true`, the small styling will be applied to the text field.",
           "docsTags": [],
           "default": "false",
@@ -8124,17 +8374,7 @@
         }
       ],
       "methods": [],
-      "events": [
-        {
-          "event": "icThemeChange",
-          "detail": "{ mode: IcThemeForeground; color: IcColorRGB; }",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when the theme is changed.",
-          "docsTags": []
-        }
-      ],
+      "events": [],
       "listeners": [],
       "styles": [],
       "slots": [],
@@ -8152,6 +8392,23 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "disableHover",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disable-hover",
+          "reflectToAttr": false,
+          "docs": "If `true`, the tooltip will not be displayed on hover, it will require a click.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "label",
           "type": "string",
@@ -8255,6 +8512,7 @@
       "parts": [],
       "dependents": [
         "ic-button",
+        "ic-chip",
         "ic-navigation-item",
         "ic-tab-group"
       ],
@@ -8268,6 +8526,9 @@
         "ic-button": [
           "ic-tooltip"
         ],
+        "ic-chip": [
+          "ic-tooltip"
+        ],
         "ic-navigation-item": [
           "ic-tooltip"
         ],
@@ -8436,7 +8697,7 @@
           "passive": false
         },
         {
-          "event": "icThemeChange",
+          "event": "themeChange",
           "target": "document",
           "capture": false,
           "passive": false
@@ -8592,6 +8853,7 @@
         "ic-back-to-top",
         "ic-card",
         "ic-checkbox",
+        "ic-chip",
         "ic-classification-banner",
         "ic-data-entity",
         "ic-data-row",
@@ -8631,6 +8893,9 @@
         "ic-checkbox": [
           "ic-typography"
         ],
+        "ic-chip": [
+          "ic-typography"
+        ],
         "ic-classification-banner": [
           "ic-typography"
         ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukic/docs",
-  "version": "2.1.0-beta.2",
+  "version": "2.1.0-beta.3",
   "description": "API documentation for @ukic components",
   "main": "docs.json",
   "types": "docs.d.ts",
@@ -9,5 +9,5 @@
     "docs.d.ts"
   ],
   "license": "MIT",
-  "gitHead": "5e0df20dde95a24afed14480113caa794c72126f"
+  "gitHead": "686f9e439d6d7a8b9ab5e7abb7c31ddfc4825e5d"
 }