@carbon/ibm-products-web-components/custom-elements.json

Carbon for IBM Products Web Components

{
  "version": "experimental",
  "tags": [
    {
      "name": "c4p-about-modal",
      "path": "./src/components/about-modal/about-modal.ts",
      "description": "About Modal.",
      "attributes": [
        {
          "name": "open",
          "description": "Determines if About Modal is open or not.",
          "type": "boolean",
          "default": "true"
        },
        {
          "name": "closeIconDescription",
          "description": "Determines if About Modal is open or not.",
          "type": "string",
          "default": "\"close\""
        },
        {
          "name": "copyrightText",
          "description": "Determines if About Modal is open or not."
        },
        {
          "name": "logo",
          "description": "A visual symbol used to represent the product."
        },
        {
          "name": "version",
          "description": "Text that provides information on the version number of your product."
        },
        {
          "name": "title",
          "description": "Header text that provides the product name. The IBM Services logo consists of two discrete, but required, elements: the iconic IBM 8-bar logo represented alongside the IBM Services logotype. Please follow these guidelines to ensure proper execution."
        },
        {
          "name": "additionalInfo",
          "description": "If you are legally required to display logos of technologies used to build your product you can provide this in the additionalInfo. Additional information will be displayed in the footer."
        },
        {
          "name": "content",
          "description": "Subhead text providing any relevant product disclaimers including legal information (optional)"
        },
        {
          "name": "links",
          "description": "An array of Carbon `Link` component if there are additional information to call out within the card. The about modal should be used to display the product information and not where users go to find help (optional)"
        }
      ],
      "properties": [
        {
          "name": "open",
          "attribute": "open",
          "description": "Determines if About Modal is open or not.",
          "type": "boolean",
          "default": "true"
        },
        {
          "name": "closeIconDescription",
          "attribute": "closeIconDescription",
          "description": "Determines if About Modal is open or not.",
          "type": "string",
          "default": "\"close\""
        },
        {
          "name": "copyrightText",
          "attribute": "copyrightText",
          "description": "Determines if About Modal is open or not."
        },
        {
          "name": "logo",
          "attribute": "logo",
          "description": "A visual symbol used to represent the product."
        },
        {
          "name": "version",
          "attribute": "version",
          "description": "Text that provides information on the version number of your product."
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Header text that provides the product name. The IBM Services logo consists of two discrete, but required, elements: the iconic IBM 8-bar logo represented alongside the IBM Services logotype. Please follow these guidelines to ensure proper execution."
        },
        {
          "name": "additionalInfo",
          "attribute": "additionalInfo",
          "description": "If you are legally required to display logos of technologies used to build your product you can provide this in the additionalInfo. Additional information will be displayed in the footer."
        },
        {
          "name": "content",
          "attribute": "content",
          "description": "Subhead text providing any relevant product disclaimers including legal information (optional)"
        },
        {
          "name": "links",
          "attribute": "links",
          "description": "An array of Carbon `Link` component if there are additional information to call out within the card. The about modal should be used to display the product information and not where users go to find help (optional)"
        },
        {
          "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": "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-about-modal-beingclosed",
          "description": "The custom event fired before this about modal is being closed upon a user gesture.\nCancellation of this event stops the user-initiated action of closing this about modal."
        },
        {
          "name": "c4p-about-modal-closed",
          "description": "The custom event fired after this about modal is closed upon a user gesture."
        }
      ]
    },
    {
      "name": "c4p-checklist-chart",
      "path": "./src/components/checklist/checklist-chart.ts",
      "attributes": [
        {
          "name": "value",
          "description": "A number between 0 and 1 which indicates the progress of checklist",
          "type": "number",
          "default": "0"
        }
      ],
      "properties": [
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "value",
          "attribute": "value",
          "description": "A number between 0 and 1 which indicates the progress of checklist",
          "type": "number",
          "default": "0"
        }
      ]
    },
    {
      "name": "c4p-checklist-group",
      "path": "./src/components/checklist/checklist-group.ts",
      "description": "Sections in c4p-checklist",
      "attributes": [
        {
          "name": "title",
          "description": "Title text of the c4p-checklist-group"
        }
      ],
      "properties": [
        {
          "name": "title",
          "attribute": "title",
          "description": "Title text of the c4p-checklist-group"
        },
        {
          "name": "styles",
          "default": "\"styles\""
        }
      ],
      "slots": [
        {
          "name": "default",
          "description": "Contains one or more `c4p-checklist-item` components"
        }
      ]
    },
    {
      "name": "c4p-checklist-icon",
      "path": "./src/components/checklist/checklist-icon.ts",
      "attributes": [
        {
          "name": "kind",
          "description": "The icon to be displayed.\nValues can be 'unchecked', 'indeterminate', 'checked', 'error', 'disabled'",
          "type": "Kinds",
          "default": "\"unchecked\""
        }
      ],
      "properties": [
        {
          "name": "kind",
          "attribute": "kind",
          "description": "The icon to be displayed.\nValues can be 'unchecked', 'indeterminate', 'checked', 'error', 'disabled'",
          "type": "Kinds",
          "default": "\"unchecked\""
        },
        {
          "name": "styles",
          "default": "\"styles\""
        }
      ]
    },
    {
      "name": "c4p-checklist-item",
      "path": "./src/components/checklist/checklist-item.ts",
      "description": "item in c4p-checklist-group",
      "attributes": [
        {
          "name": "label",
          "description": "label of the c4p-checklist-item"
        },
        {
          "name": "status",
          "description": "status of the c4p-checklist-item\nValues can be 'not started', 'in progress', 'completed', 'error', 'disabled'"
        },
        {
          "name": "clickable",
          "description": "When true, makes the checklist item label clickable",
          "type": "boolean",
          "default": "false"
        }
      ],
      "properties": [
        {
          "name": "label",
          "attribute": "label",
          "description": "label of the c4p-checklist-item"
        },
        {
          "name": "status",
          "attribute": "status",
          "description": "status of the c4p-checklist-item\nValues can be 'not started', 'in progress', 'completed', 'error', 'disabled'"
        },
        {
          "name": "clickable",
          "attribute": "clickable",
          "description": "When true, makes the checklist item label clickable",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "styles",
          "default": "\"styles\""
        }
      ],
      "events": [
        {
          "name": "c4p-checklist-item-clicked",
          "description": "The custom event which is fired when a user clicks on checklist item with clickable attribute."
        }
      ],
      "slots": [
        {
          "name": "icon",
          "description": "checklist item icon, usually a status indicator icon"
        },
        {
          "name": "content",
          "description": "checklist item title/description"
        }
      ]
    },
    {
      "name": "c4p-checklist",
      "path": "./src/components/checklist/checklist.ts",
      "attributes": [
        {
          "name": "open",
          "description": "Specifies whether the component is opened or closed.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "title",
          "description": "The title of the component."
        },
        {
          "name": "chart-label",
          "description": "The label for progress indicator chart"
        },
        {
          "name": "chart-value",
          "description": "A number between 0 and 1 which indicates the progress of checklist"
        },
        {
          "name": "disable-toggle",
          "description": "Whether or not to show the open/close toggle.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "toggle-label",
          "description": "The label for the toggle's tooltip."
        },
        {
          "name": "toggle-label-align",
          "description": "The alignment of the toggle's tooltip."
        },
        {
          "name": "toggle-aria-label",
          "description": "Aria-label for the Checklist's toggle component."
        },
        {
          "name": "view-all-label",
          "description": "If defined, will show and enable the \"View all (#)\" button in the checklist footer."
        }
      ],
      "properties": [
        {
          "name": "open",
          "attribute": "open",
          "description": "Specifies whether the component is opened or closed.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "The title of the component."
        },
        {
          "name": "chartLabel",
          "attribute": "chart-label",
          "description": "The label for progress indicator chart"
        },
        {
          "name": "chartValue",
          "attribute": "chart-value",
          "description": "A number between 0 and 1 which indicates the progress of checklist"
        },
        {
          "name": "disableToggle",
          "attribute": "disable-toggle",
          "description": "Whether or not to show the open/close toggle.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "toggleLabel",
          "attribute": "toggle-label",
          "description": "The label for the toggle's tooltip."
        },
        {
          "name": "toggleLabelAlign",
          "attribute": "toggle-label-align",
          "description": "The alignment of the toggle's tooltip."
        },
        {
          "name": "toggleAriaLabel",
          "attribute": "toggle-aria-label",
          "description": "Aria-label for the Checklist's toggle component."
        },
        {
          "name": "viewAllLabel",
          "attribute": "view-all-label",
          "description": "If defined, will show and enable the \"View all (#)\" button in the checklist footer."
        },
        {
          "name": "styles",
          "default": "\"styles\""
        }
      ],
      "events": [
        {
          "name": "c4p-checklist-view-all",
          "description": "The custom event which is fired when a user clicks on View All button in checklist footer."
        },
        {
          "name": "c4p-checklist-toggle",
          "description": "The custom event which is fired when user clicks on toggle button in checklist header."
        }
      ],
      "slots": [
        {
          "name": "checklist-header",
          "description": "Header area which includes the title and the progress indicator."
        },
        {
          "name": "default",
          "description": "Contains one or more `c4p-checklist-group` components to organize tasks into logical groups."
        },
        {
          "name": "checklist-footer",
          "description": "Optional footer area for actions like buttons, links, or additional notes."
        }
      ]
    },
    {
      "name": "c4p-coachmark-beacon",
      "path": "./src/components/coachmark/coachmark-beacon/coachmark-beacon.ts",
      "description": "CoachmarkBeacon.",
      "attributes": [
        {
          "name": "kind",
          "description": "What style of beacon.\nBEACON_KIND is an enum from the Coachmark and can be used for this value.",
          "type": "BEACON_KIND | undefined",
          "default": "\"default\""
        },
        {
          "name": "label",
          "description": "The aria label.",
          "type": "string",
          "default": "\"Show information\""
        },
        {
          "name": "id",
          "description": "id for the coachmark beacon",
          "type": "string",
          "default": "\"crypto.randomUUID()\""
        },
        {
          "name": "expanded",
          "description": "specify aria-expanded of beacon",
          "type": "boolean",
          "default": "false"
        }
      ],
      "properties": [
        {
          "name": "kind",
          "attribute": "kind",
          "description": "What style of beacon.\nBEACON_KIND is an enum from the Coachmark and can be used for this value.",
          "type": "BEACON_KIND | undefined",
          "default": "\"default\""
        },
        {
          "name": "label",
          "attribute": "label",
          "description": "The aria label.",
          "type": "string",
          "default": "\"Show information\""
        },
        {
          "name": "id",
          "attribute": "id",
          "description": "id for the coachmark beacon",
          "type": "string",
          "default": "\"crypto.randomUUID()\""
        },
        {
          "name": "expanded",
          "attribute": "expanded",
          "description": "specify aria-expanded of beacon",
          "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": "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-beacon-clicked",
          "description": "Custom event fired when beacon is clicked"
        }
      ]
    },
    {
      "name": "c4p-coachmark-body",
      "path": "./src/components/coachmark/coachmark-body.ts",
      "description": "coachmark-body for content body",
      "properties": [
        {
          "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"
        },
        {
          "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": "length",
          "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
          "type": "number"
        }
      ]
    },
    {
      "name": "c4p-coachmark-header",
      "path": "./src/components/coachmark/coachmark-header.ts",
      "description": "coachmark-header for content header section",
      "attributes": [
        {
          "name": "closeIconDescription",
          "description": "Tooltip text and aria label for the Close button icon.",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "name": "dragIconDescription",
          "description": "Tooltip text and aria label for the Drag button icon.",
          "type": "string | undefined",
          "default": "\"\""
        }
      ],
      "properties": [
        {
          "name": "closeIconDescription",
          "attribute": "closeIconDescription",
          "description": "Tooltip text and aria label for the Close button icon.",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "name": "dragIconDescription",
          "attribute": "dragIconDescription",
          "description": "Tooltip text and aria label for the Drag button icon.",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "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"
        },
        {
          "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": "length",
          "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
          "type": "number"
        }
      ]
    },
    {
      "name": "c4p-coachmark",
      "path": "./src/components/coachmark/coachmark.ts",
      "description": "coachmark main component",
      "attributes": [
        {
          "name": "open",
          "description": "Specifies whether the component is currently open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "align",
          "description": "Where to render the Coachmark relative to its target.",
          "type": "string | undefined",
          "default": "\"top\""
        },
        {
          "name": "position",
          "description": "Fine tune the position of the target in pixels.",
          "type": "{ x: number; y: number; } | undefined"
        },
        {
          "name": "floating",
          "description": "Specifies whether the component is floating or not.",
          "type": "boolean | undefined",
          "default": "false"
        },
        {
          "name": "highContrast",
          "description": "Specify whether the component should be rendered on high-contrast.",
          "type": "boolean | undefined",
          "default": "false"
        },
        {
          "name": "dropShadow",
          "description": "Specify whether a drop shadow should be rendered on the popover.",
          "type": "boolean | undefined",
          "default": "false"
        }
      ],
      "properties": [
        {
          "name": "open",
          "attribute": "open",
          "description": "Specifies whether the component is currently open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "align",
          "attribute": "align",
          "description": "Where to render the Coachmark relative to its target.",
          "type": "string | undefined",
          "default": "\"top\""
        },
        {
          "name": "position",
          "attribute": "position",
          "description": "Fine tune the position of the target in pixels.",
          "type": "{ x: number; y: number; } | undefined"
        },
        {
          "name": "floating",
          "attribute": "floating",
          "description": "Specifies whether the component is floating or not.",
          "type": "boolean | undefined",
          "default": "false"
        },
        {
          "name": "highContrast",
          "attribute": "highContrast",
          "description": "Specify whether the component should be rendered on high-contrast.",
          "type": "boolean | undefined",
          "default": "false"
        },
        {
          "name": "dropShadow",
          "attribute": "dropShadow",
          "description": "Specify whether a drop shadow should be rendered on the popover.",
          "type": "boolean | undefined",
          "default": "false"
        },
        {
          "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"
        },
        {
          "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": "length",
          "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
          "type": "number"
        }
      ]
    },
    {
      "name": "c4p-full-page-error",
      "path": "./src/components/full-page-error/full-page-error.ts",
      "description": "FullPageError.",
      "attributes": [
        {
          "name": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ],
      "properties": [
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "label",
          "attribute": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "attribute": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "attribute": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ]
    },
    {
      "name": "elementName",
      "path": "./src/components/full-page-error/full-page-error.ts",
      "description": "FullPageError.",
      "attributes": [
        {
          "name": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ],
      "properties": [
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "label",
          "attribute": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "attribute": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "attribute": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ]
    },
    {
      "name": "c4p-guide-banner",
      "path": "./src/components/guide-banner/guide-banner.ts",
      "description": "OptionsTile.",
      "attributes": [
        {
          "name": "collapseText",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "name": "expandText",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "name": "open",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "titleText",
          "type": "string | undefined",
          "default": "\"\""
        }
      ],
      "properties": [
        {
          "name": "collapseText",
          "attribute": "collapseText",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "name": "expandText",
          "attribute": "expandText",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "name": "open",
          "attribute": "open",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "titleText",
          "attribute": "titleText",
          "type": "string | undefined",
          "default": "\"\""
        },
        {
          "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": "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-guide-banner-toggle",
          "description": "Custom event fired when tile is opened"
        },
        {
          "name": "c4p-guide-banner-close",
          "description": "Custom event fired when tile is closed"
        }
      ],
      "cssParts": [
        {
          "name": "guide",
          "description": "banner The options tile"