Unit White-Label UIs SDK for React Native 🚀

Installation (Customers)

Add the react-native-unit-components dependency to your project:

With npm:

$ npm install --save react-native-unit-components

With yarn:

$ yarn add react-native-unit-components

Follow The Official Documentation

Please follow the official White-Label UIs React Native SDK documentation.

Developer Setup

Basic Setup (without Veryfi)

1. Install root dependencies:

   yarn install

2. Install example app dependencies:

   cd example && yarn install

3. Start Metro bundler:

   yarn start

For iOS, run pod install in example/ios/ before launching.

Setup with Veryfi Check Scanning

To enable the Veryfi check scanning SDK in the example app, you need a .env.veryfi file in the project root.

1. Obtain the .env.veryfi file from a team member and place it in the project root. The expected format is:

   VERIFY_API_CLIENT_ID=<value>
   VERIFY_API_CLIENT_SECRET=<value>
   VERIFY_API_USER=<value>
   VERIFY_API_KEY=<value>
   VERIFY_COCOAPODS_USERNAME=<value>
   VERIFY_COCOAPODS_PASSWORD=<value>
   VERIFY_MAVEN_USERNAME=<value>
   VERIFY_MAVEN_PASSWORD=<value>
   VERIFY_RN_NPM_USERNAME=<value>
   VERIFY_RN_NPM_PASSWORD=<value>

   A template with all the required keys is available in .verifyCredentials.

2. Run the setup script:

   yarn setup-veryfi

   This configures npm registry credentials, CocoaPods/Maven auth, adds the Veryfi dependency to the example app, and generates the runtime config file.

3. Then proceed with the regular install flow:

   yarn install
   cd example && yarn install
   yarn start

To disable Veryfi after enabling it, remove the .env.veryfi file and re-run the setup:

rm .env.veryfi
yarn setup-veryfi
cd example && yarn install

Note: The bootstrap, installOldArch, and installNewArch scripts run setup-veryfi automatically. If you use those, you don't need to run it separately.

SDK Compatibility Testing with yalc

The test-sdk-yalc.sh script validates that the published SDK package works correctly as a real npm dependency (not via the workspace link used in development).

# Test without Veryfi
bash scripts/test-sdk-yalc.sh without-veryfi

# Test with Veryfi (requires .env.veryfi in project root)
bash scripts/test-sdk-yalc.sh with-veryfi

This builds the SDK, publishes it to a local yalc store, installs it as a real dependency in the example app, runs a TypeScript check, and then cleans up. Use this when changing SDK exports, the files array in package.json, or anything related to the Veryfi optional dependency.