@carbon/ibm-products-web-components
Version:
Carbon for IBM Products Web Components
81 lines • 3.35 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 { PropertyValues } from 'lit';
import '@carbon/web-components/es/components/button/index.js';
import '@carbon/web-components/es/components/inline-loading/inline-loading.js';
import CDSModalFooter from '@carbon/web-components/es/components/modal/modal-footer';
import '../action-set/index.js';
export type ActionType = 'close' | 'start' | 'skip' | 'back' | 'next';
declare const CDSInterstitialScreenFooter_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 CDSModalFooter & (new (...args: any[]) => import("@lit-labs/signals").SignalWatcherApi);
/**
* interstitial-screen-footer for footer section
* @element c4p-interstitial-screen-footer
* @fires c4p-on-action - The name of the custom event fired just before the action. You can use this event to perform any async/sync validation.
* if 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()
* callback before continuing. When asyncAction is true, you must listen for the eventOnBeforeAction event and call the proceed() function
* (either synchronously or with a promise) to allow navigation.
*/
declare class CDSInterstitialScreenFooter extends CDSInterstitialScreenFooter_base {
/**
* The label for the Next button.
*/
nextButtonLabel: string;
/**
* The label for the Previous button.
*/
previousButtonLabel: string;
/**
* The label for the skip button.
*/
skipButtonLabel: string;
/**
* The label for the start button.
*/
startButtonLabel: string;
slot: string;
/**
* Enables support for asynchronous validation or user confirmation before proceeding
* to the next interstitial step. When set to true, the component will wait for an external
* listener (e.g., a form validation or confirmation modal) to resolve the proceed() callback before continuing.
* When asyncAction is true, you must listen for the eventOnBeforeAction event and
* call the proceed() function (either synchronously or with a promise) to allow navigation.
*/
asyncAction: any;
loadingAction: any;
protected firstUpdated(_changedProperties: PropertyValues): void;
protected updated(_changedProperties: PropertyValues): void;
private _handleUserInitiatedClose;
private handleSkip;
private handleStart;
private handleClickNext;
private handleClickPrev;
private handleAction;
render(): import("lit-html").TemplateResult<1>;
static styles: any;
static get eventRequestClose(): string;
/**
* The name of the custom event fired just before the action.
*/
static get eventOnBeforeAction(): string;
}
export default CDSInterstitialScreenFooter;
//# sourceMappingURL=interstitial-screen-footer.d.ts.map