react-native-persona

Persona Android SDKs and Demo

Development

First, run yarn in the project root.

yarn

To test changes to SDK, we will use the Example App in example app.

Start Metro bundler.

This will bundle JavaScript and serve it to your React Native sample app. Keep the Metro bundler running in a terminal.

yarn example start

Metro bundler compiles source code and caches compiled targets to speed up incremental rebuilds. However, it's possible that this can lead to random failures if things get out of sync. If you ever run into any weird issues, it's worth running yarn example start --reset-cache again.

Start example app in iOS simulator

Use the built-in CLI command with Metro running.

yarn example ios

Or open ios/example.xcworkspace in XCode and build + run.

Start example app in Android simulator

Use the built-in CLI command with Metro running.

yarn example android

Or open the Android project in Android Studio and build + run.

Theming the example app

Run the persona-tool to customize the theme.

$ cd example
$ yarn persona-tool

Adding Dependencies

If you need to add any open source dependencies to this project, you'll need to make sure that the license for that project is acceptable. At the time of writing, licenses that are not GPL, LGPL, or AGPL are likely to be acceptable. Please consult with #legal for specific questions though.

We use the license_finder gem to ensure that we're only using open source projects with licenses that we explicitly allow. If and when you need to add a new license to our allow-list, you can edit the file at doc/dependency_decisions.yml accordingly. If you check out license_finder's documentation, you'll see how to use the tool to make these updates to the yml file.

Installing in your own project

yarn add react-native-persona

Usage

import {Environment, Inquiry} from "react-native-persona";

// Start an inquiry.
Inquiry.fromTemplate('itmpl_Ygs16MKTkA6obnF8C3Rb17dm')
  .environment(Environment.SANDBOX)
  .onComplete((inquiryId, status, fields) =>
    Alert.alert('Complete', `Inquiry ${inquiryId} completed with status "${status}."`,),
  )
  .onCanceled((inquiryId, sessionToken) =>
    Alert.alert('Canceled', `Inquiry ${inquiryId} was cancelled`),
  )
  .onError(error => Alert.alert('Error', error.message))
  .build()
  .start();

Theming

Set your own colors, buttons, fonts, and more. This can be done via the Persona Dashboard. For more information on using the theme editor, see our help article.

Note that the following instructions are for deprecated client side theming only.

To test legacy client side themes, use the example app:

cd example

Link the persona-tool using the following command (only necessary during development, linked automatically when the package is installed using yarn add or npm install).

yarn dev-only:link-bin

To unlink:

yarn dev-only:unlink-bin

Run through the tool using yarn persona-tool and following the instructions to add the required snippet to your package.json.

Update theme colors accordingly:

• Example: Update persona.androidTheme.backgroundColor to #FFFFFF

Run yarn persona-tool again.

Launch the example app and launch a flow.

Updating SDK Versions

Android

Update the sdk version in android/build.gradle

implementation 'com.withpersona.sdk2:inquiry:X.Y.Z'

iOS

Update the sdk version in RNPersonaInquiry2.podspec

s.dependency 'PersonaInquirySDK2', '~> X.Y.Z'

Go to example/ios directory, update the Podfiles by running

pod update PersonaInquirySDK2 --repo-update
pod install --repo-update

React Native

Bump react native version in package.json if needed.

Commit and push changed files including:

• android/build.gradle
• RNPersonaInquiry2.podspec
• package.json
• example/ios/Podfile.lock