https://github.com/azizbecha/react-native-multistep
React Native multistep forms made easy 🚀
https://github.com/azizbecha/react-native-multistep
forms npm react-native
Last synced: 2 months ago
JSON representation
React Native multistep forms made easy 🚀
- Host: GitHub
- URL: https://github.com/azizbecha/react-native-multistep
- Owner: azizbecha
- License: mit
- Created: 2024-11-24T22:18:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-18T18:00:51.000Z (over 1 year ago)
- Last Synced: 2025-10-04T22:50:38.914Z (9 months ago)
- Topics: forms, npm, react-native
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/react-native-multistep
- Size: 1.34 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# React Native MultiStep 🚀
A flexible and animated **multi-step form component** for React Native, allowing you to easily create forms with multiple steps. 📝 The component provides **step indicators**, **transition animations**, and **customizable buttons**. 🎨
## 🌟 Features ✨
- ✅ **Step Indicator**: Displays a dynamic indicator to show the current step and progress. 📅
- ✅ **Animations**: Includes an animated scale effect on the active step indicator. 🔄
- ✅ **Customizable Buttons**: Custom labels and styles for the back, next, and done buttons. 🔘
- ✅ **Customizable Styles**: Easily customize every part of the form, including **content container**, **step indicators**, **buttons**, etc. 🎨
## 🔧 Installation 📦
1. Install the necessary dependencies:
```bash
npm install react-native-multistep
```
or
```bash
yarn add react-native-multistep
```
2. Import the `MultiStepForm` component into your app: 📜
```tsx
import { MultiStepForm } from 'react-native-multistep';
```
## ⚛️ Props
| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `stepsContent` (required) | `React.ReactNode[]` | - | An array of React nodes, where each node represents the content for each step. 🗂️ |
| `onStepChange` (optional) | `(currentStep: number) => void` | - | A callback triggered whenever the step changes. 🔄 |
| `onStepForward` (optional) | `(currentStep: number) => void` | - | A callback triggered when navigating to the **next step**. ⏭️ |
| `onStepBackward` (optional) | `(currentStep: number) => void` | - | A callback triggered when navigating to the **previous step**. 🔙 |
| `backButtonLabel` (optional) | `string` | `Back` | Label for the **Back button** 🔙 |
| `nextButtonLabel` (optional) | `string` | `Next` | Label for the **Next button** ▶️ |
| `doneButtonLabel` (optional) | `string` | `Done` | Label for the **Done button** ✅ |
| `onComplete` (optional) | `() => void` | - | A callback triggered when the form is **completed**. 🎉 |
| `style` (optional) | `StyleProp` | - | Custom style for the **root container**. 🖌️ |
| `nextButtonStyle` (optional) | `StyleProp` | - | Custom style for the **Next button** 🔹 |
| `previousButtonStyle` (optional) | `StyleProp` | - | Custom style for the **Previous button** 🔙 |
| `doneButtonStyle` (optional) | `StyleProp` | - | Custom style for the **Done button** ✅ |
| `stepsContainerStyle` (optional) | `StyleProp` | - | Custom style for the **step indicators container** 🔢 |
| `activeStepStyle` (optional) | `StyleProp` | - | Custom style for **active step indicators** 🔥 |
| `inactiveStepStyle` (optional) | `StyleProp` | - | Custom style for **inactive step indicators** ❄️ |
| `contentContainerStyle` (optional) | `StyleProp` | - | Custom style for the **content container** 📝 |
| `buttonsContainerStyle` (optional) | `StyleProp` | - | Custom style for the **footer buttons container** ⚙️ |
| `lineColor` (optional) | `string` | - | Custom color for the **line between indicators** ✅ |
| `activeLineColor` (optional) | `string` | - | Custom color for the **active line between indicators** ✅ |
## 📖 Usage Example 🧵
```tsx
import React from 'react';
import { MultiStepForm } from 'react-native-multistep';
import { Text, View } from 'react-native';
const App = () => {
const stepsContent = [
Step 1: Personal Information 👤,
Step 2: Address 📍,
Step 3: Review ✅,
];
const handleStepChange = (currentStep: number) => {
console.log(`Current Step: ${currentStep}`);
};
const handleComplete = () => {
console.log('Form Completed! 🎉');
};
return (
);
};
export default App;
```
## 🎨 Styling
The component uses `StyleSheet.create` for default styles. Customize your form by passing the relevant props:
- **Root Container**: `style` 🖌️
- **Step Indicator Container**: `stepsContainerStyle` 🔢
- **Active/Inactive Step Indicators**: `activeStepStyle`, `inactiveStepStyle` 🔥
- **Content Area**: `contentContainerStyle` 📝
- **Footer Buttons Container**: `buttonsContainerStyle` ⚙️
- **Back Button**: `previousButtonStyle` 🔙
- **Next Button**: `nextButtonStyle` ▶️
- **Done Button**: `doneButtonStyle` ✅
## 🔄 Animations
- **Step Indicator Animation** 🎥: The active step indicator includes a **scale effect** when selected, providing a quick visual cue to the user. 🔄
## 🤝 Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the project. 🛠️
## 📜 License
MIT 📝
---
Made with ❤️ by [Aziz Becha](https://azizbecha.com) 🌟