## A headless & type-safe multi-step UI builder.
# Overview
React Step provides;
- TypeScript support
- A global state
- Headless structure
- Out-of-box form handler methods
# Installation
Using [npm](https://www.npmjs.com/):
$ npm i react-step-and-mark
# Usage
Example:
```javascript
```
# Config Object
`Steps` component accepts an optional `config` object for configuring the common navigation component or components that you'd like render before or after the Step components. These components are rendered along with every step component. Here is an example:
```javascript
const Navigation = (props) => {
return (
);
}
const Before = (props) => {
return This component will be rendered before the Step components in every step
}
const After = (props) => {
return This component will be rendered after the Step components in every step
}
const config = {
before: Before, // a React component with special props provided automatically
after: After, // a React component with special props provided automatically
navigation: {
component: Navigation, // a React component with special props provided automatically
location: "before" // or after
}
}
```
# Documentation
## Wrapper Components
`Steps` and `Step` are the only two wrapper components for creating your multi-step component.
| Component | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `` | Wrapper component for Step components. Accepts a `config` object for rendering a common navigation component. |
| `` | `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` | 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` | Function to set/update state by key |
| `props.getState` | `function` | Function to retrieve a state value by key |
| `props.handleChange` | `function` | `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` | 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` | Function to set/update state by key |
| `props.getState` | `function` | Function to retrieve a state value by key |
| `props.handleChange` | `function` | `onChange` event handler for form elements |
## Config Object
### `before`
It accepts a function that returns some JSX.Element. This component's `props` object is automatically populated with the `Steps` component's state (see: [NavigationComponentProps](#component-type-of-example-navigation-component)).
### `after`
It accepts a function that returns some JSX.Element. This component's `props` object is automatically populated with the `Steps` component's state (see: [NavigationComponentProps](#component-type-of-example-navigation-component)).
### `navigation`
| Property | Type | Description |
| --------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `component` | `() => JSX.Element` | This component's `props` object is automatically populated with the `Steps` component's state (see: [NavigationComponentProps](#component-type-of-example-navigation-component)). |
| `location` (optional) | "`before`" \|\| "`after`" | Location of the navigation component. |
## Prop types of the step components for React / TypeScript
When developing your step components, you can utilize `StepComponentProps` type for your step component props.
Example:
```javascript
import React from "react";
import { StepComponentProps } from "react-step-builder";
const Step1 = (props: StepComponentProps) => {
return (
);
};
export default Step1;
```
## Example Navigation, Before, and After Components
If you'd like to add a persistent components to be shown on before or after every step, you may utilize `NavigationComponentProps` type for your custom `Navigation`, `Before`, or `After` components. Here is an example:
```javascript
const Navigation = (props: NavigationComponentProps) => {
return (
);
};
const Before = (props: NavigationComponentProps) => {
return (
This component will be rendered before the Step components
);
};
const After = (props: NavigationComponentProps) => {
return This component will be rendered after the Step components;
};
```
---
_Source: https://npm.io/package/react-step-and-mark · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._