@ukic/web-components 2.25.1 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukic/web-components",
-  "version": "2.25.1",
+  "version": "3.0.0",
   "description": "A web component UI library compiled with StencilJS",
   "author": "mi6",
   "bugs": {
@@ -96,5 +96,5 @@
     "webpack": "^5.76.0"
   },
   "license": "MIT",
-  "gitHead": "35e54bc7c26eba6957141079c4a7b71292924d83"
+  "gitHead": "45be51081277aaf71138b200de9fcb59d29be1ca"
 }

package/vscode-data.json

@@ -72,7 +72,7 @@
           "description": "If `true`, the accordion will load in an expanded state."
         },
         {
-          "name": "group-title",
+          "name": "label",
           "description": "The header for the accordion group."
         },
         {
@@ -186,9 +186,13 @@
           "name": "custom-color",
           "description": "The custom badge colour. This will only style the badge component if variant=\"custom\".\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\"."
         },
+        {
+          "name": "label",
+          "description": "The text displayed in the badge. This will only be displayed if type=\"text\"."
+        },
         {
           "name": "max-number",
-          "description": "The maximum number shown on the badge appended with a +.\nThis will only be displayed if type=\"text\" and textLabel is not empty."
+          "description": "The maximum number shown on the badge appended with a +.\nThis will only be displayed if type=\"text\" and label is not empty."
         },
         {
           "name": "position",
@@ -220,10 +224,6 @@
             }
           ]
         },
-        {
-          "name": "text-label",
-          "description": "The text displayed in the badge. This will only be displayed if type=\"text\"."
-        },
         {
           "name": "type",
           "description": "The type of badge to be displayed.",
@@ -549,7 +549,7 @@
       ]
     },
     {
-      "name": "ic-card",
+      "name": "ic-card-vertical",
       "description": {
         "kind": "markdown",
         "value": ""
@@ -666,26 +666,6 @@
           "name": "form",
           "description": "The <form> element to associate the checkbox with."
         },
-        {
-          "name": "formaction",
-          "description": "The URL that processes the information submitted by the checkbox. It overrides the action attribute of the checkbox's form owner. Does nothing if there is no form owner."
-        },
-        {
-          "name": "formenctype",
-          "description": "The way the submitted form data is encoded."
-        },
-        {
-          "name": "formmethod",
-          "description": "The HTTP method used to submit the form."
-        },
-        {
-          "name": "formnovalidate",
-          "description": "If `true`, the form will not be validated when submitted."
-        },
-        {
-          "name": "formtarget",
-          "description": "The place to display the response from submitting the form. It overrides the target attribute of the checkbox's form owner."
-        },
         {
           "name": "group-label",
           "description": "The group label for the checkbox."
@@ -725,10 +705,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "value",
           "description": "The value for the checkbox."
@@ -781,10 +757,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "validation-status",
           "description": "The validation status - e.g. 'error' | 'warning' | 'success'.",
@@ -813,18 +785,6 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "appearance",
-          "description": "",
-          "values": [
-            {
-              "name": "filled"
-            },
-            {
-              "name": "outline"
-            }
-          ]
-        },
         {
           "name": "custom-color",
           "description": "The custom chip colour. This prop will be applied to the chip component if `dismissible` is set to `false`.\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\"."
@@ -921,7 +881,7 @@
       ]
     },
     {
-      "name": "ic-data-entity",
+      "name": "ic-data-list",
       "description": {
         "kind": "markdown",
         "value": ""
@@ -929,11 +889,11 @@
       "attributes": [
         {
           "name": "heading",
-          "description": "The title for the data entity."
+          "description": "The title for the data list."
         },
         {
           "name": "size",
-          "description": "The size of the data entity component.",
+          "description": "The size of the data list component.",
           "values": [
             {
               "name": "default"
@@ -942,10 +902,6 @@
               "name": "small"
             }
           ]
-        },
-        {
-          "name": "small",
-          "description": ""
         }
       ]
     },
@@ -972,10 +928,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "value",
           "description": "The value of the middle (right if no end-component supplied) cell of the row."
@@ -989,17 +941,9 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "alert-heading",
-          "description": ""
-        },
-        {
-          "name": "alert-message",
-          "description": ""
-        },
         {
           "name": "buttons",
-          "description": "If set to `false`, dialog controls will not be displayed overriding buttonProps or slotted dialog controls."
+          "description": "If set to `false`, default buttons or slotted dialog controls will not be displayed."
         },
         {
           "name": "close-on-backdrop-click",
@@ -1051,27 +995,6 @@
               "name": "small"
             }
           ]
