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

package/es/components/interstitial-screen/interstitial-screen.d.ts

@@ -0,0 +1,441 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement, nothing } from 'lit';
+import '@carbon/web-components/es/components/modal/index.js';
+export declare const blockClass = "c4p--interstitial-screen";
+export type disableButtonConfigType = {
+    skip?: boolean;
+    back?: boolean;
+    next?: boolean;
+    start?: boolean;
+};
+declare const CDSInterstitialScreen_base: {
+    new (...args: any[]): {
+        _handles: Set<import("@carbon/web-components/es/globals/internal/handle").default>;
+        connectedCallback(): void;
+        disconnectedCallback(): void;
+        accessKey: string;
+        readonly accessKeyLabel: string;
+        autocapitalize: string;
+        autocorrect: boolean;
+        dir: string;
+        draggable: boolean;
+        hidden: boolean;
+        inert: boolean;
+        innerText: string;
+        lang: string;
+        readonly offsetHeight: number;
+        readonly offsetLeft: number;
+        readonly offsetParent: Element | null;
+        readonly offsetTop: number;
+        readonly offsetWidth: number;
+        outerText: string;
+        popover: string | null;
+        spellcheck: boolean;
+        title: string;
+        translate: boolean;
+        writingSuggestions: string;
+        attachInternals(): ElementInternals;
+        click(): void;
+        hidePopover(): void;
+        showPopover(): void;
+        togglePopover(options?: boolean): boolean;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+        readonly attributes: NamedNodeMap;
+        get classList(): DOMTokenList;
+        set classList(value: string): any;
+        className: string;
+        readonly clientHeight: number;
+        readonly clientLeft: number;
+        readonly clientTop: number;
+        readonly clientWidth: number;
+        readonly currentCSSZoom: number;
+        id: string;
+        innerHTML: string;
+        readonly localName: string;
+        readonly namespaceURI: string | null;
+        onfullscreenchange: ((this: Element, ev: Event) => any) | null;
+        onfullscreenerror: ((this: Element, ev: Event) => any) | null;
+        outerHTML: string;
+        readonly ownerDocument: Document;
+        get part(): DOMTokenList;
+        set part(value: string): any;
+        readonly prefix: string | null;
+        readonly scrollHeight: number;
+        scrollLeft: number;
+        scrollTop: number;
+        readonly scrollWidth: number;
+        readonly shadowRoot: ShadowRoot | null;
+        slot: string;
+        readonly tagName: string;
+        attachShadow(init: ShadowRootInit): ShadowRoot;
+        checkVisibility(options?: CheckVisibilityOptions): boolean;
+        closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K] | null;
+        closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K] | null;
+        closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K] | null;
+        closest<E extends Element = Element>(selectors: string): E | null;
+        computedStyleMap(): StylePropertyMapReadOnly;
+        getAttribute(qualifiedName: string): string | null;
+        getAttributeNS(namespace: string | null, localName: string): string | null;
+        getAttributeNames(): string[];
+        getAttributeNode(qualifiedName: string): Attr | null;
+        getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;
+        getBoundingClientRect(): DOMRect;
+        getClientRects(): DOMRectList;
+        getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
+        getElementsByTagName<K extends keyof HTMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
+        getElementsByTagName<K extends keyof SVGElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
+        getElementsByTagName<K extends keyof MathMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
+        getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
+        getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
+        getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;
+        getHTML(options?: GetHTMLOptions): string;
+        hasAttribute(qualifiedName: string): boolean;
+        hasAttributeNS(namespace: string | null, localName: string): boolean;
+        hasAttributes(): boolean;
+        hasPointerCapture(pointerId: number): boolean;
+        insertAdjacentElement(where: InsertPosition, element: Element): Element | null;
+        insertAdjacentHTML(position: InsertPosition, string: string): void;
+        insertAdjacentText(where: InsertPosition, data: string): void;
+        matches(selectors: string): boolean;
+        releasePointerCapture(pointerId: number): void;
+        removeAttribute(qualifiedName: string): void;
+        removeAttributeNS(namespace: string | null, localName: string): void;
+        removeAttributeNode(attr: Attr): Attr;
+        requestFullscreen(options?: FullscreenOptions): Promise<void>;
+        requestPointerLock(options?: PointerLockOptions): Promise<void>;
+        scroll(options?: ScrollToOptions): void;
+        scroll(x: number, y: number): void;
+        scrollBy(options?: ScrollToOptions): void;
+        scrollBy(x: number, y: number): void;
+        scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
+        scrollTo(options?: ScrollToOptions): void;
+        scrollTo(x: number, y: number): void;
+        setAttribute(qualifiedName: string, value: string): void;
+        setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
+        setAttributeNode(attr: Attr): Attr | null;
+        setAttributeNodeNS(attr: Attr): Attr | null;
+        setHTMLUnsafe(html: string): void;
+        setPointerCapture(pointerId: number): void;
+        toggleAttribute(qualifiedName: string, force?: boolean): boolean;
+        webkitMatchesSelector(selectors: string): boolean;
+        get textContent(): string;
+        set textContent(value: string | null): any;
+        readonly baseURI: string;
+        readonly childNodes: NodeListOf<ChildNode>;
+        readonly firstChild: ChildNode | null;
+        readonly isConnected: boolean;
+        readonly lastChild: ChildNode | null;
+        readonly nextSibling: ChildNode | null;
+        readonly nodeName: string;
+        readonly nodeType: number;
+        nodeValue: string | null;
+        readonly parentElement: HTMLElement | null;
+        readonly parentNode: ParentNode | null;
+        readonly previousSibling: ChildNode | null;
+        appendChild<T_1 extends Node>(node: T_1): T_1;
+        cloneNode(subtree?: boolean): Node;
+        compareDocumentPosition(other: Node): number;
+        contains(other: Node | null): boolean;
+        getRootNode(options?: GetRootNodeOptions): Node;
+        hasChildNodes(): boolean;
+        insertBefore<T_1 extends Node>(node: T_1, child: Node | null): T_1;
+        isDefaultNamespace(namespace: string | null): boolean;
+        isEqualNode(otherNode: Node | null): boolean;
+        isSameNode(otherNode: Node | null): boolean;
+        lookupNamespaceURI(prefix: string | null): string | null;
+        lookupPrefix(namespace: string | null): string | null;
+        normalize(): void;
+        removeChild<T_1 extends Node>(child: T_1): T_1;
+        replaceChild<T_1 extends Node>(node: Node, child: T_1): T_1;
+        readonly ELEMENT_NODE: 1;
+        readonly ATTRIBUTE_NODE: 2;
+        readonly TEXT_NODE: 3;
+        readonly CDATA_SECTION_NODE: 4;
+        readonly ENTITY_REFERENCE_NODE: 5;
+        readonly ENTITY_NODE: 6;
+        readonly PROCESSING_INSTRUCTION_NODE: 7;
+        readonly COMMENT_NODE: 8;
+        readonly DOCUMENT_NODE: 9;
+        readonly DOCUMENT_TYPE_NODE: 10;
+        readonly DOCUMENT_FRAGMENT_NODE: 11;
+        readonly NOTATION_NODE: 12;
+        readonly DOCUMENT_POSITION_DISCONNECTED: 1;
+        readonly DOCUMENT_POSITION_PRECEDING: 2;
+        readonly DOCUMENT_POSITION_FOLLOWING: 4;
+        readonly DOCUMENT_POSITION_CONTAINS: 8;
+        readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
+        readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
+        dispatchEvent(event: Event): boolean;
+        ariaActiveDescendantElement: Element | null;
+        ariaAtomic: string | null;
+        ariaAutoComplete: string | null;
+        ariaBrailleLabel: string | null;
+        ariaBrailleRoleDescription: string | null;
+        ariaBusy: string | null;
+        ariaChecked: string | null;
+        ariaColCount: string | null;
+        ariaColIndex: string | null;
+        ariaColIndexText: string | null;
+        ariaColSpan: string | null;
+        ariaControlsElements: ReadonlyArray<Element> | null;
+        ariaCurrent: string | null;
+        ariaDescribedByElements: ReadonlyArray<Element> | null;
+        ariaDescription: string | null;
+        ariaDetailsElements: ReadonlyArray<Element> | null;
+        ariaDisabled: string | null;
+        ariaErrorMessageElements: ReadonlyArray<Element> | null;
+        ariaExpanded: string | null;
+        ariaFlowToElements: ReadonlyArray<Element> | null;
+        ariaHasPopup: string | null;
+        ariaHidden: string | null;
+        ariaInvalid: string | null;
+        ariaKeyShortcuts: string | null;
+        ariaLabel: string | null;
+        ariaLabelledByElements: ReadonlyArray<Element> | null;
+        ariaLevel: string | null;
+        ariaLive: string | null;
+        ariaModal: string | null;
+        ariaMultiLine: string | null;
+        ariaMultiSelectable: string | null;
+        ariaOrientation: string | null;
+        ariaOwnsElements: ReadonlyArray<Element> | null;
+        ariaPlaceholder: string | null;
+        ariaPosInSet: string | null;
+        ariaPressed: string | null;
+        ariaReadOnly: string | null;
+        ariaRelevant: string | null;
+        ariaRequired: string | null;
+        ariaRoleDescription: string | null;
+        ariaRowCount: string | null;
+        ariaRowIndex: string | null;
+        ariaRowIndexText: string | null;
+        ariaRowSpan: string | null;
+        ariaSelected: string | null;
+        ariaSetSize: string | null;
+        ariaSort: string | null;
+        ariaValueMax: string | null;
+        ariaValueMin: string | null;
+        ariaValueNow: string | null;
+        ariaValueText: string | null;
+        role: string | null;
+        animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;
+        getAnimations(options?: GetAnimationsOptions): Animation[];
+        after(...nodes: (Node | string)[]): void;
+        before(...nodes: (Node | string)[]): void;
+        remove(): void;
+        replaceWith(...nodes: (Node | string)[]): void;
+        readonly nextElementSibling: Element | null;
+        readonly previousElementSibling: Element | null;
+        readonly childElementCount: number;
+        readonly children: HTMLCollection;
+        readonly firstElementChild: Element | null;
+        readonly lastElementChild: Element | null;
+        append(...nodes: (Node | string)[]): void;
+        prepend(...nodes: (Node | string)[]): void;
+        querySelector<K extends keyof HTMLElementTagNameMap>(selectors: K): HTMLElementTagNameMap[K] | null;
+        querySelector<K extends keyof SVGElementTagNameMap>(selectors: K): SVGElementTagNameMap[K] | null;
+        querySelector<K extends keyof MathMLElementTagNameMap>(selectors: K): MathMLElementTagNameMap[K] | null;
+        querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;
+        querySelector<E extends Element = Element>(selectors: string): E | null;
+        querySelectorAll<K extends keyof HTMLElementTagNameMap>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;
+        querySelectorAll<K extends keyof SVGElementTagNameMap>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;
+        querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
+        querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
+        querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
+        replaceChildren(...nodes: (Node | string)[]): void;
+        readonly assignedSlot: HTMLSlotElement | null;
+        readonly attributeStyleMap: StylePropertyMap;
+        get style(): CSSStyleDeclaration;
+        set style(cssText: string): any;
+        contentEditable: string;
+        enterKeyHint: string;
+        inputMode: string;
+        readonly isContentEditable: boolean;
+        onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
+        onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onauxclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;
+        onbeforematch: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
+        onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
+        oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
+        oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
+        ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onerror: OnErrorEventHandler;
+        onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
+        onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null;
+        ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
+        onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerrawupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null;
+        onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
+        onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null;
+        onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;
+        onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
+        ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;
+        autofocus: boolean;
+        readonly dataset: DOMStringMap;
+        nonce?: string;
+        tabIndex: number;
+        blur(): void;
+        focus(options?: FocusOptions): void;
+    };
+    _hostListeners: {
+        [listenerName: string]: {
+            [type: string]: {
+                options?: boolean | AddEventListenerOptions;
+            };
+        };
+    };
+} & typeof LitElement;
+/**
+ * interstitial-screen main component
+ * @element c4p-interstitial-screen
+ * @fires c4p-interstitial-opened -  The custom event triggered after loading the component.
+ * Its event.detail will provide you with carousal api methods for step navigation and method to disable any action button
+ * * @fires c4p-interstitial-beingclosed - The name of the custom event fired before interstitial is being closed upon a user gesture.
+ * Cancellation of this event stops the user-initiated action of closing the interstitial.
+ * @fires c4p-interstitial-closed - The name of the custom event fired after this tearsheet is closed upon a user gesture.
+
+ */
+declare class CDSInterstitialScreen extends CDSInterstitialScreen_base {
+    /**
+     * Specifies whether the component is shown as a full-screen
+     * experience, else it is shown as a modal by default.
+     */
+    isFullScreen: boolean;
+    /**
+     * Specifies whether the component is currently open.
+     */
+    open: boolean;
+    stepDetails: Array<{
+        stepTitle: string;
+        name?: string;
+    }>;
+    /**
+     * @ignore
+     */
+    modalBody: HTMLElement;
+    private _wasOpen;
+    private _trapFocusAPI;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    firstUpdated(): void;
+    updated(changedProps: Map<string | number | symbol, unknown>): void;
+    private dispatchInItializeEvent;
+    /**
+     * Handles `click` event on this element.
+     *
+     * @param event The event.
+     */
+    private _handleOutsideClick;
+    private setDisableActionButtons;
+    _handleClose(e: any): void;
+    renderFullScreen(): import("lit-html").TemplateResult<1>;
+    renderModal(): import("lit-html").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
+    static styles: any;
+    static get eventOnInterstitialOpened(): string;
+    /**
+     
+     * The name of the custom event fired before interstitial is being closed upon a user gesture.
+     * Cancellation of this event stops the user-initiated action of closing the interstitial.
+     */
+    static get eventBeforeClose(): string;
+    /**
+     * The name of the custom event fired after this tearsheet is closed upon a user gesture.
+     */
+    static get eventClose(): string;
+}
+export default CDSInterstitialScreen;

