react-pluggy-connect
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    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/v0.1.2/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

    Configurations

    The available configuration props are the following.

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

    Property Description Required? Type Default
    connectToken Your Pluggy Connect token, which will be used to access the API. string N/A
    includeSandbox Whether to display Sandbox connectors in the Connector selection step (not intended for production use) 🔲 boolean false
    updateItem Item id to update. If specified, the modal will display directly the credentials form of the item to be updated. 🔲 string N/A
    connectorTypes List of Connector Types. If defined, only Connectors of the specified connector types will be listed. 🔲 ConnectorType[] N/A
    countries List of country codes (ISO-3166-1 alpha 2 format). If defined, only Connectors of the specified countries will be listed. 🔲 CountryCode[] N/A
    language Language ISO string used to display the widget. If not specified, the browser language will be used, falling back to 'en' if not supported. 🔲 string Browser language
    onSuccess Function to execute when an Item has been created/updated successfully. 🔲 (data: { item: Item }) => void No op
    onError Function to execute on a general error loading the widget, or when an Item creation/update status has not been successful. 🔲 (error: { message: string; data?: { item: Item } }) => void No op
    onOpen Function to execute when the widget modal has been opened. 🔲 () => void No op
    onClose Function to execute when the widget modal has been closed. 🔲 () => void No op
    onEvent Function to execute to handle custom user interaction events. See the docs for more info. 🔲 (event: string, metadata: { timestamp: number }) => void No op

    Keywords

    none

    Install

    npm i react-pluggy-connect

    DownloadsWeekly Downloads

    15

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    32.7 kB

    Total Files

    14

    Last publish

    Collaborators

    • fmiras
    • tmilar