@ukic/web-components 3.0.0-alpha.3 → 3.0.0-alpha.5

package/vscode-data.json

@@ -38,6 +38,21 @@
               "name": "small"
             }
           ]
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -52,21 +67,6 @@
           "name": "accessible-button-label",
           "description": "The accessible button label to provide more context to the 'See all/Hide all' button for screen reader users."
         },
-        {
-          "name": "appearance",
-          "description": "The appearance of the accordion group, e.g dark, or light.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            },
-            {
-              "name": "light"
-            }
-          ]
-        },
         {
           "name": "expanded",
           "description": "If `true`, the accordion will load in an expanded state."
@@ -93,6 +93,21 @@
               "name": "small"
             }
           ]
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -123,6 +138,21 @@
           "name": "show-default-icon",
           "description": "If `true`, the default icon for the neutral variant will appear on the left of the alert."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "title-above",
           "description": "If `true`, the title and message will appear above and below instead of inline."
@@ -161,6 +191,21 @@
           "name": "target",
           "description": "The ID of the element to jump back to when the link is clicked."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "variant",
           "description": "The variant of the button to render",
@@ -359,21 +404,6 @@
           "name": "accept",
           "description": "If `fileUpload` is set to `true`, this is the accepted list of file types."
         },
-        {
-          "name": "appearance",
-          "description": "The appearance of the button, e.g. dark, light, or the default.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            },
-            {
-              "name": "light"
-            }
-          ]
-        },
         {
           "name": "disable-tooltip",
           "description": "If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied."
@@ -442,6 +472,10 @@
           "name": "loading",
           "description": "If `true`, the button will be in loading state."
         },
+        {
+          "name": "monochrome",
+          "description": "If `true`, the button will display as monochromatic in either `light` or `dark` theme."
+        },
         {
           "name": "multiple",
           "description": "If `fileUpload` is set to `true`, this boolean determines whether multiple files are accepted."
@@ -499,6 +533,21 @@
           "name": "target",
           "description": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe)."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "tooltip-placement",
           "description": "The position of the tooltip in relation to the button.",
@@ -651,6 +700,21 @@
         {
           "name": "target",
           "description": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe)."
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -675,7 +739,7 @@
         },
         {
           "name": "checked",
-          "description": "If `true`, the checkbox will be set to the checked state."
+          "description": "If `true`, the checkbox will be set to the checked state. This is only the initial state and will be updated to unchecked if the checkbox is clicked."
         },
         {
           "name": "disabled",
@@ -728,6 +792,21 @@
             }
           ]
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "value",
           "description": "The value for the checkbox."
@@ -780,6 +859,21 @@
             }
           ]
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "validation-status",
           "description": "The validation status - e.g. 'error' | 'warning' | 'success'.",
@@ -1063,6 +1157,21 @@
               "name": "small"
             }
           ]
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -1072,7 +1181,97 @@
         "kind": "markdown",
         "value": ""
       },
-      "attributes": []
+      "attributes": [
+        {
+          "name": "border-style",
+          "description": "The line style of the divider.",
+          "values": [
+            {
+              "name": "dashed"
+            },
+            {
+              "name": "solid"
+            }
+          ]
+        },
+        {
+          "name": "label",
+          "description": "The label for the divider. The label placement will need to be set for the label to be displayed correctly."
+        },
+        {
+          "name": "label-placement",
+          "description": "The position the label is placed on the divider. `Left` and `right` placement is only applicable when orientation is set to `horizontal`. `Top` and `bottom` placement is only applicable when orientation is set to `vertical`. `Center` placement is applicable for both orientations.",
+          "values": [
+            {
+              "name": "bottom"
+            },
+            {
+              "name": "center"
+            },
+            {
+              "name": "left"
+            },
+            {
+              "name": "right"
+            },
+            {
+              "name": "top"
+            }
+          ]
+        },
+        {
+          "name": "monochrome",
+          "description": "If `true`, the divider will be displayed in a grey colour."
+        },
+        {
+          "name": "orientation",
+          "description": "The orientation of the divider.",
+          "values": [
+            {
+              "name": "horizontal"
+            },
+            {
+              "name": "vertical"
+            }
+          ]
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "default"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
+        {
+          "name": "weight",
+          "description": "The thickness of the divider.",
+          "values": [
+            {
+              "name": "medium"
+            },
+            {
+              "name": "thick"
+            },
+            {
+              "name": "thin"
+            },
+            {
+              "name": "very-thick"
+            }
+          ]
+        }
+      ]
     },
     {
       "name": "ic-empty-state",
@@ -1365,18 +1564,6 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "appearance",
-          "description": "The appearance of the input component container.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            }
-          ]
-        },
         {
           "name": "disabled",
           "description": "If `true`, the disabled state will be set."
@@ -1453,18 +1640,6 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "appearance",
-          "description": "The appearance of the input label.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            }
-          ]
-        },
         {
           "name": "disabled",
           "description": "If `true`, the disabled state will be set."
@@ -1816,6 +1991,10 @@
         "value": ""
       },
       "attributes": [
+        {
+          "name": "checked",
+          "description": "If `true`, the menu item will be in a checked state. This is only applicable when variant is set to `toggle`."
+        },
         {
           "name": "description",
           "description": "The description displayed in the menu item, below the label."
@@ -1833,7 +2012,7 @@
           "description": "The human language of the linked URL."
         },
         {
-          "name": "keyboard-shortcut",
+          "name": "keyboard-shortcut-label",
           "description": "The label describing the keyboard shortcut for a menu item's action."
         },
         {
@@ -1959,6 +2138,21 @@
         {
           "name": "target",
           "description": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe)."
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -1976,6 +2170,21 @@
         {
           "name": "label",
           "description": "The label to display on the group."
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -2043,6 +2252,21 @@
         {
           "name": "target",
           "description": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe)."
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -2057,6 +2281,21 @@
           "name": "status",
           "description": "The status info to display."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "version",
           "description": "The version info to display."
@@ -2120,6 +2359,21 @@
         {
           "name": "subheading",
           "description": "The subtitle to render on the page header."
+        },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
         }
       ]
     },
