Gathering detailed insights and metrics for react-plaid-link
Gathering detailed insights and metrics for react-plaid-link
Gathering detailed insights and metrics for react-plaid-link
Gathering detailed insights and metrics for react-plaid-link
npm install react-plaid-link
Typescript
Module System
Node Version
NPM Version
95
Supply Chain
94.8
Quality
85.4
Maintenance
100
Vulnerability
100
License
TypeScript (65.85%)
JavaScript (27.29%)
Makefile (5.29%)
Shell (1.58%)
Total Downloads
31,977,741
Last Day
42,819
Last Week
284,027
Last Month
855,150
Last Year
9,523,543
272 Stars
164 Commits
151 Forks
53 Watching
43 Branches
234 Contributors
Minified
Minified + Gzipped
Latest Version
3.6.1
Package Id
react-plaid-link@3.6.1
Unpacked Size
179.33 kB
Size
26.87 kB
File Count
29
NPM Version
10.8.2
Node Version
20.17.0
Publised On
30 Oct 2024
Cumulative downloads
Total Downloads
Last day
-6.6%
42,819
Compared to previous day
Last week
20.9%
284,027
Compared to previous week
Last month
5.8%
855,150
Compared to previous month
Last year
8.2%
9,523,543
Compared to previous year
2
53
React hook and components for integrating with Plaid Link
React 16.8+
With npm
:
npm install --save react-plaid-link
With yarn
yarn add react-plaid-link
Please refer to the official Plaid Link docs for a more holistic understanding of Plaid Link.
Head to the react-plaid-link
storybook to try out a live demo.
See the examples folder for various complete source code examples.
This is the preferred approach for integrating with Plaid Link in React.
Note: token
can be null
initially and then set once you fetch or generate
a link_token
asynchronously.
ℹ️ See a full source code examples of using hooks:
1import { usePlaidLink } from 'react-plaid-link'; 2 3// ... 4 5const { open, ready } = usePlaidLink({ 6 token: '<GENERATED_LINK_TOKEN>', 7 onSuccess: (public_token, metadata) => { 8 // send public_token to server 9 }, 10}); 11 12return ( 13 <button onClick={() => open()} disabled={!ready}> 14 Connect a bank account 15 </button> 16);
ℹ️ See src/types/index.ts for exported types.
Please refer to the official Plaid Link
docs for a more holistic understanding of
the various Link options and the
link_token
.
usePlaidLink
argumentskey | type |
---|---|
token | string | null |
onSuccess | (public_token: string, metadata: PlaidLinkOnSuccessMetadata) => void |
onExit | (error: null | PlaidLinkError, metadata: PlaidLinkOnExitMetadata) => void |
onEvent | (eventName: PlaidLinkStableEvent | string, metadata: PlaidLinkOnEventMetadata) => void |
onLoad | () => void |
receivedRedirectUri | string | null | undefined |
usePlaidLink
return valuekey | type |
---|---|
open | () => void |
ready | boolean |
submit | (data: PlaidHandlerSubmissionData) => void |
error | ErrorEvent | null |
exit | (options?: { force: boolean }, callback?: () => void) => void |
Handling OAuth redirects requires opening Link without any user input (such as clicking a button). This can also be useful if you simply want Link to open immediately when your page or component renders.
ℹ️ See full source code example at examples/oauth.tsx
1import { usePlaidLink } from 'react-plaid-link'; 2 3// ... 4 5const { open, ready } = usePlaidLink(config); 6 7// open Link immediately when ready 8React.useEffect(() => { 9 if (ready) { 10 open(); 11 } 12}, [ready, open]); 13 14return <></>;
If you cannot use React hooks for legacy reasons such as incompatibility with
class components, you can use the PlaidLink
component.
ℹ️ See full source code example at examples/component.tsx
1import { PlaidLink } from "react-plaid-link"; 2 3const App extends React.Component { 4 // ... 5 render() { 6 return ( 7 <PlaidLink 8 token={this.state.token} 9 onSuccess={this.onSuccess} 10 // onEvent={...} 11 // onExit={...} 12 > 13 Link your bank account 14 </PlaidLink> 15 ); 16 } 17}
TypeScript definitions for react-plaid-link
are built into the npm package.
If you have previously installed @types/react-plaid-link
before this package
had types, please uninstall it in favor of built-in types.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
all changesets reviewed
Reason
license file detected
Details
Reason
5 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 4
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
68 existing vulnerabilities detected
Details
Score
Last Scanned on 2025-01-20
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More