Skip to content
React bindings for Plaid Link
Branch: master
Clone or download
Latest commit e192638 Mar 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Update and cleanup Jan 16, 2018
src Add "holdings" beta + Auth "user" object Mar 1, 2019
test add linting Jun 19, 2017
.babelrc Update PlaidLink.js to ES6 format (#21) Dec 15, 2017
.eslintrc.js Update and cleanup Jan 16, 2018
.gitignore
.travis.yml initial attempt Apr 11, 2016
LICENSE Update and cleanup Jan 16, 2018
Makefile
README.md
package.json
server.js
webpack.config.js Update and cleanup Jan 16, 2018
webpack.dist.config.js Update and cleanup Jan 16, 2018

README.md

react-plaid-link npm version

A simple React component for easy integration with the Plaid Link drop-in module

Install

npm install react-plaid-link --save

Example Usage

import React, { Component } from 'react'
import PlaidLink from 'react-plaid-link'

class App extends Component {
  handleOnSuccess(token, metadata) {
    // send token to client server
  }
  handleOnExit() {
    // handle the case when your user exits Link
  }
  render() {
    return (
      <PlaidLink
        clientName="Your app name"
        env="sandbox"
        product={["auth", "transactions"]}
        publicKey="PLAID_PUBLIC_KEY"
        onExit={this.handleOnExit}
        onSuccess={this.handleOnSuccess}>
        Open Link and connect your bank!
      </PlaidLink>
    )
  }
}
export default App

All Props

Please refer to the official Plaid Link docs for a more holistic understanding of the various Link options.

<PlaidLink
  clientName="Your app name"
  env="sandbox"
  institution={null}
  publicKey={PLAID_PUBLIC_KEY}
  product={['auth', 'transactions']}
  apiVersion={'v1' || 'v2'}
  token={'public-token-123...'}
  selectAccount={true} // deprecated – use https://dashboard.plaid.com/link
  webhook="https://webhooks.test.com"
  onEvent={this.handleOnEvent}
  onExit={this.handleOnExit}
  onLoad={this.handleOnLoad}
  onSuccess={this.handleOnSuccess}>
  Open Link and connect a bank account to Plaid
</PlaidLink>

Contributing

Run tests:

make test

Development

# install dependencies
make setup

# run a local server
make start

# open localhost:3000
You can’t perform that action at this time.