Quickstart guide (Expo)

DevRev SDK, used for integrating DevRev services into your Expo app.

Requirements

React Native 0.79.0 or later.
For Expo apps, Expo 50.0.0 or later.
Android: minimum API level 24.
iOS: minimum deployment target 15.1.
Recommended: A locally configured SSH key registered on Github.

Installation

To install the DevRev SDK, run the following command:

npx expo install @devrev/sdk-react-native-expo-plugin

Configure the Expo config plugin in your app.json or app.config.js:

{
  "expo": {
    "plugins": [
      "@devrev/sdk-react-native-expo-plugin"
    ]
  }
}

Rebuild your app:
```
npx expo prebuild --clean
```

Set up the DevRev SDK

Open the DevRev web app at https://app.devrev.ai and go to the Settings page.
Under Plug settings copy the value under Your unique App ID.
Configure the DevRev SDK in your app using the obtained credentials.

The DevRev SDK must be configured before you can use any of its features.

The SDK is ready for use after the configuration API is called.

DevRev.configure(appID)

To provide a feature configuration during setup, use the overload that accepts it:

DevRev.configure(appID, featureConfiguration)

For default behavior, use the simpler form:

DevRev.configure('abcdefg12345')

To customize behavior such as frame capture, auto-start recording, or theme preferences, pass a full FeatureConfiguration object:

DevRev.configure('abcdefg12345', {
  enableFrameCapture: false,
  autoStartRecording: false,
  prefersDialogMode: false,
  alwaysUseRemoteConfig: true,
  supportWidgetTheme: {
    prefersSystemTheme: true,
  },
});

Update the feature configuration

Adjust the feature configuration without reconfiguring the SDK by passing a complete FeatureConfiguration object (all properties are required):

DevRev.updateFeatureConfiguration({
  enableFrameCapture: true,
  autoStartRecording: true,
  prefersDialogMode: false,
  alwaysUseRemoteConfig: true,
  supportWidgetTheme: {
    prefersSystemTheme: true,
  },
});

Feature configuration reference

FeatureConfiguration controls how the SDK behaves both during initial setup and when calling DevRev.updateFeatureConfiguration(...). All properties are required when providing a feature configuration.

Property	Type	Default	Description
`enableFrameCapture`	`boolean`	`true`	Enables the screen capture pipeline used by session replay.
`autoStartRecording`	`boolean`	`true`	Automatically starts recording after the SDK finishes remote configuration.
`prefersDialogMode`	`boolean`	`false`	Enables dialog mode for the support UI (Android only).
`alwaysUseRemoteConfig`	`boolean`	`true`	Ignores local configuration and always fetches settings from the remote config service.
`supportWidgetTheme`	`SupportWidgetTheme`	—	Controls the appearance of the in-app support widget, including dynamic theme behavior.

SupportWidgetTheme controls the appearance of the support UI. Use the supportWidgetTheme property inside your feature configuration.

const customTheme = {
  prefersSystemTheme: false,
  primaryTextColor: '#1F2933',
  accentColor: '#F97316',
  spacing: {
    bottom: '20px',
    side: '16px',
  },
};

Property	Type	Default	Description
`prefersSystemTheme`	`boolean`	`true`	Follows the device appearance when `true`; otherwise uses your custom colors.
`primaryTextColor`	`string?`	—	Hex color string (e.g. `'#000000'`, `'#1F2933'`) for primary text in the support widget.
`accentColor`	`string?`	—	Hex color string (e.g. `'#F97316'`, `'#FF0000'`) applied to buttons and highlights.
`spacing`	`{ [key: string]: string }?`	—	CSS-like spacing overrides (`bottom` and `side` keys are recognized).

Sample app

A sample app with use cases for the DevRev Expo plugin is available in the public repository. To set up and run the sample app:

Go to the sample directory:
```
cd sample/expo
```
Install dependencies:
```
yarn install
```
Run clean and prebuild:
```
npx expo prebuild --clean
```
Run the app On Android:
```
npx expo run:android
```
OR open android in Android Studio and run the app.
Run the app On iOS:
```
npx expo run:ios
```
OR open ios/DevRevSDKSample.xcworkspace in Xcode and run the app.