@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"
        }
      ],
      "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-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-interstitial-screen-body-item",
      "path": "./src/components/interstitial-screen/interstitial-screen-body-item.ts",
      "description": "interstitial-screen-body-item for body children",
      "attributes": [
        {
          "name": "stepTitle",
          "description": "This will serve the labels for each step",
          "type": "string",
          "default": "\"\""
        }
      ],
      "properties": [
        {
          "name": "stepTitle",
          "attribute": "stepTitle",
          "description": "This will serve the labels for each step",
          "type": "string",
          "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": "c4p-interstitial-screen-body",
      "path": "./src/components/interstitial-screen/interstitial-screen-body.ts",
      "description": "interstitial-screen-body for body section",
      "attributes": [
        {
          "name": "slot",
          "type": "string",
          "default": "\"body\""
        }
      ],
      "properties": [
        {
          "name": "slot",
          "attribute": "slot",
          "type": "string",
          "default": "\"body\""
        },
        {
          "name": "stepType",
          "type": "\"single\" | \"multi\"",
          "default": "\"multi\""
        },
        {
          "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"
        }
      ],
      "events": [
        {
          "name": "c4p-on-before-step-change",
          "description": "The name of the custom event fired at the start of  the step change."
        },
        {
          "name": "c4p-on-after-step-change",
          "description": "The name of the custom event fired at the end of  the step change."
        }
      ]
    },
    {
      "name": "c4p-interstitial-screen-footer",
      "path": "./src/components/interstitial-screen/interstitial-screen-footer.ts",
      "description": "interstitial-screen-footer for footer section",
      "attributes": [
        {
          "name": "nextButtonLabel",
          "description": "The label for the Next button.",
          "type": "string",
          "default": "\"Next\""
        },
        {
          "name": "previousButtonLabel",
          "description": "The label for the Previous button.",
          "type": "string",
          "default": "\"Back\""
        },
        {
          "name": "skipButtonLabel",
          "description": "The label for the skip button.",
          "type": "string",
          "default": "\"Skip\""
        },
        {
          "name": "startButtonLabel",
          "description": "The label for the start button.",
          "type": "string",
          "default": "\"Get Started\""
        },
        {
          "name": "slot",
          "type": "string",
          "default": "\"footer\""
        },
        {
          "name": "async-action",
          "description": "Enables support for asynchronous validation or user confirmation before proceeding\nto the next interstitial step. When set to true, the component will wait for an external\n listener (e.g., a form validation or confirmation modal) to resolve the proceed() callback before continuing.\nWhen asyncAction is true, you must listen for the eventOnBeforeAction event and\ncall the proceed() function (either synchronously or with a promise) to allow navigation."
        }
      ],
      "properties": [
        {
          "name": "nextButtonLabel",
          "attribute": "nextButtonLabel",
          "description": "The label for the Next button.",
          "type": "string",
          "default": "\"Next\""
        },
        {
          "name": "previousButtonLabel",
          "attribute": "previousButtonLabel",
          "description": "The label for the Previous button.",
          "type": "string",
          "default": "\"Back\""
        },
        {
          "name": "skipButtonLabel",
          "attribute": "skipButtonLabel",
          "description": "The label for the skip button.",
          "type": "string",
          "default": "\"Skip\""
        },
        {
          "name": "startButtonLabel",
          "attribute": "startButtonLabel",
          "description": "The label for the start button.",
          "type": "string",
          "default": "\"Get Started\""
        },
        {
          "name": "slot",
          "attribute": "slot",
          "type": "string",
          "default": "\"footer\""
        },
        {
          "name": "asyncAction",
          "attribute": "async-action",
          "description": "Enables support for asynchronous validation or user confirmation before proceeding\nto the next interstitial step. When set to true, the component will wait for an external\n listener (e.g., a form validation or confirmation modal) to resolve the proceed() callback before continuing.\nWhen asyncAction is true, you must listen for the eventOnBeforeAction event and\ncall the proceed() function (either synchronously or with a promise) to allow navigation."
        },
        {
          "name": "loadingAction"
        },
        {
          "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": "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": "hasThreeButtons",
          "description": "`true` if this modal footer has more than two buttons.",
          "type": "boolean"
        },
        {
          "name": "styles",
          "description": "[object Object],[object Object],[object Object]",
          "default": "\"styles\""
        }
      ],
      "events": [
        {
          "name": "c4p-on-action",
          "description": "The name of the custom event fired just before the action. You can use this event to perform any async/sync validation.\nif you pass async-action = true, the component will wait for an external listener (e.g., a form validation or confirmation modal) to resolve the proceed()\ncallback before continuing. When asyncAction is true, you must listen for the eventOnBeforeAction event and call the proceed() function\n(either synchronously or with a promise) to allow navigation."
        }
      ]
    },
    {
      "name": "c4p-interstitial-screen-header",
      "path": "./src/components/interstitial-screen/interstitial-screen-header.ts",
      "description": "interstitial-screen-header for header section",
      "attributes": [
        {
          "name": "header-title",
          "description": "Provide an optional title to be applied to the header.",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "slot",
          "type": "string",
          "default": "\"header\""
        },
        {
          "name": "header-subtitle",
          "description": "Tooltip text and aria label for the Close button icon.",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "closeIconDescription",
          "description": "Tooltip text and aria label for the Close button icon.",
          "type": "string",
          "default": "\"Close\""
        },
        {
          "name": "hideProgressIndicator",
          "description": "Optional parameter to hide the progress indicator when multiple steps are used.",
          "type": "boolean",
          "default": "false"
        }
      ],
      "properties": [
        {
          "name": "headerTitle",
          "attribute": "header-title",
          "description": "Provide an optional title to be applied to the header.",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "slot",
          "attribute": "slot",
          "type": "string",
          "default": "\"header\""
        },
        {
          "name": "headerSubTitle",
          "attribute": "header-subtitle",
          "description": "Tooltip text and aria label for the Close button icon.",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "closeIconDescription",
          "attribute": "closeIconDescription",
          "description": "Tooltip text and aria label for the Close button icon.",
          "type": "string",
          "default": "\"Close\""
        },
        {
          "name": "hideProgressIndicator",
          "attribute": "hideProgressIndicator",
          "description": "Optional parameter to hide the progress indicator when multiple steps are used.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "getElementForAriaLive",
          "type": "() => TemplateResult<1>",
          "default": "\"() => {\\n    const currentStep = interstitialDetailsSignal.get().currentStep;\\n    const stepDetails = interstitialDetailsSignal.get().stepDetails;\\n    return html` <div\\n      aria-live=\\\"polite\\\"\\n      aria-atomic=\\\"true\\\"\\n      class=\\\"${carbonPrefix}--visually-hidden\\\"\\n    >\\n      Step ${currentStep + 1} of ${stepDetails.length}\\n    </div>`;\\n  }\""
        },
        {
          "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": "c4p-interstitial-screen",
      "path": "./src/components/interstitial-screen/interstitial-screen.ts",
      "description": "interstitial-screen main component",
      "attributes": [
        {
          "name": "fullscreen",
          "description": "Specifies whether the component is shown as a full-screen\nexperience, else it is shown as a modal by default.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "open",
          "description": "Specifies whether the component is currently open.",
          "type": "boolean",
          "default": "false"
        }
      ],
      "properties": [
        {
          "name": "isFullScreen",
          "attribute": "fullscreen",
          "description": "Specifies whether the component is shown as a full-screen\nexperience, else it is shown as a modal by default.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "open",
          "attribute": "open",
          "description": "Specifies whether the component is currently open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "stepDetails",
          "type": "{ stepTitle: string; name?: 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"
        }
      ],
      "events": [
        {
          "name": "c4p-interstitial-opened",
          "description": "The custom event triggered after loading the component.\nIts event.detail will provide you with carousal api methods for step navigation and method to disable any action button\n*"
        },
        {
          "name": "c4p-interstitial-beingclosed",
          "description": "The name of the custom event fired before interstitial is being closed upon a user gesture.\nCancellation of this event stops the user-initiated action of closing the interstitial."
        },
        {
          "name": "c4p-interstitial-closed",
          "description": "The name of the custom event fired after this tearsheet is closed upon a user gesture."
        }
      ]
    },
    {
      "name": "c4p-notification-footer",
      "path": "./src/components/notification-panel/notification-footer.ts",
      "description": "Notification Footer.",
      "attributes": [
        {
          "name": "view-all-label",
          "description": "Label for View All Text",
          "type": "string",
          "default": "\"View All\""
        }
      ],
      "properties": [
        {
          "name": "viewAllLabel",
          "attribute": "view-all-label",
          "description": "Label for View All Text",
          "type": "string",
          "default": "\"View All\""
        },
        {
          "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"
        }
      ],
      "events": [
        {
          "name": "c4p-notification-view-all",
          "description": "The custom event is fired when a user clicks on View All button."
        },
        {
          "name": "c4p-notification-settings",
          "description": "The custom event is fired when User clicks on settings button."
        }
      ]
    },
    {
      "name": "c4p-notification-panel",
      "path": "./src/components/notification-panel/notification-panel.ts",
      "description": "NotificationPanel.",
      "attributes": [
        {
          "name": "title-text",
          "description": "Sets the Title for the Notification panel"
        },
        {
          "name": "today-text",
          "description": "Sets the Today text for the Notification panel"
        },
        {
          "name": "previous-text",
          "description": "Sets the Previous section title for the Notification panel"
        },
        {
          "name": "open",
          "description": "Determines whether the notifications panel should render or not",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "dismiss-all-label",
          "description": "Sets the label text for the \"Dismiss all\" button in the Notification panel"
        },
        {
          "name": "empty-state-label",
          "description": "Sets the empty state label text when there are no notifications"
        },
        {
          "name": "donot-disturb-label",
          "description": "Sets the label text for the \"Do Not Disturb\" toggle in the Notification panel"
        },
        {
          "name": "triggerButtonRef",
          "description": "Reference to the trigger button",
          "type": "HTMLElement | undefined"
        },
        {
          "name": "date-time-locale",
          "description": "The language for each notification's time stamp.\nUsed with `dateTimeStyle`.",
          "type": "string | undefined"
        }
      ],
      "properties": [
        {
          "name": "titleText",
          "attribute": "title-text",
          "description": "Sets the Title for the Notification panel"
        },
        {
          "name": "todayText",
          "attribute": "today-text",
          "description": "Sets the Today text for the Notification panel"
        },
        {
          "name": "previousText",
          "attribute": "previous-text",
          "description": "Sets the Previous section title for the Notification panel"
        },
        {
          "name": "open",
          "attribute": "open",
          "description": "Determines whether the notifications panel should render or not",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "dismissAllLabel",
          "attribute": "dismiss-all-label",
          "description": "Sets the label text for the \"Dismiss all\" button in the Notification panel"
        },
        {
          "name": "emptyStateLabel",
          "attribute": "empty-state-label",
          "description": "Sets the empty state label text when there are no notifications"
        },
        {
          "name": "doNotDisturbLabel",
          "attribute": "donot-disturb-label",
          "description": "Sets the label text for the \"Do Not Disturb\" toggle in the Notification panel"
        },
        {
          "name": "triggerButtonRef",
          "attribute": "triggerButtonRef",
          "description": "Reference to the trigger button",
          "type": "HTMLElement | undefined"
        },
        {
          "name": "dateTimeLocale",
          "attribute": "date-time-locale",
          "description": "The language for each notification's time stamp.\nUsed with `dateTimeStyle`.",
          "type": "string | undefined"
        },
        {
          "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"
        }
      ],
      "events": [
        {
          "name": "c4p-notification-panel-beingclosed",
          "description": "The custom event before notification-panel is closed."
        },
        {
          "name": "c4p-notification-dismiss-all",
          "description": "The custom event fired after notification-panel is closed upon a user gesture."
        },
        {
          "name": "c4p-notification-donot-disturb-change",
          "description": "The custom event fired after notification-panel is closed upon a user gesture."
        },
        {
          "name": "c4p-notification-click-outside",
          "description": "The custom event fired after user clicks outside the panel or Esc key is pressed."
        }
      ],
      "slots": [
        {
          "name": "today",
          "description": "Today Section."
        },
        {
          "name": "previous",
          "description": "Previous Section."
        },
        {
          "name": "footer",
          "description": "Footer for the Panel."
        }
      ]
    },
    {
      "name": "c4p-notification",
      "path": "./src/components/notification-panel/notification.ts",
      "description": "Notification.",
      "attributes": [
        {
          "name": "type",
          "description": "Sets the type of notification to display: 'error', 'warning', 'success', or 'informational'",
          "type": "\"error\" | \"warning\" | \"success\" | \"informational\" | undefined"
        },
        {