@carbon/web-components 2.27.2 → 2.28.0-rc.0

package/custom-elements.json

@@ -5575,7 +5575,7 @@
       ]
     },
     {
-      "name": "cds-file-uploader-container",
+      "name": "cds-file-uploader-button",
       "path": "./src/components/file-uploader/file-uploader-button.ts",
       "description": "File uploader button .",
       "attributes": [
@@ -5887,7 +5887,7 @@
     {
       "name": "cds-file-uploader",
       "path": "./src/components/file-uploader/file-uploader.ts",
-      "description": "The shell UI for file uploader.",
+      "description": "The file uploader component.",
       "attributes": [
         {
           "name": "disabled",
@@ -5934,14 +5934,6 @@
           "name": "styles",
           "default": "\"styles\""
         }
-      ],
-      "slots": [
-        {
-          "name": "label-title."
-        },
-        {
-          "name": "lebel-description."
-        }
       ]
     },
     {
@@ -5971,60 +5963,423 @@
           "default": "false"
         },
         {
-          "name": "message-text",
-          "description": "Provide the text for the message in the Form Group"
-        }
-      ],
-      "properties": [
+          "name": "message-text",
+          "description": "Provide the text for the message in the Form Group"
+        }
+      ],
+      "properties": [
+        {
+          "name": "invalid",
+          "attribute": "invalid",
+          "description": "Specify whether the Form Group is invalid",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "legendId",
+          "attribute": "legend-id",
+          "description": "Provide id for the fieldset <legend> which corresponds to the fieldset\n`aria-labelledby`"
+        },
+        {
+          "name": "legendText",
+          "attribute": "legend-text",
+          "description": "Provide the text to be rendered inside of the fieldset <legend>",
+          "type": "string"
+        },
+        {
+          "name": "message",
+          "attribute": "message",
+          "description": "Specify whether the message should be displayed in the Form Group",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "messageText",
+          "attribute": "message-text",
+          "description": "Provide the text for the message in the Form Group"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "cds-form-item",
+      "path": "./src/components/form/form-item.ts",
+      "description": "Presentational element for form items",
+      "properties": [
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "cds-heading",
+      "path": "./src/components/heading/heading.ts",
+      "description": "The heading component",
+      "properties": [
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "cds-icon-button",
+      "path": "./src/components/icon-button/icon-button.ts",
+      "description": "Icon Button",
+      "attributes": [
+        {
+          "name": "align",
+          "description": "Checks if a badge indicator is being used with incorrect properties",
+          "type": "string",
+          "default": "\"top\""
+        },
+        {
+          "name": "autoalign",
+          "description": "Specify whether a auto align functionality should be applied",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "close-on-activation",
+          "description": "Determines whether the tooltip should close when inner content is activated (click, Enter or Space)",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "defaultOpen",
+          "description": "Specify whether the tooltip should be open when it first renders",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "enter-delay-ms",
+          "description": "Specify the duration in milliseconds to delay before displaying the tooltip",
+          "type": "number",
+          "default": "100"
+        },
+        {
+          "name": "leave-delay-ms",
+          "description": "Specify the duration in milliseconds to delay before hiding the tooltip",
+          "type": "number",
+          "default": "300"
+        },
+        {
+          "name": "autofocus",
+          "description": "`true` if the button should have input focus when the page loads.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "batch-action",
+          "description": "`true` if the button is being used within a data table batch action toolbar",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "button-class-name",
+          "description": "Specify an optional className to be added to your Button"
+        },
+        {
+          "name": "danger-description",
+          "description": "Specify the message read by screen readers for the danger button variant"
+        },
+        {
+          "name": "disabled",
+          "description": "`true` if the button should be disabled.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "download",
+          "description": "The default file name, used if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "has-main-content",
+          "description": "`true` if there is a non-icon content.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "href",
+          "description": "Link `href`. If present, this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "hreflang",
+          "description": "The language of what `href` points to, if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "isExpressive",
+          "description": "`true` if expressive theme enabled.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "isSelected",
+          "description": "Specify whether the Button is currently selected.\nOnly applies to the Ghost variant.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "kind",
+          "description": "Button kind.",
+          "type": "BUTTON_KIND",
+          "default": "\"primary\""
+        },
+        {
+          "name": "link-role",
+          "description": "The a11y role for `<a>`.",
+          "type": "string",
+          "default": "\"button\""
+        },
+        {
+          "name": "openTooltip",
+          "description": "Boolean to determine if tooltip is open.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "ping",
+          "description": "URLs to ping, if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "rel",
+          "description": "The link type, if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "size",
+          "description": "Specify the size of the Button. Defaults to `md`.",
+          "type": "string",
+          "default": "\"md\""
+        },
+        {
+          "name": "target",
+          "description": "The link target, if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "tooltip-alignment",
+          "description": "Specify the alignment of the tooltip to the icon-only button.\nCan be one of: start, center, or end.",
+          "type": "BUTTON_TOOLTIP_ALIGNMENT",
+          "default": "\"\""
+        },
+        {
+          "name": "tooltip-position",
+          "description": "Specify the direction of the tooltip for icon-only buttons.\nCan be either top, right, bottom, or left.",
+          "type": "BUTTON_TOOLTIP_POSITION",
+          "default": "\"top\""
+        },
+        {
+          "name": "tooltip-text",
+          "description": "Specify the text to be rendered in the tooltip. If using\n\"cds-badge-indicator\" with no count prop then the text\nshould include describing there is a new notification.",
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "description": "Button type.",
+          "type": "BUTTON_TYPE",
+          "default": "\"button\""
+        }
+      ],
+      "properties": [
+        {
+          "name": "align",
+          "attribute": "align",
+          "description": "Checks if a badge indicator is being used with incorrect properties",
+          "type": "string",
+          "default": "\"top\""
+        },
+        {
+          "name": "autoalign",
+          "attribute": "autoalign",
+          "description": "Specify whether a auto align functionality should be applied",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "closeOnActivation",
+          "attribute": "close-on-activation",
+          "description": "Determines whether the tooltip should close when inner content is activated (click, Enter or Space)",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "defaultOpen",
+          "attribute": "defaultOpen",
+          "description": "Specify whether the tooltip should be open when it first renders",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "enterDelayMs",
+          "attribute": "enter-delay-ms",
+          "description": "Specify the duration in milliseconds to delay before displaying the tooltip",
+          "type": "number",
+          "default": "100"
+        },
+        {
+          "name": "leaveDelayMs",
+          "attribute": "leave-delay-ms",
+          "description": "Specify the duration in milliseconds to delay before hiding the tooltip",
+          "type": "number",
+          "default": "300"
+        },
+        {
+          "name": "autofocus",
+          "attribute": "autofocus",
+          "description": "`true` if the button should have input focus when the page loads.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "batchAction",
+          "attribute": "batch-action",
+          "description": "`true` if the button is being used within a data table batch action toolbar",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "buttonClassName",
+          "attribute": "button-class-name",
+          "description": "Specify an optional className to be added to your Button"
+        },
+        {
+          "name": "dangerDescription",
+          "attribute": "danger-description",
+          "description": "Specify the message read by screen readers for the danger button variant"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "`true` if the button should be disabled.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "download",
+          "attribute": "download",
+          "description": "The default file name, used if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "hasMainContent",
+          "attribute": "has-main-content",
+          "description": "`true` if there is a non-icon content.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "href",
+          "attribute": "href",
+          "description": "Link `href`. If present, this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "hreflang",
+          "attribute": "hreflang",
+          "description": "The language of what `href` points to, if this button is rendered as `<a>`.",
+          "type": "string"
+        },
+        {
+          "name": "isExpressive",
+          "attribute": "isExpressive",
+          "description": "`true` if expressive theme enabled.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "isSelected",
+          "attribute": "isSelected",
+          "description": "Specify whether the Button is currently selected.\nOnly applies to the Ghost variant.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "kind",
+          "attribute": "kind",
+          "description": "Button kind.",
+          "type": "BUTTON_KIND",
+          "default": "\"primary\""
+        },
+        {
+          "name": "linkRole",
+          "attribute": "link-role",
+          "description": "The a11y role for `<a>`.",
+          "type": "string",
+          "default": "\"button\""
+        },
+        {
+          "name": "openTooltip",
+          "attribute": "openTooltip",
+          "description": "Boolean to determine if tooltip is open.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "ping",
+          "attribute": "ping",
+          "description": "URLs to ping, if this button is rendered as `<a>`.",
+          "type": "string"
+        },
         {
-          "name": "invalid",
-          "attribute": "invalid",
-          "description": "Specify whether the Form Group is invalid",
-          "type": "boolean",
-          "default": "false"
+          "name": "rel",
+          "attribute": "rel",
+          "description": "The link type, if this button is rendered as `<a>`.",
+          "type": "string"
         },
         {
-          "name": "legendId",
-          "attribute": "legend-id",
-          "description": "Provide id for the fieldset <legend> which corresponds to the fieldset\n`aria-labelledby`"
+          "name": "size",
+          "attribute": "size",
+          "description": "Specify the size of the Button. Defaults to `md`.",
+          "type": "string",
+          "default": "\"md\""
         },
         {
-          "name": "legendText",
-          "attribute": "legend-text",
-          "description": "Provide the text to be rendered inside of the fieldset <legend>",
+          "name": "target",
+          "attribute": "target",
+          "description": "The link target, if this button is rendered as `<a>`.",
           "type": "string"
         },
         {
-          "name": "message",
-          "attribute": "message",
-          "description": "Specify whether the message should be displayed in the Form Group",
-          "type": "boolean",
-          "default": "false"
+          "name": "tooltipAlignment",
+          "attribute": "tooltip-alignment",
+          "description": "Specify the alignment of the tooltip to the icon-only button.\nCan be one of: start, center, or end.",
+          "type": "BUTTON_TOOLTIP_ALIGNMENT",
+          "default": "\"\""
         },
         {
-          "name": "messageText",
-          "attribute": "message-text",
-          "description": "Provide the text for the message in the Form Group"
+          "name": "tooltipPosition",
+          "attribute": "tooltip-position",
+          "description": "Specify the direction of the tooltip for icon-only buttons.\nCan be either top, right, bottom, or left.",
+          "type": "BUTTON_TOOLTIP_POSITION",
+          "default": "\"top\""
         },
         {
-          "name": "styles",
-          "default": "\"styles\""
-        }
-      ],
-      "slots": [
+          "name": "tooltipText",
+          "attribute": "tooltip-text",
+          "description": "Specify the text to be rendered in the tooltip. If using\n\"cds-badge-indicator\" with no count prop then the text\nshould include describing there is a new notification.",
+          "type": "string"
+        },
         {
-          "name": "label-title."
+          "name": "type",
+          "attribute": "type",
+          "description": "Button type.",
+          "type": "BUTTON_TYPE",
+          "default": "\"button\""
         },
         {
-          "name": "lebel-description."
-        }
-      ]
-    },
-    {
-      "name": "cds-form-item",
-      "path": "./src/components/form/form-item.ts",
-      "description": "Presentational element for form items",
-      "properties": [
+          "name": "shadowRootOptions",
+          "type": "{ delegatesFocus: boolean; mode: ShadowRootMode; slotAssignment?: SlotAssignmentMode | undefined; customElements?: CustomElementRegistry | undefined; registry?: CustomElementRegistry | undefined; }",
+          "default": "{\"delegatesFocus\":true}"
+        },
         {
           "name": "styles",
           "default": "\"styles\""
@@ -6086,10 +6441,21 @@
       "attributes": [
         {
           "name": "assistive-text",
+          "type": "string",
+          "deprecatedMessage": "The 'assistive-text' property will be deprecated in the next major release. Please use `icon-description` instead."
+        },
+        {
+          "name": "icon-description",
           "description": "The assistive text for the spinner icon.",
           "type": "string",
           "default": "\"Loading\""
         },
+        {
+          "name": "success-delay",
+          "description": "Provide a delay for the setTimeout for success",
+          "type": "number",
+          "default": "1500"
+        },
         {
           "name": "status",
           "description": "The loading status.",
@@ -6101,10 +6467,23 @@
         {
           "name": "assistiveText",
           "attribute": "assistive-text",
+          "type": "string",
+          "deprecatedMessage": "The 'assistive-text' property will be deprecated in the next major release. Please use `icon-description` instead."
+        },
+        {
+          "name": "iconDescription",
+          "attribute": "icon-description",
           "description": "The assistive text for the spinner icon.",
           "type": "string",
           "default": "\"Loading\""
         },
+        {
+          "name": "successDelay",
+          "attribute": "success-delay",
+          "description": "Provide a delay for the setTimeout for success",
+          "type": "number",
+          "default": "1500"
+        },
         {
           "name": "status",
           "attribute": "status",
@@ -6116,6 +6495,12 @@
           "name": "styles",
           "default": "\"styles\""
         }
+      ],
+      "events": [
+        {
+          "name": "cds-inline-loading-onsuccess",
+          "description": "The custom event fired when inline-loading has finished status"
+        }
       ]
     },
     {
@@ -6153,7 +6538,7 @@
       "events": [
         {
           "name": "cds-use-layer",
-          "description": "The name of the custom event fired when the \"use layer\" action occurs."
+          "description": "The custom event that returns the layer level and the layer element."
         }
       ],
       "slots": [
@@ -15668,6 +16053,176 @@
         }
       ]
     },
+    {
+      "name": "cds-definition-tooltip",
+      "path": "./src/components/tooltip/definition-tooltip.ts",
+      "description": "Definition tooltip.",
+      "attributes": [
+        {
+          "name": "align",
+          "description": "Specify how the trigger should align with the tooltip",
+          "type": "string",
+          "default": "\"bottom\""
+        },
+        {
+          "name": "autoalign",
+          "description": "Will auto-align Definition Tooltip. This prop is currently experimental and is subject to future changes.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "default-open",
+          "description": "Specify whether the tooltip should be open when it first renders",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "open-on-hover",
+          "description": "Specifies whether the `DefinitionTooltip` should open on hover or not",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "align",
+          "attribute": "align",
+          "description": "Specify how the trigger should align with the tooltip",
+          "type": "string",
+          "default": "\"bottom\""
+        },
+        {
+          "name": "autoalign",
+          "attribute": "autoalign",
+          "description": "Will auto-align Definition Tooltip. This prop is currently experimental and is subject to future changes.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "defaultOpen",
+          "attribute": "default-open",
+          "description": "Specify whether the tooltip should be open when it first renders",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "openOnHover",
+          "attribute": "open-on-hover",
+          "description": "Specifies whether the `DefinitionTooltip` should open on hover or not",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "open",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "cds-tooltip-content",
+      "path": "./src/components/tooltip/tooltip-content.ts",
+      "description": "Tooltip content.",
+      "attributes": [
+        {
+          "name": "align",
+          "description": "Specify the popover alignment",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "autoalign",
+          "description": "Specify whether a auto align functionality should be applied",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "caret",
+          "description": "Specify whether a caret should be rendered"
+        },
+        {
+          "name": "dropShadow",
+          "description": "Specify whether a dropShadow should be rendered",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "open",
+          "description": "Specify whether the component is currently open or closed",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "tabTip",
+          "description": "Render the component using the tab tip variant",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "slot",
+          "description": "The shadow slot this popover content should be in.",
+          "type": "string",
+          "default": "\"content\""
+        }
+      ],
+      "properties": [
+        {
+          "name": "align",
+          "attribute": "align",
+          "description": "Specify the popover alignment",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "autoalign",
+          "attribute": "autoalign",
+          "description": "Specify whether a auto align functionality should be applied",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "caret",
+          "attribute": "caret",
+          "description": "Specify whether a caret should be rendered"
+        },
+        {
+          "name": "dropShadow",
+          "attribute": "dropShadow",
+          "description": "Specify whether a dropShadow should be rendered",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "open",
+          "attribute": "open",
+          "description": "Specify whether the component is currently open or closed",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "tabTip",
+          "attribute": "tabTip",
+          "description": "Render the component using the tab tip variant",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "slot",
+          "attribute": "slot",
+          "description": "The shadow slot this popover content should be in.",
+          "type": "string",
+          "default": "\"content\""
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
     {
       "name": "cds-tooltip",
       "path": "./src/components/tooltip/tooltip.ts",