react-pluggy-connect v2.10.1

React Pluggy Connect SDK

React Bindings for our Pluggy Connect widget.

Setup

Using npm

npm install react-pluggy-connect

Using yarn

yarn add -S react-pluggy-connect

Import directly as an HTML <script>:

<script src="https://cdn.pluggy.ai/react-pluggy-connect/v2.8.1/react-pluggy-connect.js"></script>

Additionally, you can refer to the latest release by referencing the URL like so:

<script src="https://cdn.pluggy.ai/react-pluggy-connect/latest/react-pluggy-connect.js"></script>

Usage

The following is a minimal example to get started. See below for more all the available configurations.

For a more advanced, fully-working example you can use to get started right away, please check out our Connect Quickstart repo.

import React from 'react';
import ReactDOM from 'react-dom';

import { PluggyConnect } from 'react-pluggy-connect';

const Index = () => {
  const onSuccess = (itemData) => {
    // do something with the financial data
  };

  const onError = (error) => {
    // handle the error
  };

  return (
    <PluggyConnect
      connectToken={'your-connect-token-here'}
      onSuccess={onSuccess}
      onError={onError}
    />
  );
};

ReactDOM.render(<Index />, document.getElementById('root'));

Typescript Support

This project was built using Typescript so all typings are natively built-in.

However, for up-to-date Pluggy API typings to work, you'll need to install pluggy-js in your project as well, either as a dev or prod dependency.

npm install pluggy-js

Cordova Support

If your project is using Cordova (ie. Ionic Framework), be sure to also install the cordova-plugin-inappbrowser plugin.

This is necessary for links to be opened properly in the system browser, and for Oauth redirects to work as expected, without blocking the main app frame.

cordova plugin add cordova-plugin-inappbrowser

Configurations

The available configuration props are the following.

See our official Pluggy Connect widget documentation for more detailed information.

onEvent

This callback allows handling more specific events.

The property event inside the payload param of the onEvent callback, is the name of the current event triggered. The available events that can be handled through this method are:

payload object has a property timestamp and some events extra data:

'SELECTED_INSTITUTION' has the connector property which is the connector selected by the user. 'LOGIN_SUCCESS' | 'LOGIN_MFA_SUCCESS' | 'LOGIN_STEP_COMPLETED' | 'ITEM_RESPONSE' events have the item property which is the item data related to the current connection.

Full event parameter type definition is:

type ConnectEventPayload = {
  timestamp: number;
} & (
  | {
      event: 'SUBMITTED_CONSENT' | 'SUBMITTED_LOGIN' | 'SUBMITTED_MFA';
    }
  | {
      event: 'SELECTED_INSTITUTION';
      connector: Connector | null;
    }
  | {
      event: 'LOGIN_SUCCESS' | 'LOGIN_MFA_SUCCESS' | 'LOGIN_STEP_COMPLETED' | 'ITEM_RESPONSE';
      item: Item;
    }
);