@carbon/ibm-products-web-components
Version:
Carbon for IBM Products Web Components
92 lines (90 loc) • 3.33 kB
TypeScript
/**
* @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;
};
_hostListeners: {
[listenerName: string]: {
[type: string]: {
options?: boolean | AddEventListenerOptions;
};
};
};
} & typeof LitElement & (new (...args: any[]) => import("@lit-labs/signals").SignalWatcherApi);
/**
* 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;
//# sourceMappingURL=interstitial-screen.d.ts.map