react-native-onboarding-wizard
v0.1.1
Published
A customizable onboarding wizard for React Native and Expo apps with steps, validation, transitions, and persistence.
Maintainers
Readme
react-native-onboarding-wizard
A flexible, validation-first onboarding wizard for React Native (Expo friendly).
Features
- Multi-step with per-step validation (sync/async)
- Conditional steps
- Before-next async guards
- Progress indicators
- Reset/Back/Next
- Controlled or uncontrolled data
- Optional persistence (bring your own storage, e.g. AsyncStorage)
- Slide/Fade transitions (Animated API)
- Keyboard-aware, RTL-friendly
- Theming & component overrides
Install
npm i react-native-onboarding-wizard
# or
yarn add react-native-onboarding-wizardBasic Usage
import { OnboardingWizard, OnboardingStep } from 'react-native-onboarding-wizard';
type Data = { name?: string; age?: string; color?: string };
const steps: OnboardingStep<Data>[] = [
{ key: 'name', title: 'Your name', render: ({ data, setData }) => /* ... */, validate: d => !!d.name || { name: 'Required' } },
// ...
];
<OnboardingWizard<Data>
steps={steps}
onFinish={(finalData) => console.log(finalData)}
/>