Documentation
Learn how to integrate OnboardPad into your applications
@onboardpad/react
Official React component for OnboardPad
Installation
npm install @onboardpad/react
Quick Start
import { OnboardPad } from '@onboardpad/react';
export default function App() {
  return (
    <div>
      <OnboardPad widgetId="your-widget-id" />
    </div>
  );
}With Callbacks
import { OnboardPad } from '@onboardpad/react';
export default function App() {
  const handleSubmit = (data) => {
    console.log('Submitted:', data);
  };
  const handleClose = () => {
    console.log('Widget closed');
  };
  return (
    <OnboardPad
      widgetId="your-widget-id"
      onSubmit={handleSubmit}
      onClose={handleClose}
    />
  );
}Props
| Prop | Type | Required | Default | Description | 
|---|---|---|---|---|
| widgetId | string | - | Your widget ID | |
| apiEndpoint | string | No | "/api" | API endpoint URL | 
| onSubmit | function | No | - | Called when form is submitted | 
| onClose | function | No | - | Called when widget is closed | 
| autoShow | boolean | No | true | Show widget immediately | 
Features
Multi-step form with progress indicator
Support for text, email, select, and textarea inputs
TypeScript support with full type definitions
Zero external dependencies
Responsive design
Customizable styling
Additional Resources
More ways to learn and get help