1.0.0-rc.7 • Published 3 years ago

@finicity/connect-react-native-sdk v1.0.0-rc.7

Weekly downloads
-
License
-
Repository
-
Last release
3 years ago

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

Dependencies

The SDK has the following peerDependencies:

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

NPM

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

Usage

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 (
    <FinicityConnect
      connectUrl={'#GENERATED_CONNECT_URL#'}
      eventHandlers={eventHandlers}
      linkingUri={'#UNIVERSAL_LINK#'}
    ></FinicityConnect>
  );
};

Connect Event Handlers

Event TypeDescription
onLoadCalled when the Connect web page is loaded and ready to display
onDoneCalled when the user successfully completes the Connect application
onCancelCalled when the user cancels the Connect application
onErrorCalled when an error occurs while the user is using the Connect
onRouteCalled with the user is navigating through the screens of the Connect application
onUserCalled 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

VersionCompatibility
1.xReact 16+
1.0.0-rc.7

3 years ago

1.0.0-rc.6

3 years ago

1.0.0-rc.5

4 years ago

1.0.0-rc.4

4 years ago

1.0.0-rc.3

4 years ago