Node's Pretty Magical

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

    1.1.0 • Public • Published

    React Native Pluggy Connect SDK

    React Native bindings for our Pluggy Connect widget.

    Setup

    Using npm

    npm install react-native-webview react-native-pluggy-connect

    Using yarn

    yarn add -S react-native-webview react-native-pluggy-connect

    Usage

    Please check out our Connect React Native quickstart repo for a fully-working example you can use to get started right away.

    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
    selectedConnectorId If specified and the Connector is present, after accepting terms, the widget will navigate to this Connector login form directly, skipping connectors selection step. 🔲 number 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 (2-letter) used to display the widget. If not specified, or if the selected language is not supported, the default 'pt' will be used. 🔲 string Browser language
    theme Theme to use for displaying the UI. Can be 'light' or 'dark'. Defaults to 'light' 🔲 'light' | 'dark' 'light'
    onSuccess Function to execute when an Item has been created/updated successfully. 🔲 (data: { item: Item }) => void | Promise<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 | Promise<void> No op
    onOpen Function to execute when the widget modal has been opened. 🔲 () => void | Promise<void> No op
    onClose Function to execute when the widget modal has been closed. 🔲 () => void | Promise<void> No op
    onEvent Function to execute to handle custom user interaction events. See the docs for more info. 🔲 Since v2.0.0:
    (payload: ConnectEventPayload) => void | Promise<void>
    Until 1.x:
    (event: string, metadata: { timestamp: number }) => void
    No op

    Keywords

    none

    Install

    npm i react-native-pluggy-connect

    DownloadsWeekly Downloads

    29

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    126 kB

    Total Files

    69

    Last publish

    Collaborators

    • tmilar
    • nicolasmontone