Socket
Socket
Sign inDemoInstall

react-usestepper

Package Overview
Dependencies
17
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-usestepper

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


Version published
Weekly downloads
57
increased by128%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

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'));

FAQs

Last updated on 02 Nov 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc