react-usestepper
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

useStepper

useStepper is a react package meant for assisting the creation of stepper forms/components

Demo

See demo or take a look at basic example in /example.

Usage

First you need to wrap you component with withStepper . You can now use useStepper inside that component or any that nests inside it. Calling useStepper only requires you to provide { totalNumberOfSteps:number } at least. You can destructure out isFirstStep,isLastStep,currentStep,handleNext,handlePrevious,navigateStep,handleReset and body from useStepper . Though keep in mind that you need to pass bodyComponents which should be an array of Components. The body always refers to current active Component and you may render it as needed.`

const Demo = () => {
  const {
    handlePrevious,
    handleNext,
    body,
    currentStep,
    isFirstStep,
    isLastStep,
  } = useStepper({
    totalNumberOfSteps: 3,
    onStepsComplete: () => alert('All steps completed!'),
    onBack: () => alert('Back!'),
    bodyComponents: [<StepOne />, <StepTwo />, <StepThree />],
  });
  return (
    <div>
      <h1>Step {currentStep}</h1>
      {body}
      <button onClick={handlePrevious}>
        {isFirstStep ? 'Go Back' : 'Previous Step'}
      </button>
      <button onClick={handleNext}>
        {' '}
        {isLastStep ? 'Finish' : 'Next Step'}
      </button>
    </div>
  );
};

const App = withStepper(Demo);

ReactDOM.render(<App />, document.getElementById('root'));

/react-usestepper/

    Package Sidebar

    Install

    npm i react-usestepper

    Weekly Downloads

    12

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    38.3 kB

    Total Files

    16

    Last publish

    Collaborators

    • shrestha01