Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srdjan/react-multistep
React multistep wizard component
https://github.com/srdjan/react-multistep
css esbuild forms javascript jsx react reactjs responsive ui ui-components wizard wizard-steps
Last synced: about 13 hours ago
JSON representation
React multistep wizard component
- Host: GitHub
- URL: https://github.com/srdjan/react-multistep
- Owner: srdjan
- License: mit
- Created: 2015-01-15T18:26:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-27T23:42:23.000Z (8 months ago)
- Last Synced: 2024-09-19T17:11:20.022Z (5 days ago)
- Topics: css, esbuild, forms, javascript, jsx, react, reactjs, responsive, ui, ui-components, wizard, wizard-steps
- Language: JavaScript
- Homepage: http://srdjan.github.io/react-multistep/
- Size: 1.87 MB
- Stars: 652
- Watchers: 15
- Forks: 181
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Responsive React multistep form component
## Take it for a [__SPIN!__](http://srdjan.github.io/react-multistep/) :dizzy:
#### List of contributors :raised_hands:
### Previous MultiStep major version, v5.4.0
```
Version 5.x.x is in a maintenance mode, the new development is ongoing on v6.x.x. Version (v5.x.x) bug fixes will still be available on NPM, if you would like to open a PR for a fix or make a fork, git checkout branch v5.x.x. The new version, v6.0.0 has a multiple improvements (see below) and is not backwards compatible.
```
#
### Instructions
To use this module in your app run:
```sh
npm install react-multistep
```
next, import it inside of your app:
```jsx
import MultiStep from 'react-multistep'
```
and then, in your application, you add your custom components/forms this way:
```jsx
```
MultiStep component accepts following props (all optional, except Steps array):
| PROPERTY | DESCRIPTION | TYPE | DEFAULT | isRequired|
|----------------|--------------------------------------------------------------|-------------|------------|-----------|
| showTopNav | controls if the navigation buttons are visible |boolean |true |false |
| prevButton | configure the prev navigation button |NavButtonProp |null |false |
| nextButton | configure the next the navigation button |NavButtonProp |null |false |
| stepCustomStyle| control style of step |CSSProperties|null |false |
| direction | control the steps nav direction |column |row |false |
| activeStep | it takes a number representing representing starting step |number |0 |false |
#### 🚀 NEW! you can also use style props for the navigation buttons and change how they look with two props 'prevButton' & 'nextButton':
| PROPERTY | DESCRIPTION | TYPE | DEFAULT | isRequired|
|----------------|--------------------------------------------------------------|--------------|------------|-----------|
| title | The display string value of the navigation button |string |Prev / Next |false |
| style | The css style of the navigation button |CSSProperties |null |false |
#
#### To configure Multistep component, we `inline` child components:
```javascript
```
When configured this way, each component (`Step`) of the array can have following two properties:
| PROPERTY | DESCRIPTION | TYPE | DEFAULT | isRequired|
|-----------|---------------------------------------------|------------|------------|-----------|
| component | the step representing component |JSX.Element |null |true |
| title | the step title, present above the steps nav |text |step index |false |
#
#### 🚀 NEW! Feature: Controlling navigation to the next step with form validation
To enable this feature, when the child form component needs to control 'Next' navigational button, based on it's local validation, MultiStep dynamically adds a new prop function to child components that should be used to signal validation status. MultiStep will disable /enable `Next` button accordingly. This function has follwing signature:
`signalParent(valid: boolean)`
By default the state is `false` and child components invokes it based on current outcome of the validation. In the example app, a simple checkbox is used to simulate valid/not valid.
This can be seen in the `example` app, but here are the relevant parts, required inside of the form child component:
## Instructions for local development
#### If you would like to explore further, contribute a PR or just try the included code example:
Start by cloning the repo locally:
```sh
git clone https://github.com/srdjan/react-multistep.git
```
then:
```sh
cd react-multistep // (1) navigate to the project folder
npm install // (2) install dependencies
npm run build // (3) build the component
```
On a successful build, try the example app:
```sh
cd ../example // (1) navigate to the example folder
npm install // (2) install dependencies
npm run build // (3) build the example
npm start // (4) start the local server
```
Now, you can open the example in your favorite browser...