Skip to main content
The ClickTerm React Native SDK (@clickterm/react-native-sdk) is an Expo Module that wraps the native iOS and Android Clickterm SDKs so React Native apps — Expo or bare — can present clickwrap dialogs without writing custom native bridges.
Latest SDK versions: Web 2.3.0 · Android 2.2.0 · React Native 0.3.0View changelog

Requirements

  • React Native 0.75+ or Expo SDK 52+
  • iOS 15.0+
  • Android minSdk 24

Install the package

npm install @clickterm/react-native-sdk

Expo apps

Add the SDK to your app’s plugins array in app.json so Expo CLI and EAS Build pick it up during prebuild:
app.json
{
  "expo": {
    "plugins": ["@clickterm/react-native-sdk"]
  }
}
The plugin is a no-op shim today, but listing it follows the conventional Expo install path that npx expo prebuild and EAS Build expect. After updating app.json, run:
npx expo prebuild
EAS Build picks up the plugin automatically.

Bare React Native apps

After installing the package, install the iOS CocoaPods:
cd ios && pod install
The iOS ClicktermSDK.xcframework is not bundled in the npm package — it’s downloaded automatically from the ClickTerm CDN during pod install, with a best-effort prefetch right after npm install on macOS. There’s no manual fetch step. If the download ever fails (offline, restricted CI, or a CDN hiccup), pod install stops with an actionable message — restore connectivity and re-run it, or fetch the framework manually with npm run fetch:xcframework.
No additional steps are required for Android — the native dependency is resolved automatically from Maven Central.

Initialize the SDK

Once the package is installed, initialize it as early as possible in your app — typically in the root component or app entry point:
import * as Clickterm from '@clickterm/react-native-sdk';

await Clickterm.initialize('YOUR_CLICKTERM_APP_ID');
Get your App ID from the Integrations page in the ClickTerm Dashboard.
Never expose your App Key in client-side code. The App Key is used only for backend verification calls. The client SDK uses only the App ID. Store the App Key safely — it won’t display again after creation, but can be regenerated. Regenerating the key requires updating your backend configuration.

Requirements for showing a clickwrap

  • The template must be Enabled in the dashboard
  • The template must have at least one published content version in the Effective state

Next steps

ClicktermClient

SDK initialization.

ClicktermDialog

Showing clickwrap dialogs and accepted content.