package/es/components/interstitial-screen/interstitial-screen.js

@@ -0,0 +1,217 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { __decorate } from 'tslib';
+import { LitElement, html, nothing } from 'lit';
+import { property, state, query } from 'lit/decorators.js';
+import { carbonPrefix, prefix } from '../../globals/settings.js';
+import '@carbon/web-components/es/components/modal/index.js';
+import HostListenerMixin from '@carbon/web-components/es/globals/mixins/host-listener.js';
+import { carbonElement } from '@carbon/web-components/es/globals/decorators/carbon-element.js';
+import styles from './interstitial-screen.scss.js';
+import { SignalWatcher } from '@lit-labs/signals';
+import { interstitialDetailsSignal, updateInterstitialDetailsSignal, resetInterstitialDetailsSignal } from './interstitial-screen-context.js';
+import HostListener from '@carbon/web-components/es/globals/decorators/host-listener';
+import { trapFocus } from '../../utilities/manageFocusTrap/manageFocusTrap.js';
+
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const blockClass = `${prefix}--interstitial-screen`;
+/**
+ * interstitial-screen main component
+ * @element c4p-interstitial-screen
+ * @fires c4p-interstitial-opened -  The custom event triggered after loading the component.
+ * Its event.detail will provide you with carousal api methods for step navigation and method to disable any action button
+ * * @fires c4p-interstitial-beingclosed - The name of the custom event fired before interstitial is being closed upon a user gesture.
+ * Cancellation of this event stops the user-initiated action of closing the interstitial.
+ * @fires c4p-interstitial-closed - The name of the custom event fired after this tearsheet is closed upon a user gesture.
+
+ */
+let CDSInterstitialScreen = class CDSInterstitialScreen extends SignalWatcher(HostListenerMixin(LitElement)) {
+    constructor() {
+        /**
+         * Specifies whether the component is shown as a full-screen
+         * experience, else it is shown as a modal by default.
+         */
+        super(...arguments);
+        this.isFullScreen = false;
+        /**
+         * Specifies whether the component is currently open.
+         */
+        this.open = false;
+        this.stepDetails = [];
+        this._wasOpen = false;
+        this._trapFocusAPI = null;
+        this.dispatchInItializeEvent = () => {
+            setTimeout(() => {
+                const { carouselAPI } = interstitialDetailsSignal.get();
+                this.dispatchEvent(new CustomEvent(this.constructor.eventOnInterstitialOpened, {
+                    bubbles: true,
+                    cancelable: true,
+                    composed: true,
+                    detail: {
+                        carouselAPI: carouselAPI
+                            ? {
+                                next: carouselAPI.next,
+                                prev: carouselAPI.prev,
+                                reset: carouselAPI.reset,
+                                gotToStep: carouselAPI.goToIndex,
+                            }
+                            : undefined,
+                        setDisableActionButtons: this.setDisableActionButtons,
+                    },
+                }));
+            });
+        };
+        /**
+         * Handles `click` event on this element.
+         *
+         * @param event The event.
+         */
+        this._handleOutsideClick = (event) => {
+            var _a, _b;
+            const modal = (_a = this.shadowRoot) === null || _a === void 0 ? void 0 : _a.querySelector(`${carbonPrefix}-modal`);
+            const modalContent = (_b = modal === null || modal === void 0 ? void 0 : modal.shadowRoot) === null || _b === void 0 ? void 0 : _b.querySelector(`.${carbonPrefix}--modal-container`);
+            const path = event.composedPath();
+            if (modalContent && !path.includes(modalContent)) {
+                this._handleClose(event);
+            }
+        };
+        this.setDisableActionButtons = (config) => {
+            updateInterstitialDetailsSignal({ name: 'disableActions', detail: config });
+        };
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        this.addEventListener(`${prefix}-request-close`, this._handleClose);
+    }
+    disconnectedCallback() {
+        var _a, _b;
+        const { carouselAPI } = interstitialDetailsSignal.get();
+        (_a = carouselAPI === null || carouselAPI === void 0 ? void 0 : carouselAPI.destroyEvents) === null || _a === void 0 ? void 0 : _a.call(carouselAPI);
+        (_b = this._trapFocusAPI) === null || _b === void 0 ? void 0 : _b.cleanup();
+    }
+    firstUpdated() {
+        this.requestUpdate(); // Ensure re-render
+        resetInterstitialDetailsSignal();
+        updateInterstitialDetailsSignal({
+            name: 'isFullScreen',
+            detail: this.isFullScreen,
+        });
+    }
+    updated(changedProps) {
+        if (changedProps.has('open')) {
+            const wasOpen = this._wasOpen;
+            const isOpen = this.open;
+            if (!wasOpen && isOpen) {
+                this.dispatchInItializeEvent();
+                // `focusableContainers` holds the containers where we can query DOM elements.
+                // Our strategy here is to let child/slotted components register their containers,
+                // which are then passed to `trapFocus`. This allows the utility to query elements
+                // directly without being blocked by shadow DOM boundaries.
+                this._trapFocusAPI = trapFocus();
+            }
+            this._wasOpen = isOpen;
+        }
+    }
+    _handleClose(e) {
+        this.open = false;
+        e.stopPropagation();
+        const init = {
+            bubbles: true,
+            cancelable: true,
+            composed: true,
+            detail: {
+                triggeredBy: e.detail.triggeredBy,
+            },
+        };
+        if (this.dispatchEvent(new CustomEvent(this.constructor.eventBeforeClose, init))) {
+            this.dispatchEvent(new CustomEvent(this.constructor.eventClose, init));
+        }
+    }
+    //template methods
+    renderFullScreen() {
+        return html `
+      <div class="${blockClass}--container">
+        <slot name="header"></slot>
+        <slot name="body"></slot>
+        <slot name="footer"></slot>
+      </div>
+    `;
+    }
+    renderModal() {
+        return html `<cds-modal
+      key=${this.open}
+      ?prevent-close-on-click-outside="true"
+      class=${blockClass}
+      size="lg"
+      ?open="${this.open}"
+    >
+      <slot name="header"></slot>
+      <cds-modal-body class="${blockClass}__body-container">
+        <slot name="body"></slot>
+      </cds-modal-body>
+      <cds-modal-footer>
+        <slot name="footer"></slot>
+      </cds-modal-footer>
+    </cds-modal>`;
+    }
+    render() {
+        return this.open
+            ? this.isFullScreen
+                ? html `${this.renderFullScreen()}`
+                : html `${this.renderModal()}`
+            : nothing;
+    }
+    static get eventOnInterstitialOpened() {
+        return `${prefix}-interstitial-opened`;
+    }
+    /**
+     
+     * The name of the custom event fired before interstitial is being closed upon a user gesture.
+     * Cancellation of this event stops the user-initiated action of closing the interstitial.
+     */
+    static get eventBeforeClose() {
+        return `${prefix}-interstitial-beingclosed`;
+    }
+    /**
+     * The name of the custom event fired after this tearsheet is closed upon a user gesture.
+     */
+    static get eventClose() {
+        return `${prefix}-interstitial-closed`;
+    }
+};
+CDSInterstitialScreen.styles = styles;
+__decorate([
+    property({ type: Boolean, reflect: true, attribute: 'fullscreen' })
+], CDSInterstitialScreen.prototype, "isFullScreen", void 0);
+__decorate([
+    property({ type: Boolean, reflect: true })
+], CDSInterstitialScreen.prototype, "open", void 0);
+__decorate([
+    state()
+], CDSInterstitialScreen.prototype, "stepDetails", void 0);
+__decorate([
+    query('cds-modal-body')
+], CDSInterstitialScreen.prototype, "modalBody", void 0);
+__decorate([
+    HostListener('click')
+    // @ts-ignore: The decorator refers to this method but TS thinks this method is not referred to
+], CDSInterstitialScreen.prototype, "_handleOutsideClick", void 0);
+CDSInterstitialScreen = __decorate([
+    carbonElement(`${prefix}-interstitial-screen`)
+], CDSInterstitialScreen);
+var CDSInterstitialScreen$1 = CDSInterstitialScreen;
+
+export { blockClass, CDSInterstitialScreen$1 as default };
+//# sourceMappingURL=interstitial-screen.js.map