-        },
-        {
-          "name": "status",
-          "description": "",
-          "values": [
-            {
-              "name": "error"
-            },
-            {
-              "name": "info"
-            },
-            {
-              "name": "neutral"
-            },
-            {
-              "name": "success"
-            },
-            {
-              "name": "warning"
-            }
-          ]
         }
       ]
     },
@@ -1109,10 +1032,6 @@
           "name": "body",
           "description": "The body text rendered in the empty state container."
         },
-        {
-          "name": "body-max-lines",
-          "description": "The number of lines of body text to display before truncating."
-        },
         {
           "name": "heading",
           "description": "The title rendered in the empty state container."
@@ -1132,6 +1051,10 @@
             }
           ]
         },
+        {
+          "name": "max-lines",
+          "description": "The number of lines of body text to display before truncating."
+        },
         {
           "name": "subheading",
           "description": "The subtitle rendered in the empty state container."
@@ -1266,7 +1189,7 @@
       },
       "attributes": [
         {
-          "name": "group-title",
+          "name": "label",
           "description": "The title of the link group to be displayed."
         }
       ]
@@ -1315,11 +1238,11 @@
         },
         {
           "name": "heading",
-          "description": "The heading of the hero."
+          "description": "The heading of the hero. An <h2> level heading."
         },
         {
           "name": "secondary-heading",
-          "description": "The optional secondary heading, replaced by slotted right content."
+          "description": "The optional secondary heading, an <h3> level heading. Replaced by slotted right content."
         },
         {
           "name": "secondary-subheading",
@@ -1337,10 +1260,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "subheading",
           "description": "The description for the hero."
@@ -1390,10 +1309,6 @@
             }
           ]
         },
-        {
-          "name": "dark",
-          "description": ""
-        },
         {
           "name": "disabled",
           "description": "If `true`, the disabled state will be set."
@@ -1425,10 +1340,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "validation-inline",
           "description": "If `true`, the validation will display inline."
@@ -1486,18 +1397,10 @@
             }
           ]
         },
-        {
-          "name": "dark",
-          "description": ""
-        },
         {
           "name": "disabled",
           "description": "If `true`, the disabled state will be set."
         },
-        {
-          "name": "error",
-          "description": "If `true`, the input label will display with error styling."
-        },
         {
           "name": "for",
           "description": "The ID of the form element the label is bound to."
@@ -1517,6 +1420,15 @@
         {
           "name": "required",
           "description": "If `true`, the input label will require a value."
+        },
+        {
+          "name": "status",
+          "description": "The status of the label - e.g. 'error'.",
+          "values": [
+            {
+              "name": "error"
+            }
+          ]
         }
       ]
     },
@@ -1636,10 +1548,6 @@
           "name": "rel",
           "description": "The relationship of the linked URL as space-separated link types."
         },
-        {
-          "name": "show-icon",
-          "description": ""
-        },
         {
           "name": "target",
           "description": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe)."
@@ -1791,10 +1699,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "value",
           "description": "The value of the currently selected option."
@@ -2118,10 +2022,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "sticky",
           "description": "If `true`, the page header will be sticky at all breakpoints."
