@patternfly/react-core/dist/js/components/Wizard/WizardFooter.d.ts

This library provides a set of common React components for use with the PatternFly reference implementation.

/// <reference types="react" />
import { WizardFooterButtonProps, WizardStepType } from './types';
/**
 * Hosts the standard structure of a footer with ties to the active step so that text for buttons can vary from step to step.
 */
export interface WizardFooterProps extends React.HTMLProps<HTMLElement> {
    /** The active step */
    activeStep: WizardStepType;
    /** Next button callback */
    onNext: (event: React.MouseEvent<HTMLButtonElement>) => void | Promise<void>;
    /** Back button callback */
    onBack: (event: React.MouseEvent<HTMLButtonElement>) => void | Promise<void>;
    /** Cancel link callback */
    onClose: (event: React.MouseEvent<HTMLButtonElement>) => void;
    /** Custom text for the Next button. The current step's nextButtonText takes precedence. */
    nextButtonText?: React.ReactNode;
    /** Custom text for the Back button */
    backButtonText?: React.ReactNode;
    /** Custom text for the Cancel link */
    cancelButtonText?: React.ReactNode;
    /** Flag to disable the next button */
    isNextDisabled?: boolean;
    /** Flag to disable the back button */
    isBackDisabled?: boolean;
    /** Flag to hide the back button */
    isBackHidden?: boolean;
    /** Flag to hide the cancel button */
    isCancelHidden?: boolean;
    /** Additional props for the Next button. */
    nextButtonProps?: Omit<WizardFooterButtonProps, 'isDisabled' | 'type'>;
    /** Additional props for the Back button. */
    backButtonProps?: Omit<WizardFooterButtonProps, 'isDisabled'>;
    /** Additional props for the Cancel button. */
    cancelButtonProps?: WizardFooterButtonProps;
    /** Additional classes spread to the wizard footer */
    className?: string;
}
/**
 * Applies default wizard footer styling any number of child elements.
 */
interface WizardFooterWrapperProps extends React.HTMLProps<HTMLElement> {
    children: React.ReactNode;
    className?: string;
}
export declare const WizardFooterWrapper: {
    ({ children, className, ...props }: WizardFooterWrapperProps): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
export declare const WizardFooter: {
    ({ activeStep, ...internalProps }: WizardFooterProps): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
export {};
//# sourceMappingURL=WizardFooter.d.ts.map