@carbon/ibm-products/es/components/InterstitialScreen/InterstitialScreenFooter.d.ts

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2024, 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 React from 'react';
import { ActionType, disableButtonConfigType } from './InterstitialScreen';
type actionButtonRendererArgs = {
    handleGotoStep?: (value: number) => void;
    progStep?: number;
    stepCount?: number;
    disableButtonConfig?: disableButtonConfigType;
};
export interface InterstitialScreenFooterProps {
    /**
     * Provide an optional class to be applied to the containing node.
     */
    className?: 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;
    /**
     * The label for the Next button.
     */
    nextButtonLabel?: string;
    /**
     * This is an optional callback prop that allows to render your custom footer action buttons.
     * note: this is applicable when not using custom actionButtonRenderer
     */
    actionButtonRenderer?: (config: actionButtonRendererArgs) => React.ReactNode;
    /**
     * optional asynchronous callback on action button click
     */
    onAction?: (actionName: ActionType, config: actionButtonRendererArgs) => void;
}
declare const InterstitialScreenFooter: React.ForwardRefExoticComponent<InterstitialScreenFooterProps & React.RefAttributes<HTMLDivElement>>;
export default InterstitialScreenFooter;