React Native Quick Start

Get session recording working in your React Native app in under 5 minutes.

Prerequisites

• React Native 0.68+ or Expo SDK 47+
• iOS deployment target 12.0+ / Android minSdkVersion 21+
• A UXCam account with an app key

Step 1: Install the Package

# npm
npm install react-native-ux-cam

# yarn
yarn add react-native-ux-cam

For iOS, install pods:

cd ios && pod install

Step 2: Initialize UXCam

In your App.js or entry file:

import RNUxcam from 'react-native-ux-cam';

// Enable video recording (required)
RNUxcam.optIntoVideoRecordings();

// Start UXCam
RNUxcam.startWithConfiguration({
  userAppKey: 'YOUR_APP_KEY',
  enableAutomaticScreenNameTagging: false,
  enableImprovedScreenCapture: true,
});

import RNUxcam from 'react-native-ux-cam';

interface UXCamConfig {
  userAppKey: string;
  enableAutomaticScreenNameTagging?: boolean;
  enableImprovedScreenCapture?: boolean;
}

const config: UXCamConfig = {
  userAppKey: 'YOUR_APP_KEY',
  enableAutomaticScreenNameTagging: false,
  enableImprovedScreenCapture: true,
};

RNUxcam.optIntoVideoRecordings();
RNUxcam.startWithConfiguration(config);

Step 3: Verify It Works

1. Run your app on a device or emulator
2. Navigate through a few screens
3. Send the app to background
4. Check your UXCam Dashboard - your session should appear within 30 seconds

Next Steps

You're recording sessions! Now customize your integration: