# vue-plaid-link

> A vue plugin for Plaid Link

Latest version **0.6.1** (published 2021-12-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-plaid-link
pnpm add vue-plaid-link
yarn add vue-plaid-link
bun add vue-plaid-link
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.1 |
| Published | 2021-12-01 |
| First published | 2018-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Author | hi@chrisanderson.io |
| Maintainers | pushchris, bfine9618, manuelreneduran |
| Keywords | vue, plaid, link |

## Links

- npm: https://www.npmjs.com/package/vue-plaid-link
- Repository: https://github.com/roundupapp/vue-plaid-link
- Homepage: https://github.com/roundupapp/vue-plaid-link#readme
- Issues: https://github.com/roundupapp/vue-plaid-link/issues
- npm.io page: https://npm.io/package/vue-plaid-link

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.6.1 (latest) — 2021-12-01
- 0.6.2-beta.1 (beta) — 2022-04-19
- 0.6.2-beta.0 — 2022-04-19
- 0.6.0 — 2021-11-03
- 0.5.0 — 2021-04-30
- 0.4.0 — 2019-07-24
- 0.3.0 — 2018-12-21
- 0.2.2 — 2018-03-26
- 0.2.1 — 2018-03-26
- 0.2.0 — 2018-03-16
- 0.1.1 — 2018-03-16
- 0.1.0 — 2018-02-26

## README

# vue-plaid-link

A simple Vue component for easy integration with the [Plaid Link drop-in module](https://plaid.com/docs/link/)

## Install

```
npm install vue-plaid-link --save
```

## Example Usage

```vue
<template>
  <section>
    <plaid-link
      env="sandbox"
      publicKey="{PLAID_PUBLIC_KEY}"
      clientName="Test App"
      product="transactions"
      v-bind="{ onSuccess }"
    >
      Open Plaid Link
    </plaid-link>
  </section>
</template>

<script>
import PlaidLink from "vue-plaid-link";

export default {
  components: { PlaidLink },
  methods: {
    onSuccess(token) {
      console.log(token);
    },
  },
};
</script>
```

Alternatively if you would like to pass in your own view instead of the default button, utilize the `button` slot.

```vue
<template>
  <section>
    <plaid-link
      env="sandbox"
      publicKey="{PLAID_PUBLIC_KEY}"
      clientName="Test App"
      product="transactions"
      v-bind="{ onSuccess }"
    >
      <template slot="button" slot-scope="props">
        <a @click="props.onClick">Custom Open Element</a>
      </template>
    </plaid-link>
  </section>
</template>
```

## All Props

Please refer to the [official Plaid Link docs](https://plaid.com/docs/link/) for descriptions on the various Link options.

```vue
<plaid-link
    clientName="Your app name"
    env="sandbox"
    institution={null}
    publicKey={PLAID_PUBLIC_KEY}
    product={['transactions']}
    language={'en','fr','es'},
    countryCodes={['US','CA','GB']},
    isWebView={null},
    token={'public-token-123...'}
    webhook="https://webhooks.test.com"
    onLoad={this.handleOnLoad}
    onEvent={this.handleOnEvent}
    onExit={this.handleOnExit}
    onLoad={this.handleOnLoad}
    onSuccess={this.handleOnSuccess}
    token={this.token}>
    Title Of Button
</plain-link>
```

## Note: Use of Token Link

When using a link token instead of a public key, make sure to wait to render the button until you have the token.

```
<div class="accounts-actions" v-if="linkToken">
    <plaid-link
        v-bind="{
            env,
            webhook,
            clientName,
            onSuccess,
            token: linkToken
        }"
    >
        + Add Another Card
    </plaid-link>
</div>
<div class="accounts-actions" v-else>
    <ui-button loading="true" disabled="true">
        + Add Another Card
    </ui-button>
</div>
```

---
_Source: https://npm.io/package/vue-plaid-link · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._