package/es/components/interstitial-screen/interstitial-screen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interstitial-screen.js","sources":["../../../src/components/interstitial-screen/interstitial-screen.ts"],"sourcesContent":[null],"names":["customElement"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;AAOG;AAmBU,MAAA,UAAU,GAAG,CAAG,EAAA,MAAM;AAQnC;;;;;;;;;AASG;AAGH,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,aAAa,CAC/C,iBAAiB,CAAC,UAAU,CAAC,CAC9B,CAAA;AAFD,IAAA,WAAA,GAAA;AAGE;;;AAGG;;QAGH,IAAY,CAAA,YAAA,GAAY,KAAK;AAC7B;;AAEG;QAEH,IAAI,CAAA,IAAA,GAAY,KAAK;QAGrB,IAAW,CAAA,WAAA,GAAgD,EAAE;QAMrD,IAAQ,CAAA,QAAA,GAAG,KAAK;QAChB,IAAa,CAAA,aAAA,GAAmC,IAAI;QAwCpD,IAAuB,CAAA,uBAAA,GAAG,MAAK;YACrC,UAAU,CAAC,MAAK;gBACd,MAAM,EAAE,WAAW,EAAE,GAAG,yBAAyB,CAAC,GAAG,EAAE;gBACvD,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CAEX,IAAI,CAAC,WACN,CAAC,yBAAyB,EAC3B;AACE,oBAAA,OAAO,EAAE,IAAI;AACb,oBAAA,UAAU,EAAE,IAAI;AAChB,oBAAA,QAAQ,EAAE,IAAI;AACd,oBAAA,MAAM,EAAE;AACN,wBAAA,WAAW,EAAE;AACX,8BAAE;gCACE,IAAI,EAAE,WAAW,CAAC,IAAI;gCACtB,IAAI,EAAE,WAAW,CAAC,IAAI;gCACtB,KAAK,EAAE,WAAW,CAAC,KAAK;gCACxB,SAAS,EAAE,WAAW,CAAC,SAAS;AACjC;AACH,8BAAE,SAAS;wBACb,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;AACtD,qBAAA;AACF,iBAAA,CACF,CACF;AACH,aAAC,CAAC;AACJ,SAAC;AAED;;;;AAIG;AAGK,QAAA,IAAA,CAAA,mBAAmB,GAAG,CAAC,KAAiB,KAAI;;AAClD,YAAA,MAAM,KAAK,GAAG,CAAA,EAAA,GAAA,IAAI,CAAC,UAAU,MAAE,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,aAAa,CAAC,CAAA,EAAG,YAAY,CAAA,MAAA,CAAQ,CAAC;AACrE,YAAA,MAAM,YAAY,GAAG,CAAA,EAAA,GAAA,KAAK,KAAA,IAAA,IAAL,KAAK,KAAL,MAAA,GAAA,MAAA,GAAA,KAAK,CAAE,UAAU,0CAAE,aAAa,CACnD,IAAI,YAAY,CAAA,iBAAA,CAAmB,CACpC;AACD,YAAA,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,EAAE;YACjC,IAAI,YAAY,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;AAChD,gBAAA,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;;AAE5B,SAAC;AAEO,QAAA,IAAA,CAAA,uBAAuB,GAAG,CAAC,MAA+B,KAAI;YACpE,+BAA+B,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC7E,SAAC;;IAvFD,iBAAiB,GAAA;QACf,KAAK,CAAC,iBAAiB,EAAE;QACzB,IAAI,CAAC,gBAAgB,CAAC,CAAG,EAAA,MAAM,CAAgB,cAAA,CAAA,EAAE,IAAI,CAAC,YAAY,CAAC;;IAErE,oBAAoB,GAAA;;QAClB,MAAM,EAAE,WAAW,EAAE,GAAG,yBAAyB,CAAC,GAAG,EAAE;QACvD,CAAA,EAAA,GAAA,WAAW,aAAX,WAAW,KAAA,MAAA,GAAA,MAAA,GAAX,WAAW,CAAE,aAAa,2DAAI;AAC9B,QAAA,CAAA,EAAA,GAAA,IAAI,CAAC,aAAa,MAAE,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,OAAO,EAAE;;IAE/B,YAAY,GAAA;AACV,QAAA,IAAI,CAAC,aAAa,EAAE,CAAC;AACrB,QAAA,8BAA8B,EAAE;AAEhC,QAAA,+BAA+B,CAAC;AAC9B,YAAA,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,IAAI,CAAC,YAAY;AAC1B,SAAA,CAAC;;AAGJ,IAAA,OAAO,CAAC,YAAoD,EAAA;AAC1D,QAAA,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;AAC5B,YAAA,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ;AAC7B,YAAA,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI;AAExB,YAAA,IAAI,CAAC,OAAO,IAAI,MAAM,EAAE;gBACtB,IAAI,CAAC,uBAAuB,EAAE;;;;;AAM9B,gBAAA,IAAI,CAAC,aAAa,GAAG,SAAS,EAAE;;AAGlC,YAAA,IAAI,CAAC,QAAQ,GAAG,MAAM;;;AAuD1B,IAAA,YAAY,CAAC,CAAC,EAAA;AACZ,QAAA,IAAI,CAAC,IAAI,GAAG,KAAK;QACjB,CAAC,CAAC,eAAe,EAAE;AAEnB,QAAA,MAAM,IAAI,GAAG;AACX,YAAA,OAAO,EAAE,IAAI;AACb,YAAA,UAAU,EAAE,IAAI;AAChB,YAAA,QAAQ,EAAE,IAAI;AACd,YAAA,MAAM,EAAE;AACN,gBAAA,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW;AAClC,aAAA;SACF;AACD,QAAA,IACE,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CACZ,IAAI,CAAC,WAA4C,CAAC,gBAAgB,EACnE,IAAI,CACL,CACF,EACD;AACA,YAAA,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CACZ,IAAI,CAAC,WAA4C,CAAC,UAAU,EAC7D,IAAI,CACL,CACF;;;;IAML,gBAAgB,GAAA;AACd,QAAA,OAAO,IAAI,CAAA;oBACK,UAAU,CAAA;;;;;KAKzB;;IAGH,WAAW,GAAA;AACT,QAAA,OAAO,IAAI,CAAA,CAAA;AACH,UAAA,EAAA,IAAI,CAAC,IAAI;;cAEP,UAAU;;AAET,aAAA,EAAA,IAAI,CAAC,IAAI,CAAA;;;+BAGO,UAAU,CAAA;;;;;;iBAMxB;;IAGf,MAAM,GAAA;QACJ,OAAO,IAAI,CAAC;cACR,IAAI,CAAC;kBACH,IAAI,CAAA,CAAA,EAAG,IAAI,CAAC,gBAAgB,EAAE,CAAE;kBAChC,IAAI,CAAA,CAAA,EAAG,IAAI,CAAC,WAAW,EAAE,CAAE;cAC7B,OAAO;;AAKb,IAAA,WAAW,yBAAyB,GAAA;QAClC,OAAO,CAAA,EAAG,MAAM,CAAA,oBAAA,CAAsB;;AAExC;;;;AAIG;AACH,IAAA,WAAW,gBAAgB,GAAA;QACzB,OAAO,CAAA,EAAG,MAAM,CAAA,yBAAA,CAA2B;;AAG7C;;AAEG;AACH,IAAA,WAAW,UAAU,GAAA;QACnB,OAAO,CAAA,EAAG,MAAM,CAAA,oBAAA,CAAsB;;;AAlBjC,qBAAM,CAAA,MAAA,GAAG,MAAH;AA7Kb,UAAA,CAAA;AADC,IAAA,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE;AACrC,CAAA,EAAA,qBAAA,CAAA,SAAA,EAAA,cAAA,EAAA,MAAA,CAAA;AAK9B,UAAA,CAAA;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;AACpB,CAAA,EAAA,qBAAA,CAAA,SAAA,EAAA,MAAA,EAAA,MAAA,CAAA;AAGtB,UAAA,CAAA;AADC,IAAA,KAAK;AACwD,CAAA,EAAA,qBAAA,CAAA,SAAA,EAAA,aAAA,EAAA,MAAA,CAAA;AAIrC,UAAA,CAAA;IAAxB,KAAK,CAAC,gBAAgB;AAA0B,CAAA,EAAA,qBAAA,CAAA,SAAA,EAAA,WAAA,EAAA,MAAA,CAAA;AA+EzC,UAAA,CAAA;IAFP,YAAY,CAAC,OAAO;;AAWnB,CAAA,EAAA,qBAAA,CAAA,SAAA,EAAA,qBAAA,EAAA,MAAA,CAAA;AA7GE,qBAAqB,GAAA,UAAA,CAAA;AAD1B,IAAAA,aAAa,CAAC,CAAA,EAAG,MAAM,CAAA,oBAAA,CAAsB;AACxC,CAAA,EAAA,qBAAqB,CA0M1B;AAED,8BAAe,qBAAqB;;;;"}