Install OnboardJS
Installing OnboardJS is a breeze.
Install packages
Install the core library and the React hooks package to get started.
Terminal
1 lines
1npm install @onboardjs/core @onboardjs/react
Terminal
1 lines
1pnpm install @onboardjs/core @onboardjs/react
Terminal
1 lines
1yarn add @onboardjs/core @onboardjs/react
Easy to configure
Configure your onboarding steps and component registry in a few lines of code.
tsx
17 lines
1export const steps = [
2 {
3 id: 'welcome',
4 payload: {
5 title: 'Welcome to Our App!',
6 },
7 },
8 {
9 id: 'profile-details',
10 type: 'CUSTOM_COMPONENT',
11 payload: {
12 componentKey: 'ProfileSetupForm', // A key to identify which custom component to render
13 title: 'Complete Your Profile',
14 },
15 nextStep: null,
16 },
17]
Features
Powerful features to help you manage customer onboarding
Insight
🎯 Headless & Framework Agnostic
Bring your own UI. OnboardJS handles the complex state management while you focus on design.
Developer Experience
⚡ Built with TypeScript
Full type safety, autocomplete, and IntelliSense support. No more runtime surprises.
Speed
🔄 Smart State Management
Complex conditional flows, persistence, and navigation handled automatically.
Extensibility
🔌 Plugin Ecosystem
Easily extend functionality with plugins. Integrate with your favorite tools and services.
Ride the Wave
🌊 Dynamic Flow Control
Create dynamic, context-aware onboarding flows that adapt to user behavior.