README.md

React Step Builder

React Step Builder is a UI-agnostic multi step interface builder.

Overview

React Step Builder provides;

• React / TypeScript support and type definitions
• A combined global state collected from- and persistent across each individual step component
• UI-agnostic functionality for navigating between step components
• Ready-to-use form handling methods for handling React form elements
• Easy to use API

Installation

Using npm:

$ npm install react-step-builder

Usage

Example:

<Steps>
	<Step title="My First Step" component={Step1} />
	<Step title="My Second Step" component={Step2} />
	<Step title="My Third Step" component={Step3} />
</Steps>

Config Object

Steps component accepts an optional config object for configuring the common navigation component. The Navigation component provided in the config object will be rendered along with every step component. Here is an example:

const Navigation = (props) => {
    return (
        <div>
            <button onClick={props.prev}>Previous</button>
            <button onClick={props.next}>Next</button>
        </div>
    );
}

const config = {
	navigation: {
		component: Navigation // a React component with special props provided automatically
		location: "before" // or after
	}
}

<Steps config={config}>
	<Step title="My First Step" component={Step1} />
	<Step title="My Second Step" component={Step2} />
	<Step title="My Third Step" component={Step3} />
</Steps>

Documentation

Wrapper Components

Steps and Step are the only two wrapper components for creating your multi-step component.

Component	Description
<Steps />	Wrapper component for Step components. Accepts a config object for rendering a common navigation component.
<Step />	title: takes a title for the step, which can be accessed in props object of the step component. component: takes a React component that you would like to show in that step. beforeStepChange: takes a callback function to run right before the current step changes.

---

Step Component props

The React component that is passed to each Step wrapper component will be injected with the following props:

Property	Type	Description
props.order	number	Order number of the current step component
props.title	string	Title of the current step component
props.progress	number	Progress of the current step, value between 0 and 1
props.next	function	Function to move to the next step
props.prev	function	Function to move to the previous step
props.jump	function<step>	Function to jump to the given step
props.isFirst	function	Function to check if the step is the first
props.isLast	function	Function to check if the step is the last
props.hasPrev	function	Function to check if the step has any previous step
props.hasNext	function	Function to check if the step has any next step
props.allSteps	Array<{order, title}>	Array of all available steps' title and order number
props.state	object	Combined state value of all steps
props.setState	function<key, value>	Function to set/update state by key
props.getState	function<key, defaultValue>	Function to retrieve a state value by key
props.handleChange	function<event>	onChange event handler for form elements

Navigation Component props

Property	Type	Description
props.size	number	Total number of steps
props.current	string	Current step number
props.progress	number	Progress of the current step, value between 0 and 1
props.next	function	Function to move to the next step
props.prev	function	Function to move to the previous step
props.jump	function<step>	Function to jump to the given step
props.allSteps	Array<{order, title}>	Array of all available steps' title and order number
props.state	object	Combined state value of all steps
props.setState	function<key, value>	Function to set/update state by key
props.getState	function<key, defaultValue>	Function to retrieve a state value by key
props.handleChange	function<event>	onChange event handler for form elements

---

Prop types of the step components for React / TypeScript

When developing your step components, you can utilize StepComponentProps type definition for your step component props.

Example:

import React from "react";
import { StepComponentProps } from "react-step-builder";

const Step1 = (props: StepComponentProps) => {
	return (
		<div>
			<input
				name="fname"
				value={props.getState("fname", "")}
				onChange={props.handleChange}
			/>
			<input
				name="lname"
				value={props.getState("lname", "")}
				onChange={props.handleChange}
			/>
		</div>
	);
};

export default Step1;

Component Type of Example Navigation Component

If you'd like to add a persistent navigation component to be shown on every step, you may utilize NavigationComponentProps type for your custom Navigation component. Here is an example:

const Navigation = (props: NavigationComponentProps) => {
	return (
		<div>
			<button onClick={props.prev}>Previous</button>
			<button onClick={props.next}>Next</button>
		</div>
	);
};