fivvy-plaid-sdk
v0.6.2
Published
[![Version](https://img.shields.io/npm/v/fivvy-plaid-sdk.svg)](https://www.npmjs.com/package/fivvy-plaid-sdk) [![License](https://img.shields.io/npm/l/fivvy-plaid-sdk.svg)](https://www.npmjs.com/package/fivvy-plaid-sdk)
Downloads
56
Readme
Fivvy Plaid SDK
The Fivvy Plaid SDK is a powerful library that simplifies the integration of Plaid authentication into your application. With this SDK, you can streamline the process of connecting bank accounts and securely obtaining financial data from your users.
Installation
To integrate the SDK into your application, follow these steps:
npm install fivvy-plaid-sdk
Usage
To integrate the SDK into your application, follow these steps:
Import the OpenPlaidButton component into your code file:
import { OpenPlaidButton } from 'fivvy-plaid-sdk';
Make sure your component requires the following props:
- label (required): A string that defines the label or text to be displayed on the button.
- initialValues (required): A JSON object containing the email and password keys.
- primary (optional): A boolean to indicate whether the button should have a primary style.
- backgroundColor (optional): A string specifying the button's background color.
- size (optional): A string that can be 'small,' 'medium,' or 'large' to define the button's size.
Here's an example of the initialValues JSON:
const initialValues = {
email: '[email protected]',
password: 'your-password'
};
You can then use the OpenPlaidButton component in your user interface and provide the necessary props:
const initialValues = {
email: '[email protected]',
password: 'your-password'
};
<OpenPlaidButton
label="Connect Bank Account"
initialValues={initialValues}
primary={true}
backgroundColor="#00a0dc"
size="medium"
/>
Example
Here's a complete example of how to use the Fivvy Plaid SDK in a React application:
import React from 'react';
import { OpenPlaidButton } from 'fivvy-plaid-sdk';
const initialValues = {
email: '[email protected]',
password: 'your-password'
};
function App() {
return (
<div>
<h1>My Application</h1>
<OpenPlaidButton initialValues={initialValues} label="Connect Bank Account" />
</div>
);
}
export default App;