Vue.js flatfile adapter
npm install @flatfile/vuejs
--
> NOTE: If you upgrading from previous versions (0.x), v3+ comes with some updates & breaking changes
#### BREAKING CHANGES:
Note that the latest version of @flatfile/vuejs 3+ uses the new @flatfile/sdk underneath which changes the API surface of interacting with the flatfile adapter entirely.
Read more about these changes here
There is now only 1 required input, and that is :token (which you must receive from your backend).
Read more about generating a Token here
---
We've made it really simple for you to get started with Flatfile with our new Flatfile Component. Here's what you'll need to know to get started.
First, install the dependency via npm:
``bash`
npm install @flatfile/vuejs@3
This will give you access to the component as well as the same basic functionality as our new SDK.
Simply add the import to a component where you want to include the Flatfile vuejs adapter via
`html
import { FlatfileButton } from '@flatfile/vuejs';
export default {
name: 'DemoComponent',
components: {
FlatfileButton,
},
// ...
}
`
Now in your application simply utilize this new component, but make sure to pass in the 1 required prop, (and/or any optional ones you may need for your application).
- :token (String) [ which you need to get from your backend ]
Read more here on how to implement a secure token.
`html
Upload to Flatfile!
`
---
Here's an example passing down many of the other optional parameters/methods available to the adapter.
`html
:onInit="onInit"
:onUpload="onUpload"
:onLaunch="onLaunch"
:onClose="onClose"
:onComplete="onComplete"
:onError="onError"
class="ff-button"
>
Upload to Flatfile!
`
---
#### Additional options
You can also pass down mountUrl and apiUrl to the .
`html
:mountUrl="mountUrl"
:apiUrl="apiUrl"
>
Upload to Flatfile!
`
Update changelog (if needed), update package.json version (semver), add any updates needed for README (if needed), then run the following scripts:
`bash``
npm run build:lib
npm publish