Finicity Connect React Native SDK

Overview

Finicity Connect React Native SDK provides an easy way for developers to integrate Finicity Connect into their React Native application.

Installing

$3

The SDK has the following peerDependencies:

- react-native-inappbrowser-reborn >=3.6
- react-native-webview >=11
- react >=16.13
- react-native >=0.63

NOTE: make sure to run pod install after installing these dependencies

$3

``bash
npm install @finicity/connect-react-native-sdk
`

$3

`tsx
import {
FinicityConnect,
ConnectEventHandlers,
} from '@finicity/connect-react-native-sdk';

const MyConnectComponent = () => {
const eventHandlers: ConnectEventHandlers = {
onDone: (event: ConnectDoneEvent) => {},
onCancel: (event: ConnectCancelEvent) => {},
onError: (event: ConnectErrorEvent) => {},
onRoute: (event: ConnectRouteEvent) => {},
onUser: (event: any) => {},
onLoad: () => {},
};
return (
connectUrl={'#GENERATED_CONNECT_URL#'}
eventHandlers={eventHandlers}
linkingUri={'#UNIVERSAL_LINK#'}
>
);
};
``

Connect Event Handlers

| Event Type | Description |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| onLoad | Called when the Connect web page is loaded and ready to display |
| onDone | Called when the user successfully completes the Connect application |
| onCancel | Called when the user cancels the Connect application |
| onError | Called when an error occurs while the user is using the Connect |
| onRoute | Called with the user is navigating through the screens of the Connect application |
| onUser | Called when a user performs an action. User events provide visibility into what action a user could take within the Connect application |

For more detailed information on these events visit: Connect Event Types

Version compatibility

| Version | Compatibility |
| ------- | ------------- |
| 1.x | React 16+ |