PlaidLink API
API reference docs for the Stash PlaidLink component. Learn about the props, CSS, and other APIs of this exported module.
Import
ts
import PlaidLink from '@leaflink/stash/PlaidLink.vue';Props
| Name | Type | Default | Description |
|---|---|---|---|
| createToken | TSFunctionType | undefined | Function that returns a link token object to be used with Plaid. `link_token` takes precedence over `token` if informed. |
| env | TSTypeReference | sandbox | Plaid environment to connect |
| initScriptUrl | string | 'https://cdn.plaid.com/link/v2/stable/link-initialize.js' | |
| returnTo | string | 'window.location.href' | Url to be used to redirect the user from the OAuth flow |
| storageKey | string | undefined | Key to be used in session storage for OAuth flow |
| token | string | undefined | Plaid link token |
Slots
| Name | Description |
|---|---|
| default | Default slot to trigger Plaid's modal |
Events
| Name | Description |
|---|---|
| error | Emitted whenever the exit event contains errors |
| success | Emitted whenever the user successfully links an item |
| exit | Emitted whenever the user exits the Link flow |
| load | Emitted when the Link is ready to be opened |
| event | Emitted at specific points during the Link flow |