expo-tiktok-business v0.1.2

expo-tiktok-business

An Expo module for the TikTok Business SDK that helps you track events and conversions in your Expo app. This module supports iOS, Android, and has stub implementation for web.

Features

• 📱 Cross-platform support (iOS, Android, web)
• 🔍 Debug mode for development
• 🧩 Standard TikTok events defined as enums
• 🔄 Automatic app lifecycle tracking
• 🛣️ Expo Router integration for screen tracking
• 🛠️ Helper methods for common events

Installation

In managed Expo projects

npx expo install expo-tiktok-business

In bare React Native projects

npm install expo-tiktok-business
npx expo prebuild --clean

Configure for iOS

npx pod-install

Usage

Initialize the SDK

Platform-specific initialization

TikTok often requires different App IDs for iOS and Android. You can provide platform-specific IDs:

// With platform-specific app IDs and TikTok App IDs
TiktokSDK.initialize(
  {
    ios: 'APPLE_APP_ID',      // iOS app ID
    android: 'com.yourcompany.yourapp',  // Android package name
    default: 'com.yourcompany.yourapp'   // Fallback for other platforms
  },
  {
    ios: 'YOUR_IOS_TIKTOK_APP_ID',       // TikTok App ID for iOS
    android: 'YOUR_ANDROID_TIKTOK_APP_ID', // TikTok App ID for Android
    default: 'YOUR_DEFAULT_TIKTOK_APP_ID'  // Fallback for other platforms
  },
  {
    debugMode: __DEV__
  }
);

Track Standard Events

// Track a product view
TiktokSDK.trackEvent(TiktokEventName.VIEW_CONTENT, {
  content_id: 'product-123',
  content_type: 'product',
  content_category: 'electronics',
});

// Track a search
TiktokSDK.trackSearch('wireless headphones', {
  category: 'electronics',
});

// Track a purchase
TiktokSDK.trackCompletePurchase(
  99.99, // value
  'USD', // currency
  [
    {
      content_id: 'product-123',
      content_type: 'product',
      content_name: 'Wireless Headphones',
      quantity: 1,
      price: 99.99,
    }
  ],
  {
    order_id: 'ORDER-12345',
  }
);

Expo Router Integration

import { useTiktokRouteTracking } from 'expo-tiktok-business';

// In your app's root component
export default function App() {
  // This will initialize tracking for Expo Router
  useTiktokRouteTracking();
  
  return (
    <RootLayoutNav />
  );
}

// Alternatively, use the HOC
import { withTiktokRouteTracking } from 'expo-tiktok-business';

const MyComponent = () => <View>...</View>;
export default withTiktokRouteTracking(MyComponent);

For manual integration with Expo Router:

import { usePathname, useSearchParams } from 'expo-router';
import { ExpoRouterIntegration } from 'expo-tiktok-business';

// In your app's root component
useEffect(() => {
  // Provide the Expo Router hooks directly
  ExpoRouterIntegration.setupWithRouter(usePathname, useSearchParams);
  
  return () => {
    ExpoRouterIntegration.cleanup();
  };
}, []);

Debug Mode

Enable debug mode during development to see events in the console:

// During initialization
TiktokSDK.initialize('YOUR_APP_ID', 'YOUR_TIKTOK_APP_ID', { debugMode: true });

// Or toggle it later
TiktokSDK.setDebugMode(true);

Available Standard Events

The module includes all standard TikTok events as enums:

• TiktokEventName.LAUNCH - App launch
• TiktokEventName.APP_INSTALL - App installation
• TiktokEventName.SEARCH - User searched for content
• TiktokEventName.VIEW_CONTENT - User viewed content
• TiktokEventName.CLICK - User clicked on content
• TiktokEventName.ADD_TO_WISHLIST - User added item to wishlist
• TiktokEventName.ADD_TO_CART - User added item to cart
• TiktokEventName.INITIATE_CHECKOUT - User started checkout
• TiktokEventName.ADD_PAYMENT_INFO - User added payment info
• TiktokEventName.COMPLETE_PAYMENT - User completed payment
• TiktokEventName.PLACE_AN_ORDER - User placed an order
• TiktokEventName.SUBSCRIBE - User subscribed
• TiktokEventName.CONTACT - User initiated contact
• TiktokEventName.CUSTOM - Custom event

Credits and Contributions

This module is based on the foundation work by Lior Levy from the original expo-tiktok-business project. We've extended it with:

• Platform-specific app ID and TikTok app ID support
• Enhanced event tracking with strongly-typed parameters
• Automatic app lifecycle tracking
• Expo Router integration
• Debug mode support based on TikTok's documentation

Special thanks to the original authors for providing the initial implementation.

License

MIT

Generated with contributions from the community.