@@ -2144,7 +2044,7 @@
       },
       "attributes": [
         {
-          "name": "adjacent-count",
+          "name": "adjacent-page-count",
           "description": "The number of pages displayed adjacent to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2."
         },
         {
@@ -2163,7 +2063,7 @@
           ]
         },
         {
-          "name": "boundary-count",
+          "name": "boundary-page-count",
           "description": "The number of pages displayed as boundary items to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2."
         },
         {
@@ -2339,10 +2239,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "validation-status",
           "description": "The validation status - e.g. 'error' | 'warning' | 'success'.",
@@ -2395,26 +2291,6 @@
           "name": "form",
           "description": "The <form> element to associate the radio with."
         },
-        {
-          "name": "formaction",
-          "description": "The URL that processes the information submitted by the radio. It overrides the action attribute of the radio's form owner. Does nothing if there is no form owner."
-        },
-        {
-          "name": "formenctype",
-          "description": "The way the submitted form data is encoded."
-        },
-        {
-          "name": "formmethod",
-          "description": "The HTTP method used to submit the form."
-        },
-        {
-          "name": "formnovalidate",
-          "description": "If `true`, the form will not be validated when submitted."
-        },
-        {
-          "name": "formtarget",
-          "description": "The place to display the response from submitting the form. It overrides the target attribute of the radio's form owner."
-        },
         {
           "name": "group-label",
           "description": "The group label for the radio option."
@@ -2444,6 +2320,10 @@
         "value": ""
       },
       "attributes": [
+        {
+          "name": "assistive-hint-text",
+          "description": "The hint text for the hidden assistive description element."
+        },
         {
           "name": "autocapitalize",
           "description": "The automatic capitalisation of the text value as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\"."
@@ -2641,7 +2521,7 @@
           "description": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke."
         },
         {
-          "name": "disable-filter",
+          "name": "disable-auto-filtering",
           "description": "Specify whether to disable the built in filtering. For example, if options will already be filtered from external source.\nIf `true`, all options provided will be displayed."
         },
         {
@@ -2668,10 +2548,6 @@
           "name": "hide-label",
           "description": "If `true`, the label will be hidden and the required label value will be applied as an aria-label."
         },
-        {
-          "name": "hint-text",
-          "description": "The hint text for the hidden assistive description element."
-        },
         {
           "name": "label",
           "description": "The label for the search bar."
@@ -2732,10 +2608,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "spellcheck",
           "description": "If `true`, the value of the search will have its spelling and grammar checked."
@@ -2789,16 +2661,12 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "characters-until-suggestions",
-          "description": ""
-        },
         {
           "name": "debounce",
           "description": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke."
         },
         {
-          "name": "disable-filter",
+          "name": "disable-auto-filtering",
           "description": "If `true`, the built in filtering will be disabled for a searchable variant. For example, if options will already be filtered from external source."
         },
         {
@@ -2813,26 +2681,6 @@
           "name": "form",
           "description": "The <form> element to associate the select with."
         },
-        {
-          "name": "formaction",
-          "description": "The URL that processes the information submitted by the select. It overrides the action attribute of the select's form owner. Does nothing if there is no form owner.\nThis prop should only be used with searchable select and will only be applied if searchable is true."
-        },
-        {
-          "name": "formenctype",
-          "description": "The way the submitted form data is encoded. This prop should only be used with searchable select and will only be applied if searchable is true."
-        },
-        {
-          "name": "formmethod",
-          "description": "The HTTP method used to submit the form. This prop should only be used with searchable select and will only be applied if searchable is true."
-        },
-        {
-          "name": "formnovalidate",
-          "description": "If `true`, the form will not be validated when submitted. This prop should only be used with searchable select and will only be applied if searchable is true."
-        },
-        {
-          "name": "formtarget",
-          "description": "The place to display the response from submitting the form. It overrides the target attribute of the select's form owner.\nThis prop should only be used with searchable select and will only be applied if searchable is true."
-        },
         {
           "name": "full-width",
           "description": "If `true`, the select element will fill the width of the container. This prop should only be used with searchable select and will only be applied if searchable is true."
@@ -2924,10 +2772,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "timeout",
           "description": "If using external filtering, set a timeout for when loading takes too long."
@@ -3025,10 +2869,6 @@
             }
           ]
         },
