React Native Onboarding SDK

A flexible and customizable onboarding flow SDK for React Native applications.

Installation

npm install inspirex-onboarding-sdk
# or
yarn add inspirex-onboarding-sdk

Usage

1. Import and initialize the SDK:

import sdk from 'inspirex-onboarding-sdk';

// Initialize the SDK
sdk.initialize('your-api-key');

// Set user information
sdk.setUser({
  id: 'user-123',
  name: 'John Doe',
  email: '[email protected]',
  properties: { plan: 'premium' }
});

2. Start the flow and listen for events:

// Start the flow
sdk.startFlow();

// Listen for events
sdk.on('flowStart', (data) => {
  console.log('Flow started:', data.flowId);
});

sdk.on('flowComplete', (data) => {
  console.log('Flow completed:', data.flowId);
});

sdk.on('screenChange', (data) => {
  console.log('Screen changed:', data.screenId);
});

3. Render the flow in your React Native app:

import React from 'react';
import sdk from 'inspirex-onboarding-sdk';

const FlowComponent = sdk.getFlowComponent();

export const App = () => {
  return (
    <>
      {/* Your app content */}
      <FlowComponent />
    </>
  );
};

Features

• Fully customizable UI components
• TypeScript support
• Event-based architecture
• Screen navigation
• Modal-based presentation
• Flexible styling options

API Reference

SDK Methods

• initialize(apiKey: string): Initialize the SDK with your API key
• setUser(user: User): Set the current user information
• startFlow(): Start the onboarding flow
• completeFlow(): Complete the current flow
• getFlowComponent(): Get the React component to render the flow

Event Types

• flowStart: Emitted when the flow starts
• flowComplete: Emitted when the flow is completed
• screenChange: Emitted when the screen changes

License

ISC