@supunlakmal/hooks
Version:
A collection of reusable React hooks
27 lines (26 loc) • 900 B
TypeScript
interface UseStepperProps {
initialStep?: number;
totalSteps: number;
}
interface UseStepperReturn {
currentStep: number;
totalSteps: number;
isFirstStep: boolean;
isLastStep: boolean;
canGoNextStep: boolean;
canGoPreviousStep: boolean;
goToNextStep: () => void;
goToPreviousStep: () => void;
goToStep: (stepNumber: number) => void;
reset: () => void;
}
/**
* Custom hook for managing state in multi-step forms or wizards.
*
* @param {UseStepperProps} props - Configuration options.
* @param {number} [props.initialStep=1] - The initial step number (1-indexed).
* @param {number} props.totalSteps - The total number of steps in the process.
* @returns {UseStepperReturn} An object containing stepper state and control functions.
*/
export declare const useStepper: ({ initialStep, totalSteps, }: UseStepperProps) => UseStepperReturn;
export {};