Skip to main content

useMultistepIndicator

function useMultistepIndicator(__namedParameters): readonly [{
  allStepsCompleted: boolean;
  currentStepIndex: number;
  prevStepsCompleted: boolean;
  steps: MultistepItem[];
}, {
  moveToStep: (stepIndex, __namedParameters) => void;
  resetAllSteps: () => void;
  resetStep: (stepIndex) => void;
  updateStepActive: (stepIndex, isActive) => void;
  updateStepCompleted: (stepIndex, __namedParameters) => void;
  updateStepDisabled: (stepIndex, isDisabled) => void;
  updateStepFailed: (stepIndex, __namedParameters) => void;
  updateStepLeave: (stepIndex, __namedParameters) => void;
}];

Convenience hook for using steps in MultistepIndicator

Parameters​

ParameterType
__namedParameters{ currentStepIndex?: number; initialSteps: MultistepItem[]; }
__namedParameters.currentStepIndex?number
__namedParameters.initialStepsMultistepItem[]

Returns​

readonly [{ allStepsCompleted: boolean; currentStepIndex: number; prevStepsCompleted: boolean; steps: MultistepItem[]; }, { moveToStep: (stepIndex, __namedParameters) => void; resetAllSteps: () => void; resetStep: (stepIndex) => void; updateStepActive: (stepIndex, isActive) => void; updateStepCompleted: (stepIndex, __namedParameters) => void; updateStepDisabled: (stepIndex, isDisabled) => void; updateStepFailed: (stepIndex, __namedParameters) => void; updateStepLeave: (stepIndex, __namedParameters) => void; }]