react-step-progress

Welcome to react-step-progress 👋

Multi step and dynamic progress indicator for react. Built using typescript, hooks and lots-o'-☕ and lots-o'-❤️ . Uses CSS modules so you don't have to worry about your CSS class names clashing with ours

Install

npm install --save react-step-progress

Usage

NOTE: I'm working towards an implementation where you don't have to import the stylesheet explicitly. I feel like that's not an ideal solution. Feel free to help me out 😁

// import the progress bar
import StepProgressBar from 'react-step-progress';
// import the stylesheet
import 'react-step-progress/dist/index.css';

// setup the step content
const step1Content = <h1>Step 1 Content</h1>;
const step2Content = <h1>Step 2 Content</h1>;
const step3Content = <h1>Step 3 Content</h1>;

// setup step validators, will be called before proceeding to the next step
function step2Validator() {
  // return a boolean
}

function step3Validator() {
  // return a boolean
}

function onFormSubmit() {
  // handle the submit logic here
  // This function will be executed at the last step
  // when the submit button (next button in the previous steps) is pressed
}

// render the progress bar
<StepProgressBar
  startingStep={0}
  onSubmit={onFormSubmit}
  steps={[
    {
      label: 'Step 1',
      subtitle: '10%',
      name: 'step 1',
      content: step1Content
    },
    {
      label: 'Step 2',
      subtitle: '50%',
      name: 'step 2',
      content: step2Content,
      validator: step2Validator
    },
    {
      label: 'Step 3',
      subtitle: '100%',
      name: 'step 3',
      content: step3Content,
      validator: step3Validator
    }
  ]}
/>;

Available Props

Required

• startingStep (number) - the index of the step at which to start

• steps (ProgressStep[]) - array of steps with each step containing a label, name and content

• onSubmit (function) - function to be executed on the last step, simulating the submit of the form

Optional

• wrapperClass (string) - CSS class name for progress wrapper element

• progressClass (string) - CSS class name for progress bar element

• stepClass (string) - CSS class name for step indicator

• labelClass (string) - CSS class name for step label

• subtitleClass (string) - CSS class name for step subtitle

• contentClass (string) - CSS class name for step content element

• buttonWrapperClass (string) - CSS class name for action buttons wrapper element

• primaryBtnClass (string) - CSS class name for primary themed button

• secondaryBtnClass (string) - CSS class name for secondary themed button

• previousBtnName (string) - Change the text inside the previous button

• nextBtnName (string) - Change the text inside the next button

Author

👤 Gaurav Saini

• Github: @saini-g
• LinkedIn: @saini-g

Show your support

Give a ⭐️ if this project helped you!

CONTRIBUTING & CODE OF CONDUCT

See CODE_OF_CONDUCT.md