@carbon/ibm-products-web-components 0.31.0 → 0.32.0-rc.0

package/custom-elements.json

@@ -172,6 +172,159 @@
         }
       ]
     },
+    {
+      "name": "c4p-big-number-skeleton",
+      "path": "./src/components/big-number/big-number-skeleton.ts",
+      "attributes": [
+        {
+          "name": "size",
+          "type": "\"default\" | \"lg\" | \"xl\" | undefined",
+          "default": "\"default\""
+        }
+      ],
+      "properties": [
+        {
+          "name": "size",
+          "attribute": "size",
+          "type": "\"default\" | \"lg\" | \"xl\" | undefined",
+          "default": "\"default\""
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "c4p-big-number",
+      "path": "./src/components/big-number/big-number.ts",
+      "attributes": [
+        {
+          "name": "fraction-digits",
+          "type": "number",
+          "default": "1"
+        },
+        {
+          "name": "label",
+          "type": "string | undefined"
+        },
+        {
+          "name": "loading",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "locale",
+          "type": "string",
+          "default": "\"en-US\""
+        },
+        {
+          "name": "percentage",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "size",
+          "type": "\"default\" | \"lg\" | \"xl\"",
+          "default": "\"default\""
+        },
+        {
+          "name": "total",
+          "type": "number | undefined"
+        },
+        {
+          "name": "trending",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "truncate",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "value",
+          "type": "number | undefined"
+        }
+      ],
+      "properties": [
+        {
+          "name": "fractionDigits",
+          "attribute": "fraction-digits",
+          "type": "number",
+          "default": "1"
+        },
+        {
+          "name": "label",
+          "attribute": "label",
+          "type": "string | undefined"
+        },
+        {
+          "name": "loading",
+          "attribute": "loading",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "locale",
+          "attribute": "locale",
+          "type": "string",
+          "default": "\"en-US\""
+        },
+        {
+          "name": "percentage",
+          "attribute": "percentage",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "size",
+          "attribute": "size",
+          "type": "\"default\" | \"lg\" | \"xl\"",
+          "default": "\"default\""
+        },
+        {
+          "name": "total",
+          "attribute": "total",
+          "type": "number | undefined"
+        },
+        {
+          "name": "trending",
+          "attribute": "trending",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "truncate",
+          "attribute": "truncate",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "value",
+          "attribute": "value",
+          "type": "number | undefined"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ],
+      "slots": [
+        {
+          "name": "label",
+          "description": "Header area that displays the label above the value. This slot can be customized to include an info icon and a tooltip for additional context."
+        },
+        {
+          "name": "trending-icon",
+          "description": "Displays an icon indicating trend direction. Can be customized to show a downward arrow when the trend is not upward."
+        },
+        {
+          "name": "icon-button",
+          "description": "Displays an icon button next to `value`."
+        }
+      ]
+    },
     {
       "name": "c4p-checklist-chart",
       "path": "./src/components/checklist/checklist-chart.ts",
@@ -850,6 +1003,132 @@
         }
       ]
     },
+    {
+      "name": "c4p-coachmark-tagline",
+      "path": "./src/components/coachmark/coachmark-tagline/coachmark-tagline.ts",
+      "description": "DO NOT USE. This component is for the exclusive use\nof other Onboarding components.\n\nCoachmark tagline component.",
+      "attributes": [
+        {
+          "name": "close-icon-description",
+          "description": "Tooltip text and aria label for the Close button icon.",
+          "type": "string",
+          "default": "\"Close\""
+        },
+        {
+          "name": "title",
+          "description": "The title of the tagline.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "open",
+          "description": "Whether the tagline is open.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "closeIconDescription",
+          "attribute": "close-icon-description",
+          "description": "Tooltip text and aria label for the Close button icon.",
+          "type": "string",
+          "default": "\"Close\""
+        },
+        {
+          "name": "title",
+          "attribute": "title",
+          "description": "The title of the tagline.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "open",
+          "attribute": "open",
+          "description": "Whether the tagline is open.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "shadowRootOptions",
+          "type": "{ delegatesFocus: boolean; mode: ShadowRootMode; slotAssignment?: SlotAssignmentMode | undefined; customElements?: CustomElementRegistry | undefined; registry?: CustomElementRegistry | undefined; }",
+          "default": "{\"delegatesFocus\":true}"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "type": "number"
+        },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "set-of-actions",
+          "type": "SetOfActions"
+        },
+        {
+          "name": "set-of-breadcrumbs",
+          "type": "SetOfBreadcrumbs"
+        },
+        {
+          "name": "set-of-tags",
+          "type": "SetOfTags"
+        },
+        {
+          "name": "set-of-users",
+          "type": "SetOfUsers"
+        },
+        {
+          "name": "step-group",
+          "type": "StepGroup"
+        },
+        {
+          "name": "step-tearsheet",
+          "type": "StepTearsheet"
+        },
+        {
+          "name": "step-full-page",
+          "type": "StepFullPage"
+        },
+        {
+          "name": "step-side-panel",
+          "type": "StepSidePanel"
+        },
+        {
+          "name": "length",
+          "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
+          "type": "number"
+        }
+      ],
+      "events": [
+        {
+          "name": "c4p-coachmark-tagline-close",
+          "description": "Custom event fired when close button is clicked"
+        },
+        {
+          "name": "c4p-coachmark-tagline-cta-click",
+          "description": "Custom event fired when tagline CTA is clicked"
+        }
+      ]
+    },
     {
       "name": "c4p-coachmark",
       "path": "./src/components/coachmark/coachmark.ts",
@@ -1180,10 +1459,85 @@
         }
       ]
     },
+    {
+      "name": "c4p-guide-banner-element",
+      "path": "./src/components/guide-banner/guide-banner-element.ts",
+      "description": "GuideBannerElement.",
+      "properties": [
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "type": "number"
+        },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "set-of-actions",
+          "type": "SetOfActions"
+        },
+        {
+          "name": "set-of-breadcrumbs",
+          "type": "SetOfBreadcrumbs"
+        },
+        {
+          "name": "set-of-tags",
+          "type": "SetOfTags"
+        },
+        {
+          "name": "set-of-users",
+          "type": "SetOfUsers"
+        },
+        {
+          "name": "step-group",
+          "type": "StepGroup"
+        },
+        {
+          "name": "step-tearsheet",
+          "type": "StepTearsheet"
+        },
+        {
+          "name": "step-full-page",
+          "type": "StepFullPage"
+        },
+        {
+          "name": "step-side-panel",
+          "type": "StepSidePanel"
+        },
+        {
+          "name": "length",
+          "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
+          "type": "number"
+        }
+      ],
+      "cssParts": [
+        {
+          "name": "guide-banner-element"
+        }
+      ]
+    },
     {
       "name": "c4p-guide-banner",
       "path": "./src/components/guide-banner/guide-banner.ts",
-      "description": "OptionsTile.",
+      "description": "GuideBanner.",
       "attributes": [
         {
           "name": "collapseText",
@@ -1298,17 +1652,16 @@
       "events": [
         {
           "name": "c4p-guide-banner-toggle",
-          "description": "Custom event fired when tile is opened"
+          "description": "Custom event fired when banner is opened"
         },
         {
           "name": "c4p-guide-banner-close",
-          "description": "Custom event fired when tile is closed"
+          "description": "Custom event fired when banner is closed"
         }
       ],
       "cssParts": [
         {
-          "name": "guide",
-          "description": "banner The options tile"
+          "name": "guide-banner"
         }
       ]
     },
@@ -1420,10 +1773,66 @@
           "type": "\"single\" | \"multi\"",
           "default": "\"multi\""
         },
+        {
+          "name": "enabledWarnings",
+          "description": "Read or set all the enabled warning categories for this class.\n\nThis property is only used in development builds.",
+          "type": "WarningKind[] | undefined"
+        },
+        {
+          "name": "enableWarning",
+          "description": "Enable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Enable for all ReactiveElement subclasses\nReactiveElement.enableWarning?.('migration');\n\n// Enable for only MyElement and subclasses\nMyElement.enableWarning?.('migration');\n```",
+          "type": "((warningKind: WarningKind) => void) | undefined"
+        },
+        {
+          "name": "disableWarning",
+          "description": "Disable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Disable for all ReactiveElement subclasses\nReactiveElement.disableWarning?.('migration');\n\n// Disable for only MyElement and subclasses\nMyElement.disableWarning?.('migration');\n```",
+          "type": "((warningKind: WarningKind) => void) | undefined"
+        },
+        {
+          "name": "elementProperties",
+          "description": "Memoized list of all element properties, including any superclass\nproperties. Created lazily on user subclasses when finalizing the class.",
+          "type": "PropertyDeclarationMap"
+        },
+        {
+          "name": "properties",
+          "description": "User-supplied object that maps property names to `PropertyDeclaration`\nobjects containing options for configuring reactive properties. When\na reactive property is set the element will update and render.\n\nBy default properties are public fields, and as such, they should be\nconsidered as primarily settable by element users, either via attribute or\nthe property itself.\n\nGenerally, properties that are changed by the element should be private or\nprotected fields and should use the `state: true` option. Properties\nmarked as `state` do not reflect from the corresponding attribute\n\nHowever, sometimes element code does need to set a public property. This\nshould typically only be done in response to user interaction, and an event\nshould be fired informing the user; for example, a checkbox sets its\n`checked` property when clicked and fires a `changed` event. Mutating\npublic properties should typically not be done for non-primitive (object or\narray) properties. In other cases when an element needs to manage state, a\nprivate property set with the `state: true` option should be used. When\nneeded, state properties can be initialized via public properties to\nfacilitate complex interactions.",
+          "type": "PropertyDeclarations"
+        },
+        {
+          "name": "elementStyles",
+          "description": "Memoized list of all element styles.\nCreated lazily on user subclasses when finalizing the class.",
+          "type": "CSSResultOrNative[]"
+        },
         {
           "name": "styles",
+          "description": "[object Object],[object Object],[object Object]",
           "default": "\"styles\""
         },
+        {
+          "name": "shadowRootOptions",
+          "description": "Options used when calling `attachShadow`. Set this property to customize\nthe options for the shadowRoot; for example, to create a closed\nshadowRoot: `{mode: 'closed'}`.\n\nNote, these options are used in `createRenderRoot`. If this method\nis customized, options should be respected if possible.",
+          "type": "ShadowRootInit"
+        },
+        {
+          "name": "renderRoot",
+          "description": "Node or ShadowRoot into which element DOM should be rendered. Defaults\nto an open shadowRoot.",
+          "type": "HTMLElement | DocumentFragment"
+        },
+        {
+          "name": "isUpdatePending",
+          "description": "True if there is a pending update as a result of calling `requestUpdate()`.\nShould only be read.",
+          "type": "boolean"
+        },
+        {
+          "name": "hasUpdated",
+          "description": "Is set to `true` after the first update. The element code cannot assume\nthat `renderRoot` exists before the element `hasUpdated`.",
+          "type": "boolean"
+        },
+        {
+          "name": "updateComplete",
+          "description": "Returns a Promise that resolves when the element has completed updating.\nThe Promise value is a boolean that is `true` if the element completed the\nupdate without triggering another update. The Promise result is `false` if\na property was set inside `updated()`. If the Promise is rejected, an\nexception was thrown during the update.\n\nTo await additional asynchronous work, override the `getUpdateComplete`\nmethod. For example, it is sometimes useful to await a rendered element\nbefore fulfilling this Promise. To do this, first await\n`super.getUpdateComplete()`, then any subsequent state.",
+          "type": "Promise<boolean>"
+        },
         {
           "name": "size",
           "type": "number"