@@ -2134,21 +2388,6 @@
           "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."
         },
-        {
-          "name": "appearance",
-          "description": "The appearance of the pagination, e.g. dark, light or the default.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            },
-            {
-              "name": "light"
-            }
-          ]
-        },
         {
           "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."
@@ -2177,10 +2416,29 @@
           "name": "label",
           "description": "The label for the pagination item (applicable when simple pagination is being used)."
         },
+        {
+          "name": "monochrome",
+          "description": "If `true`, the pagination will display as black in the light theme, and white in dark theme."
+        },
         {
           "name": "pages",
           "description": "The total number of pages."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "type",
           "description": "The type of pagination to be used.",
@@ -2202,21 +2460,6 @@
         "value": ""
       },
       "attributes": [
-        {
-          "name": "appearance",
-          "description": "The appearance of the pagination, e.g. dark, light or the default.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            },
-            {
-              "name": "light"
-            }
-          ]
-        },
         {
           "name": "disabled",
           "description": "If `true`, the pagination item will be disabled."
@@ -2225,6 +2468,10 @@
           "name": "label",
           "description": "The label for the pagination item (applicable when simple pagination is being used)."
         },
+        {
+          "name": "monochrome",
+          "description": "If `true`, the pagination item will display as black in the light theme, and white in dark theme."
+        },
         {
           "name": "page",
           "description": "The current page number."
@@ -2233,6 +2480,21 @@
           "name": "selected",
           "description": "If `true`, the pagination item will be selected."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "type",
           "description": "The type of pagination item - 'page' or 'ellipsis'.",
@@ -2341,6 +2603,21 @@
             }
           ]
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "validation-status",
           "description": "The validation status - e.g. 'error' | 'warning' | 'success'.",
@@ -2409,6 +2686,21 @@
           "name": "selected",
           "description": "If `true`, the radio option will be displayed in a selected state."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "value",
           "description": "The value for the radio option."
@@ -2714,6 +3006,21 @@
           "name": "spellcheck",
           "description": "If `true`, the value of the search will have its spelling and grammar checked."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "timeout",
           "description": "If using external filtering, set a timeout for when loading takes too long."
@@ -2853,7 +3160,7 @@
         },
         {
           "name": "searchable",
-          "description": "If `true`, a searchable variant of the select will be displayed which can be typed in to filter options."
+          "description": "If `true`, a searchable variant of the select will be displayed which can be typed in to filter options. This functionality is only available on the single-select variant of the select component."
         },
         {
           "name": "select-on-enter",
@@ -2878,6 +3185,21 @@
             }
           ]
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "timeout",
           "description": "If using external filtering, set a timeout for when loading takes too long."
@@ -3058,6 +3380,10 @@
             }
           ]
         },
+        {
+          "name": "uppercase",
+          "description": "The letter case of the status tag's label."
+        },
         {
           "name": "variant",
           "description": "The emphasis of the status tag.",
@@ -3642,6 +3968,21 @@
           "name": "spellcheck",
           "description": "If `true`, the value of the text field will have its spelling and grammar checked."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "type",
           "description": "The type of control to display. The default type is text.",
@@ -3807,21 +4148,6 @@
           "name": "accessible-label",
           "description": "The accessible label that will be applied to the toggle button. This is required for the icon variant of toggle buttons."
         },
-        {
-          "name": "appearance",
-          "description": "The appearance of the toggle button.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            },
-            {
-              "name": "light"
-            }
-          ]
-        },
         {
           "name": "checked",
           "description": "If `true`, the toggle button will be in a checked state."
@@ -3857,6 +4183,10 @@
           "name": "loading",
           "description": "If `true`, the toggle button will be in loading state."
         },
+        {
+          "name": "monochrome",
+          "description": "If `true`, the toggle button will display as black in the light theme, and white in dark theme."
+        },
         {
           "name": "size",
           "description": "The size of the toggle button to be displayed.",
@@ -3872,6 +4202,21 @@
             }
           ]
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "variant",
           "description": "The variant of the toggle button.",
@@ -3897,21 +4242,6 @@
           "name": "accessible-label",
           "description": "The accessible label of the toggle button group component to provide context for screen reader users."
         },
-        {
-          "name": "appearance",
-          "description": "The appearance of the toggle button group, e.g dark, or light.",
-          "values": [
-            {
-              "name": "dark"
-            },
-            {
-              "name": "default"
-            },
-            {
-              "name": "light"
-            }
-          ]
-        },
         {
           "name": "disabled",
           "description": "If `true`, the toggle button group will be set to the disabled state."
@@ -3939,6 +4269,10 @@
           "name": "loading",
           "description": "If `true`, the toggle button group will be in loading state."
         },
+        {
+          "name": "monochrome",
+          "description": "If `true`, the toggle button group will display as black in the light theme, and white in dark theme."
+        },
         {
           "name": "select-method",
           "description": "If `auto`, controls are toggled automatically when navigated to. If `manual`, the controls must be actioned to change their toggled state. The value of this prop is ignored if `selectType` is set to`multi`.",
@@ -3978,6 +4312,21 @@
             }
           ]
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "variant",
           "description": "The variant of the toggle button.",
@@ -4120,6 +4469,21 @@
           "name": "status",
           "description": "The status info to be displayed."
         },
+        {
+          "name": "theme",
+          "description": "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.",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "inherit"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
         {
           "name": "version",
           "description": "The version info to be displayed."