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

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

/// <reference types="react" />
import { WizardStepType, WizardFooterType } from './types';
import { WizardFooterProps } from './WizardFooter';
export interface WizardContextProps {
    /** List of steps */
    steps: WizardStepType[];
    /** Current step */
    activeStep: WizardStepType;
    /** Footer element */
    footer: React.ReactElement<any>;
    /** Close the wizard */
    close: () => void;
    /** Navigate to the next step */
    goToNextStep: () => void | Promise<void>;
    /** Navigate to the previous step */
    goToPrevStep: () => void | Promise<void>;
    /** Navigate to step by ID */
    goToStepById: (id: number | string) => void;
    /** Navigate to step by name */
    goToStepByName: (name: string) => void;
    /** Navigate to step by index */
    goToStepByIndex: (index: number) => void;
    /** Update the footer with any react element */
    setFooter: (footer: React.ReactElement<any> | Partial<WizardFooterProps>) => void;
    /** Get step by ID */
    getStep: (stepId: number | string) => WizardStepType;
    /** Set step by ID */
    setStep: (step: Pick<WizardStepType, 'id'> & Partial<WizardStepType>) => void;
    /** Flag indicating whether the wizard content should be focused after the onNext or onBack callbacks
     * are called.
     */
    shouldFocusContent: boolean;
    /** Ref for main wizard content element. */
    mainWrapperRef: React.RefObject<HTMLElement | null>;
}
export declare const WizardContext: import("react").Context<WizardContextProps>;
export interface WizardContextProviderProps {
    steps: WizardStepType[];
    activeStepIndex: number;
    footer: WizardFooterType;
    children: React.ReactElement<any>;
    onNext(event: React.MouseEvent<HTMLButtonElement>, steps: WizardStepType[]): void;
    onBack(event: React.MouseEvent<HTMLButtonElement>, steps: WizardStepType[]): void;
    onClose?(event: React.MouseEvent<HTMLButtonElement>): void;
    goToStepById(steps: WizardStepType[], id: number | string): void;
    goToStepByName(steps: WizardStepType[], name: string): void;
    goToStepByIndex(event: React.MouseEvent<HTMLButtonElement> | React.MouseEvent<HTMLAnchorElement>, steps: WizardStepType[], index: number): void;
    shouldFocusContent: boolean;
    mainWrapperRef: React.RefObject<HTMLElement | null>;
}
export declare const WizardContextProvider: React.FunctionComponent<WizardContextProviderProps>;
export declare const useWizardContext: () => WizardContextProps;
//# sourceMappingURL=WizardContext.d.ts.map