-        {
-          "name": "light",
-          "description": ""
-        },
         {
           "name": "variant",
           "description": "The variant of the skeleton that will be displayed.",
@@ -3057,18 +2897,6 @@
           "name": "announced",
           "description": "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."
         },
-        {
-          "name": "appearance",
-          "description": "",
-          "values": [
-            {
-              "name": "filled"
-            },
-            {
-              "name": "outlined"
-            }
-          ]
-        },
         {
           "name": "label",
           "description": "The content rendered within the status tag."
@@ -3088,10 +2916,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "status",
           "description": "The colour of the status tag.",
@@ -3132,7 +2956,11 @@
       },
       "attributes": [
         {
-          "name": "step-status",
+          "name": "heading",
+          "description": "The title of the step within the stepper."
+        },
+        {
+          "name": "status",
           "description": "The status of the step. Use this prop to display a status message on the step if it is required or optional.",
           "values": [
             {
@@ -3144,15 +2972,11 @@
           ]
         },
         {
-          "name": "step-subtitle",
+          "name": "subheading",
           "description": "Additional information about the step. Use this prop to override the default step status messaging displayed when selecting a step type or step status."
         },
         {
-          "name": "step-title",
-          "description": "The title of the step within the stepper."
-        },
-        {
-          "name": "step-type",
+          "name": "type",
           "description": "The state of the step within the stepper.",
           "values": [
             {
@@ -3271,10 +3095,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "value",
           "description": "The value of the toggle does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a toggle is analogous to the value of a `<input type=\"checkbox\">`,\nit's only used when the toggle participates in a native `<form>`."
@@ -3342,10 +3162,6 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "context-id",
-          "description": ""
-        },
         {
           "name": "inline",
           "description": "If `true`, the tabs and tab panels will be positioned separately."
@@ -3362,12 +3178,7 @@
         "kind": "markdown",
         "value": ""
       },
-      "attributes": [
-        {
-          "name": "context-id",
-          "description": ""
-        }
-      ]
+      "attributes": []
     },
     {
       "name": "ic-text-field",
@@ -3580,6 +3391,10 @@
           "name": "helper-text",
           "description": "The helper text that will be displayed for additional field guidance."
         },
+        {
+          "name": "hide-char-count",
+          "description": "If `true`, the character count which is displayed when `maxCharacters` is set will be visually hidden."
+        },
         {
           "name": "hide-label",
           "description": "If `true`, the label will be hidden and the required label value will be applied as an aria-label."
@@ -3628,11 +3443,7 @@
         },
         {
           "name": "max-characters",
-          "description": "The maximum number of characters that can be entered in the field. Will display an error if too many characters are entered."
-        },
-        {
-          "name": "max-length",
-          "description": "The count of characters in the field. Will display a warning if the bound is reached."
+          "description": "The count of characters in the field. Will display a warning if the bound is reached. (NOTE: If the value of the text field has been set using the `value` prop, it will be truncated to this number of characters)"
         },
         {
           "name": "min",
@@ -3678,10 +3489,6 @@
             }
           ]
         },
-        {
-          "name": "small",
-          "description": ""
-        },
         {
           "name": "spellcheck",
           "description": "If `true`, the value of the text field will have its spelling and grammar checked."
@@ -3851,6 +3658,10 @@
             }
           ]
         },
+        {
+          "name": "checked",
+          "description": "If `true`, the toggle button will be in a checked state."
+        },
         {
           "name": "disabled",
           "description": "If `true`, the toggle button will be in disabled state."
@@ -3897,10 +3708,6 @@
             }
           ]
         },
-        {
-          "name": "toggle-checked",
-          "description": "If `true`, the toggle button will be in a checked state."
-        },
         {
           "name": "variant",
           "description": "The variant of the toggle button.",